org.forgerock.openam.federation.saml2

Interface SAML2TokenRepository

public interface SAML2TokenRepository

Enables the storing/recovering serialized state of SAML2 Tokens when in SAML2 failover-mode. It is in the OpenAM Shared package so that the Federation Library does not need to have a dependency on OpenAM Core and visa-versa.

Method Summary

Modifier and Type	Method and Description
void	deleteSAML2Token(String primaryKey) Deletes the SAML2 object by using the passed primary key from the repository.
Object	retrieveSAML2Token(String primaryKey) Retrieves an existing SAML2 object from the CTS as an un-cast Object using the passed primary key.
List<Object>	retrieveSAML2TokensWithSecondaryKey(String secondaryKey) Retrieves a list of existing SAML2 objects from the CTS as un-cast Objects using the passed secondary key.
void	saveSAML2Token(String primaryKey, String secondaryKey, Object samlObj, long expirationTime) Saves SAML2 data into the SAML2 Repository.

Method Detail

retrieveSAML2Token

Object retrieveSAML2Token(String primaryKey)
                   throws SAML2TokenRepositoryException

Retrieves an existing SAML2 object from the CTS as an un-cast Object using the passed primary key.

Parameters:

primaryKey - primary key

Returns:

The object found in the repository or null if not found.

Throws:

SAML2TokenRepositoryException - if there was a problem accessing the SAML2 Token Repository

retrieveSAML2TokensWithSecondaryKey

List<Object> retrieveSAML2TokensWithSecondaryKey(String secondaryKey)
                                          throws SAML2TokenRepositoryException

Retrieves a list of existing SAML2 objects from the CTS as un-cast Objects using the passed secondary key.

Parameters:

secondaryKey - Secondary Key

Returns:

A non null, but possibly empty collection of SAML2 objects.

Throws:

SAML2TokenRepositoryException - if there was a problem accessing the SAML2 Token Repository

deleteSAML2Token

void deleteSAML2Token(String primaryKey)
               throws SAML2TokenRepositoryException

Deletes the SAML2 object by using the passed primary key from the repository.

Parameters:

primaryKey - primary key

Throws:

SAML2TokenRepositoryException - if there was a problem accessing the SAML2 Token Repository

saveSAML2Token

void saveSAML2Token(String primaryKey,
                    String secondaryKey,
                    Object samlObj,
                    long expirationTime)
             throws SAML2TokenRepositoryException

Saves SAML2 data into the SAML2 Repository.

Parameters:

primaryKey - Primary key.

secondaryKey - Secondary Key, can be null

samlObj - the SAML2 object to store such as Response, IDPSession.

expirationTime - Expiration time in seconds from epoch.

Throws:

SAML2TokenRepositoryException - if there was a problem accessing the SAML2 Token Repository