public abstract class SessionPropertyUpgrader extends Object
SessionPropertyUpgrader.shouldCopy(java.lang.String)
in order to control which properties
are needed to copy into the new session.
In case you want to modify the copyable session property you are encouraged
to override SessionPropertyUpgrader.updateProperty(com.iplanet.dpro.session.service.InternalSession,
java.lang.String, java.lang.String)
method.Constructor and Description |
---|
SessionPropertyUpgrader() |
Modifier and Type | Method and Description |
---|---|
void |
populateProperties(InternalSession oldSession,
InternalSession newSession,
boolean forceAuth)
Entry point for LoginState.
|
void |
populatePropertiesFromStateless(org.forgerock.openam.sso.providers.stateless.StatelessSession oldSession,
InternalSession newSession)
Entry point for LoginState.
|
abstract boolean |
shouldCopy(String key)
This method decides whether a given session property should be copied to
the new session.
|
void |
updateProperty(InternalSession session,
String property,
String value)
This method updates a session property in the session with the given value.
|
public SessionPropertyUpgrader()
public final void populateProperties(InternalSession oldSession, InternalSession newSession, boolean forceAuth)
oldSession
- The previous sessionnewSession
- The new sessionforceAuth
- Whether the authentication was forcedpublic final void populatePropertiesFromStateless(org.forgerock.openam.sso.providers.stateless.StatelessSession oldSession, InternalSession newSession)
oldSession
- The previous (stateless) sessionnewSession
- The new sessionpublic void updateProperty(InternalSession session, String property, String value)
session
- Session object where the property should be setproperty
- Name of the property to setvalue
- Value of the given session propertypublic abstract boolean shouldCopy(String key)
key
- The name of the session property which we want to decide to copytrue
if the property with the given key should be
copied into the new sessionCopyright © 2010-2016, ForgeRock All Rights Reserved.