edu.internet2.middleware.shibboleth.common.session

インタフェース SessionManager<SessionType extends Session>

型パラメータ:

SessionType - type of session object managed

既知の実装クラスのリスト:

SessionManagerImpl

public interface SessionManager<SessionType extends Session>

Session managers are responsible for creating, managing, and destroying Shibboleth sessions. Session managers produce a LoginEvent during session creation and a LogoutEvent during session destruction. These events are published in the root application context, that is the highest ancestor, of the application context presented to a session manager.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
SessionType	createSession() Creates an empty Shibboleth session.
SessionType	createSession(String principal) 推奨されていません。 use createSession()
void	destroySession(String index) Destroys the session.
SessionType	getSession(String index) Gets the user's session based on a session index.
boolean	indexSession(SessionType session, String index) Indexes a session by the given string.
void	removeSessionIndex(String index) Removes the given index from its associated session.

メソッドの詳細

createSession

SessionType createSession()

Creates an empty Shibboleth session. The created session only contains an session ID. No other properties are populated.

戻り値:

a Shibboleth session

導入されたバージョン:

1.1

createSession

SessionType createSession(String principal)

推奨されていません。 use createSession()

Creates a Shibboleth session.

パラメータ:

principal - the principal name of the user

戻り値:

a Shibboleth session

destroySession

void destroySession(String index)

Destroys the session.

パラメータ:

index - the index of the session.

getSession

SessionType getSession(String index)

Gets the user's session based on a session index.

パラメータ:

index - the index of the session

戻り値:

the session

indexSession

boolean indexSession(SessionType session,
                   String index)

Indexes a session by the given string. This index is in addition to the session's ID.

パラメータ:

session - session to index

index - additional index

戻り値:

true if the given session is assigned the given index, false if not. This operation may fail if the given index is already assigned to another session or if the given session is not managed by this session manager.

導入されたバージョン:

1.1

removeSessionIndex

void removeSessionIndex(String index)

Removes the given index from its associated session.

パラメータ:

index - index to be removed.

導入されたバージョン:

1.1