net.shibboleth.idp.session.impl

Class StorageBackedIdPSession

java.lang.Object

net.shibboleth.idp.session.AbstractIdPSession

net.shibboleth.idp.session.impl.StorageBackedIdPSession

All Implemented Interfaces:

IdPSession, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.IdentifiedComponent

public class StorageBackedIdPSession
extends AbstractIdPSession

Implementation of IdPSession for use with StorageBackedSessionManager.

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.idp.session.AbstractIdPSession

AbstractIdPSession.AddressFamily

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Class logger.
private StorageBackedSessionManager	sessionManager Back-reference to parent instance.
private int	version Storage version used to synchronize changes.

Fields inherited from interface net.shibboleth.idp.session.IdPSession

MDC_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
StorageBackedIdPSession(StorageBackedSessionManager manager, String sessionId, String canonicalName, long creationTime) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
AuthenticationResult	addAuthenticationResult(AuthenticationResult result)
SPSession	addSPSession(SPSession spSession)
void	bindToAddress(String address)
boolean	checkAddress(String address)
boolean	checkTimeout()
AuthenticationResult	getAuthenticationResult(String flowId)
Map<String,com.google.common.base.Optional<AuthenticationResult>>	getAuthenticationResultMap()
Set<AuthenticationResult>	getAuthenticationResults()
SPSession	getSPSession(String serviceId)
Map<String,com.google.common.base.Optional<SPSession>>	getSPSessionMap()
Set<SPSession>	getSPSessions()
private String	getSPSessionStorageKey(String serviceId) Convert a service identifier into a suitable key for the underlying storage service.
protected int	getVersion() Get the record version.
private AuthenticationResult	loadAuthenticationResultFromStorage(String flowId) Loads an AuthenticationResult record from storage and deserializes it using the object attached to the corresponding AuthenticationFlowDescriptor.
private SPSession	loadSPSessionFromStorage(String serviceId) Loads a SPSession record from storage and deserializes it using the object registered in the attached SPSessionSerializerRegistry.
boolean	removeAuthenticationResult(AuthenticationResult result)
boolean	removeSPSession(SPSession spSession)
private boolean	saveAuthenticationResultToStorage(AuthenticationResult result) Saves an AuthenticationResult record to storage, serializing it using the object attached to the corresponding AuthenticationFlowDescriptor.
private boolean	saveSPSessionToStorage(SPSession session) Saves a SPSession record to storage.
void	setLastActivityInstant(long instant)
protected void	setVersion(int ver) Set the record version.
void	updateAuthenticationResultActivity(AuthenticationResult result)
private boolean	writeToStorage() Update the master session record based on the current contents of this object.

Methods inherited from class net.shibboleth.idp.session.AbstractIdPSession

doAddAuthenticationResult, doAddSPSession, doBindToAddress, doRemoveAuthenticationResult, doRemoveSPSession, doSetLastActivityInstant, equals, getAddress, getAddressFamily, getCreationInstant, getId, getLastActivityInstant, getPrincipalName, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

@Nonnull
private final Logger log

Class logger.

sessionManager

@Nonnull
private final StorageBackedSessionManager sessionManager

Back-reference to parent instance.

version

private int version

Storage version used to synchronize changes.

Constructor Detail

StorageBackedIdPSession

public StorageBackedIdPSession(@Nonnull
                       StorageBackedSessionManager manager,
                       @Nonnull@NotEmpty
                       String sessionId,
                       @Nonnull@NotEmpty
                       String canonicalName,
                       long creationTime)

Constructor.

Parameters:

manager - parent SessionManager instance

sessionId - unique ID of session

canonicalName - canonical name of session subject

creationTime - creation time of session in milliseconds

Method Detail

setLastActivityInstant

public void setLastActivityInstant(@Duration@Positive
                          long instant)
                            throws SessionException

Overrides:

setLastActivityInstant in class AbstractIdPSession

Throws:

SessionException

checkAddress

public boolean checkAddress(@Nonnull@NotEmpty
                   String address)
                     throws SessionException

Specified by:

checkAddress in interface IdPSession

Overrides:

checkAddress in class AbstractIdPSession

Throws:

SessionException

bindToAddress

public void bindToAddress(@Nonnull@NotEmpty
                 String address)
                   throws SessionException

Overrides:

bindToAddress in class AbstractIdPSession

Throws:

SessionException

getAuthenticationResults

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public Set<AuthenticationResult> getAuthenticationResults()

Specified by:

getAuthenticationResults in interface IdPSession

Overrides:

getAuthenticationResults in class AbstractIdPSession

getAuthenticationResult

@Nullable
public AuthenticationResult getAuthenticationResult(@Nonnull@NotEmpty
                                                    String flowId)

Specified by:

getAuthenticationResult in interface IdPSession

Overrides:

getAuthenticationResult in class AbstractIdPSession

addAuthenticationResult

@Nullable
public AuthenticationResult addAuthenticationResult(@Nonnull
                                                    AuthenticationResult result)
                                             throws SessionException

Specified by:

addAuthenticationResult in interface IdPSession

Overrides:

addAuthenticationResult in class AbstractIdPSession

Throws:

SessionException

updateAuthenticationResultActivity

public void updateAuthenticationResultActivity(@Nonnull
                                      AuthenticationResult result)
                                        throws SessionException

Throws:

SessionException

removeAuthenticationResult

public boolean removeAuthenticationResult(@Nonnull
                                 AuthenticationResult result)
                                   throws SessionException

Specified by:

removeAuthenticationResult in interface IdPSession

Overrides:

removeAuthenticationResult in class AbstractIdPSession

Throws:

SessionException

getSPSessions

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public Set<SPSession> getSPSessions()

Specified by:

getSPSessions in interface IdPSession

Overrides:

getSPSessions in class AbstractIdPSession

getSPSession

@Nullable
public SPSession getSPSession(@Nonnull@NotEmpty
                              String serviceId)

Specified by:

getSPSession in interface IdPSession

Overrides:

getSPSession in class AbstractIdPSession

addSPSession

@Nullable
public SPSession addSPSession(@Nonnull
                              SPSession spSession)
                       throws SessionException

Specified by:

addSPSession in interface IdPSession

Overrides:

addSPSession in class AbstractIdPSession

Throws:

SessionException

removeSPSession

public boolean removeSPSession(@Nonnull
                      SPSession spSession)
                        throws SessionException

Specified by:

removeSPSession in interface IdPSession

Overrides:

removeSPSession in class AbstractIdPSession

Throws:

SessionException

checkTimeout

public boolean checkTimeout()
                     throws SessionException

Specified by:

checkTimeout in interface IdPSession

Overrides:

checkTimeout in class AbstractIdPSession

Throws:

SessionException

getVersion

protected int getVersion()

Get the record version.

Returns:

current version of the storage record

setVersion

protected void setVersion(int ver)

Set the record version.

Parameters:

ver - version to set

getAuthenticationResultMap

@Nonnull
@NonnullElements
@Live
public Map<String,com.google.common.base.Optional<AuthenticationResult>> getAuthenticationResultMap()

Overrides:

getAuthenticationResultMap in class AbstractIdPSession

getSPSessionMap

@Nonnull
@NonnullElements
@Live
public Map<String,com.google.common.base.Optional<SPSession>> getSPSessionMap()

Overrides:

getSPSessionMap in class AbstractIdPSession

loadAuthenticationResultFromStorage

@Nullable
private AuthenticationResult loadAuthenticationResultFromStorage(@Nonnull@NotEmpty
                                                                String flowId)
                                                          throws IOException

Loads an AuthenticationResult record from storage and deserializes it using the object attached to the corresponding AuthenticationFlowDescriptor.

Parameters:

flowId - ID of result/flow to load

Returns:

the stored result, or null if the record is missing or unusable

Throws:

IOException - if a possibly transitory storage-related error occurs

saveAuthenticationResultToStorage

private boolean saveAuthenticationResultToStorage(@Nonnull
                                        AuthenticationResult result)
                                           throws IOException

Saves an AuthenticationResult record to storage, serializing it using the object attached to the corresponding AuthenticationFlowDescriptor.

Parameters:

result - the object to store

Returns:

true iff the record was successfully saved

Throws:

IOException - if a possibly transitory storage-related error occurs

loadSPSessionFromStorage

@Nullable
private SPSession loadSPSessionFromStorage(@Nonnull@NotEmpty
                                          String serviceId)
                                    throws IOException

Loads a SPSession record from storage and deserializes it using the object registered in the attached SPSessionSerializerRegistry.

Parameters:

serviceId - ID of service for session to load

Returns:

the stored session, or null if the record is missing or unusable

Throws:

IOException - if a possibly transitory storage-related error occurs

saveSPSessionToStorage

private boolean saveSPSessionToStorage(@Nonnull
                             SPSession session)
                                throws IOException

Saves a SPSession record to storage.

Parameters:

session - the object to store

Returns:

true iff the record was successfully saved

Throws:

IOException - if a possibly transitory storage-related error occurs

getSPSessionStorageKey

@Nonnull
@NotEmpty
private String getSPSessionStorageKey(@Nonnull@NotEmpty
                                             String serviceId)

Convert a service identifier into a suitable key for the underlying storage service.

Parameters:

serviceId - the service identifier

Returns:

an appropriately sized storage key

writeToStorage

private boolean writeToStorage()
                        throws IOException

Update the master session record based on the current contents of this object.

Returns:

true iff the update succeeds, false iff a version mismatch resulted in overwrite of this object

Throws:

IOException - if an error occurs trying to perform an update