Package com.jagrosh.jdautilities.oauth2.session

Class DefaultSessionController

java.lang.Object

com.jagrosh.jdautilities.oauth2.session.DefaultSessionController

All Implemented Interfaces:

SessionController<DefaultSessionController.DefaultSession>

public class DefaultSessionController
extends Object
implements SessionController<DefaultSessionController.DefaultSession>

The default SessionController implementation.

Author:

John Grosh ([email protected])

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DefaultSessionController.DefaultSession

Constructor Summary

Constructors

Constructor	Description
DefaultSessionController()

Method Summary

Modifier and Type	Method	Description
DefaultSessionController.DefaultSession	createSession(SessionData data)	Creates a new Session using the specified SessionData.
DefaultSessionController.DefaultSession	getSession(String identifier)	Gets a Session that was previously created using the provided identifier.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultSessionController

public DefaultSessionController()

Method Details

getSession

public DefaultSessionController.DefaultSession getSession(String identifier)

Description copied from interface: SessionController

Gets a Session that was previously created using the provided identifier.

It is very important for implementations of SessionController to hold a contract that Sessions created using SessionController.createSession(SessionData) will be maintained and retrievable by external sources at any time.

Note that Sessions that have elapsed their effective expiration are not necessary to maintain, unless they have been refreshed in which case they should be updated to reflect this.

Specified by:

getSession in interface SessionController<DefaultSessionController.DefaultSession>

Parameters:

identifier - The identifier to get a Session by.

Returns:

The Session mapped to the identifier provided.

createSession

public DefaultSessionController.DefaultSession createSession(SessionData data)

Description copied from interface: SessionController

Creates a new Session using the specified SessionData.

Sessions should be kept mapped outside of just creation so that they can be retrieved using SessionController.getSession(String) later for further manipulation, as well as to keep updated if they are refreshed.

Specified by:

createSession in interface SessionController<DefaultSessionController.DefaultSession>

Parameters:

data - The data to create a Session using.

Returns:

A new Session.