Package net.shibboleth.idp.saml.session.impl

Class SAML2SPSessionSerializer

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.idp.session.AbstractSPSessionSerializer

net.shibboleth.idp.saml.session.impl.SAML2SPSessionSerializer

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, StorageSerializer<SPSession>

@ThreadSafeAfterInit
public class SAML2SPSessionSerializer
extends AbstractSPSessionSerializer

A serializer for SAML2SPSession objects.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ACS_LOC_FIELD	Field name of ACS location.
private static final String	LOGOUT_PROP_FIELD	Field name of Single Logout indicator.
private static final String	NAMEID_FIELD	Field name of NameID.
private static final Map<String,Object>	NO_XML_DECL_PARAMS	DOM configuration parameters used by LSSerializer to exclude XML declaration.
private ParserPool	parserPool	Parser for NameID fields.
private static final String	SESSION_INDEX_FIELD	Field name of SessionIndex.

Constructor Summary

Constructors

Constructor	Description
SAML2SPSessionSerializer(Duration offset)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected SPSession	doDeserialize(JsonObject obj, String id, Instant creation, Instant expiration)	Implement this method to return the appropriate type of object, populated with the basic information supplied.
protected void	doSerializeAdditional(SPSession instance, JsonGenerator generator)	Override this method to handle serialization of additional data.
void	setParserPool(ParserPool pool)	Set the ParserPool to use.

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

deserialize, serialize

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, doInitialize, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Field Details

NAMEID_FIELD

@Nonnull
@NotEmpty
private static final String NAMEID_FIELD

Field name of NameID.

See Also:

• Constant Field Values

SESSION_INDEX_FIELD

@Nonnull
@NotEmpty
private static final String SESSION_INDEX_FIELD

Field name of SessionIndex.

See Also:

• Constant Field Values

ACS_LOC_FIELD

@Nonnull
@NotEmpty
private static final String ACS_LOC_FIELD

Field name of ACS location.

See Also:

• Constant Field Values

LOGOUT_PROP_FIELD

@Nonnull
@NotEmpty
private static final String LOGOUT_PROP_FIELD

Field name of Single Logout indicator.

See Also:

• Constant Field Values

NO_XML_DECL_PARAMS

@Nonnull
private static final Map<String,Object> NO_XML_DECL_PARAMS

DOM configuration parameters used by LSSerializer to exclude XML declaration.

parserPool

@Nonnull
private ParserPool parserPool

Parser for NameID fields.

Constructor Details

SAML2SPSessionSerializer

public SAML2SPSessionSerializer(@Nonnull @ParameterName(name="offset")
 Duration offset)

Constructor.

Parameters:

offset - time to subtract from record expiration to establish session expiration value

Method Details

setParserPool

public void setParserPool(@Nonnull
 ParserPool pool)

Set the ParserPool to use.

Parameters:

pool - parser source

doSerializeAdditional

protected void doSerializeAdditional(@Nonnull
 SPSession instance,
 @Nonnull
 JsonGenerator generator)

Override this method to handle serialization of additional data.

The serialization "context" is the continuation of a JSON struct.

Overrides:

doSerializeAdditional in class AbstractSPSessionSerializer

Parameters:

instance - object to serialize

generator - JSON generator to write to

doDeserialize

@Nonnull
protected SPSession doDeserialize(@Nonnull
 JsonObject obj,
 @Nonnull @NotEmpty
 String id,
 @Nonnull
 Instant creation,
 @Nonnull
 Instant expiration)
                           throws IOException

Implement this method to return the appropriate type of object, populated with the basic information supplied.

The JSON object supplied is a structure that may contain additional data created by the concrete subclass during serialization.

Specified by:

doDeserialize in class AbstractSPSessionSerializer

Parameters:

obj - JSON structure to parse

id - the identifier of the service associated with this session

creation - creation time of session

expiration - expiration time of session

Returns:

the newly constructed object

Throws:

IOException - if an error occurs during deserialization