ratpack.session

Interface Session

public interface Session

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getExistingId() If there is an existing session, returns the ID in use.
java.lang.String	getId() Returns the session ID, initiating a session if necessary.
java.lang.String	regen() Initiates a new session, terminating the Can only be called once per request, and not if getId() has already initiated a new session.
void	terminate() Terminates the session with the client.

Method Detail

getExistingId

java.lang.String getExistingId()

If there is an existing session, returns the ID in use. This will not initiate a session if there is none.

Returns:

Any existing session id.

getId

java.lang.String getId()

Returns the session ID, initiating a session if necessary.

Returns:

The session id.

regen

java.lang.String regen()

Initiates a new session, terminating the Can only be called once per request, and not if getId() has already initiated a new session.

terminate

void terminate()

Terminates the session with the client. Cannot be called during the same request that initiates a session.