play.mvc

Class Http.Session

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,java.lang.String>

play.mvc.Http.Session

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.String>

Enclosing class:

Http

public static class Http.Session
extends java.util.HashMap<java.lang.String,java.lang.String>

HTTP Session.

Session data are encoded into an HTTP cookie, and can only contain simple String values.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isDirty Deprecated. Deprecated as of 2.7.0.

Constructor Summary

Constructors

Constructor and Description
Session(int initialCapacity) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
Session(int initialCapacity, float loadFactor) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
Session(java.util.Map<java.lang.String,java.lang.String> data)
Session(play.api.mvc.Session underlying)

Method Summary

Modifier and Type	Method and Description
Http.Session	adding(java.util.Map<java.lang.String,java.lang.String> values) Returns a new session with the values from the given map added.
Http.Session	adding(java.lang.String key, java.lang.String value) Returns a new session with the given key-value pair added.
java.util.Optional<java.lang.String>	apply(java.lang.String key) Optionally returns the session value associated with a key.
play.api.mvc.Session	asScala() Convert this session to a Scala session.
void	clear() Deprecated. Deprecated as of 2.7.0. Just create a new instance instead.
java.lang.Object	clone() Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
java.lang.String	compute(java.lang.String key, java.util.function.BiFunction<? super java.lang.String,? super java.lang.String,? extends java.lang.String> remappingFunction) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
java.lang.String	computeIfAbsent(java.lang.String key, java.util.function.Function<? super java.lang.String,? extends java.lang.String> mappingFunction) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
java.lang.String	computeIfPresent(java.lang.String key, java.util.function.BiFunction<? super java.lang.String,? super java.lang.String,? extends java.lang.String> remappingFunction) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
boolean	containsKey(java.lang.Object key) Deprecated. Deprecated as of 2.7.0. Use getOptional(String) instead.
boolean	containsValue(java.lang.Object value) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
java.util.Map<java.lang.String,java.lang.String>	data()
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	entrySet() Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
void	forEach(java.util.function.BiConsumer<? super java.lang.String,? super java.lang.String> action) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
java.lang.String	get(java.lang.Object key) Deprecated. Deprecated as of 2.7.0. Use getOptional(String) instead.
java.util.Optional<java.lang.String>	getOptional(java.lang.String key) Optionally returns the session value associated with a key.
java.lang.String	getOrDefault(java.lang.Object key, java.lang.String defaultValue) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
boolean	isEmpty() Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
java.util.Set<java.lang.String>	keySet() Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
java.lang.String	merge(java.lang.String key, java.lang.String value, java.util.function.BiFunction<? super java.lang.String,? super java.lang.String,? extends java.lang.String> remappingFunction) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
java.lang.String	put(java.lang.String key, java.lang.String value) Deprecated. Deprecated as of 2.7.0. Use adding(String, String) instead.
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> values) Deprecated. Deprecated as of 2.7.0. Use adding(Map) instead.
java.lang.String	putIfAbsent(java.lang.String key, java.lang.String value) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
java.lang.String	remove(java.lang.Object key) Deprecated. Deprecated as of 2.7.0. Use removing(String...) instead.
boolean	remove(java.lang.Object key, java.lang.Object value) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
Http.Session	removing(java.lang.String... keys) Returns a new session with the given keys removed.
java.lang.String	replace(java.lang.String key, java.lang.String value) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
boolean	replace(java.lang.String key, java.lang.String oldValue, java.lang.String newValue) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
void	replaceAll(java.util.function.BiFunction<? super java.lang.String,? super java.lang.String,? extends java.lang.String> function) Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
int	size() Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.
java.util.Collection<java.lang.String>	values() Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

isDirty

@Deprecated
public boolean isDirty

Deprecated. Deprecated as of 2.7.0.

Constructor Detail

Session

public Session(java.util.Map<java.lang.String,java.lang.String> data)

Session

public Session(play.api.mvc.Session underlying)

Session

@Deprecated
public Session(int initialCapacity,
                           float loadFactor)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Session

@Deprecated
public Session(int initialCapacity)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Method Detail

data

public java.util.Map<java.lang.String,java.lang.String> data()

containsKey

@Deprecated
public boolean containsKey(java.lang.Object key)

Deprecated. Deprecated as of 2.7.0. Use getOptional(String) instead.

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

containsKey in class java.util.HashMap<java.lang.String,java.lang.String>

get

@Deprecated
public java.lang.String get(java.lang.Object key)

Deprecated. Deprecated as of 2.7.0. Use getOptional(String) instead.

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

get in class java.util.HashMap<java.lang.String,java.lang.String>

apply

public java.util.Optional<java.lang.String> apply(java.lang.String key)

Optionally returns the session value associated with a key.

getOptional

public java.util.Optional<java.lang.String> getOptional(java.lang.String key)

Optionally returns the session value associated with a key.

remove

@Deprecated
public java.lang.String remove(java.lang.Object key)

Deprecated. Deprecated as of 2.7.0. Use removing(String...) instead.

Removes the specified value from the session.

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

remove in class java.util.HashMap<java.lang.String,java.lang.String>

removing

public Http.Session removing(java.lang.String... keys)

Returns a new session with the given keys removed.

put

@Deprecated
public java.lang.String put(java.lang.String key,
                                        java.lang.String value)

Deprecated. Deprecated as of 2.7.0. Use adding(String, String) instead.

Adds the given value to the session.

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

put in class java.util.HashMap<java.lang.String,java.lang.String>

putAll

@Deprecated
public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> values)

Deprecated. Deprecated as of 2.7.0. Use adding(Map) instead.

Adds the given values to the session.

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

putAll in class java.util.HashMap<java.lang.String,java.lang.String>

adding

public Http.Session adding(java.lang.String key,
                           java.lang.String value)

Returns a new session with the given key-value pair added.

adding

public Http.Session adding(java.util.Map<java.lang.String,java.lang.String> values)

Returns a new session with the values from the given map added.

clear

@Deprecated
public void clear()

Deprecated. Deprecated as of 2.7.0. Just create a new instance instead.

Clears the session.

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

clear in class java.util.HashMap<java.lang.String,java.lang.String>

asScala

public play.api.mvc.Session asScala()

Convert this session to a Scala session.

Returns:

the Scala session.

size

@Deprecated
public int size()

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

size in class java.util.HashMap<java.lang.String,java.lang.String>

isEmpty

@Deprecated
public boolean isEmpty()

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

isEmpty in class java.util.HashMap<java.lang.String,java.lang.String>

containsValue

@Deprecated
public boolean containsValue(java.lang.Object value)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

containsValue in class java.util.HashMap<java.lang.String,java.lang.String>

keySet

@Deprecated
public java.util.Set<java.lang.String> keySet()

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

keySet in class java.util.HashMap<java.lang.String,java.lang.String>

values

@Deprecated
public java.util.Collection<java.lang.String> values()

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

values in class java.util.HashMap<java.lang.String,java.lang.String>

entrySet

@Deprecated
public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> entrySet()

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

entrySet in class java.util.HashMap<java.lang.String,java.lang.String>

getOrDefault

@Deprecated
public java.lang.String getOrDefault(java.lang.Object key,
                                                 java.lang.String defaultValue)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

getOrDefault in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

getOrDefault in class java.util.HashMap<java.lang.String,java.lang.String>

putIfAbsent

@Deprecated
public java.lang.String putIfAbsent(java.lang.String key,
                                                java.lang.String value)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

putIfAbsent in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

putIfAbsent in class java.util.HashMap<java.lang.String,java.lang.String>

remove

@Deprecated
public boolean remove(java.lang.Object key,
                                  java.lang.Object value)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

remove in class java.util.HashMap<java.lang.String,java.lang.String>

replace

@Deprecated
public boolean replace(java.lang.String key,
                                   java.lang.String oldValue,
                                   java.lang.String newValue)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

replace in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

replace in class java.util.HashMap<java.lang.String,java.lang.String>

replace

@Deprecated
public java.lang.String replace(java.lang.String key,
                                            java.lang.String value)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

replace in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

replace in class java.util.HashMap<java.lang.String,java.lang.String>

computeIfAbsent

@Deprecated
public java.lang.String computeIfAbsent(java.lang.String key,
                                                    java.util.function.Function<? super java.lang.String,? extends java.lang.String> mappingFunction)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

computeIfAbsent in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

computeIfAbsent in class java.util.HashMap<java.lang.String,java.lang.String>

computeIfPresent

@Deprecated
public java.lang.String computeIfPresent(java.lang.String key,
                                                     java.util.function.BiFunction<? super java.lang.String,? super java.lang.String,? extends java.lang.String> remappingFunction)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

computeIfPresent in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

computeIfPresent in class java.util.HashMap<java.lang.String,java.lang.String>

compute

@Deprecated
public java.lang.String compute(java.lang.String key,
                                            java.util.function.BiFunction<? super java.lang.String,? super java.lang.String,? extends java.lang.String> remappingFunction)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

compute in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

compute in class java.util.HashMap<java.lang.String,java.lang.String>

merge

@Deprecated
public java.lang.String merge(java.lang.String key,
                                          java.lang.String value,
                                          java.util.function.BiFunction<? super java.lang.String,? super java.lang.String,? extends java.lang.String> remappingFunction)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

merge in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

merge in class java.util.HashMap<java.lang.String,java.lang.String>

forEach

@Deprecated
public void forEach(java.util.function.BiConsumer<? super java.lang.String,? super java.lang.String> action)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

forEach in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

forEach in class java.util.HashMap<java.lang.String,java.lang.String>

replaceAll

@Deprecated
public void replaceAll(java.util.function.BiFunction<? super java.lang.String,? super java.lang.String,? extends java.lang.String> function)

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Specified by:

replaceAll in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

replaceAll in class java.util.HashMap<java.lang.String,java.lang.String>

clone

@Deprecated
public java.lang.Object clone()

Deprecated. Deprecated as of 2.7.0. Http.Session will not be a subclass of HashMap in future Play releases.

Overrides:

clone in class java.util.HashMap<java.lang.String,java.lang.String>