play.mvc

Class Http.Session

java.lang.Object

play.mvc.Http.Session

Enclosing class:

Http

public static class Http.Session
extends java.lang.Object

HTTP Session.

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

Constructor Summary

Constructors

Constructor and Description
Session()
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) Deprecated. Deprecated as of 2.8.0. Use get(String) instead.
play.api.mvc.Session	asScala() Convert this session to a Scala session.
java.util.Map<java.lang.String,java.lang.String>	data()
java.util.Optional<java.lang.String>	get(java.lang.String key) Optionally returns the session value associated with a key.
java.util.Optional<java.lang.String>	getOptional(java.lang.String key) Deprecated. Deprecated as of 2.8.0. Renamed to get(String).
Http.Session	removing(java.lang.String... keys) Returns a new session with the given keys removed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Session

public Session()

Session

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

Session

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

Method Detail

data

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

get

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

Optionally returns the session value associated with a key.

getOptional

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

Deprecated. Deprecated as of 2.8.0. Renamed to get(String).

Optionally returns the session value associated with a key.

apply

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

Deprecated. Deprecated as of 2.8.0. Use get(String) instead.

Optionally returns the session value associated with a key.

removing

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

Returns a new session with the given keys removed.

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.

asScala

public play.api.mvc.Session asScala()

Convert this session to a Scala session.

Returns:

the Scala session.