net.shibboleth.idp.session.impl

Class StorageBackedIdPSessionSerializer

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.idp.session.impl.StorageBackedIdPSessionSerializer

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.opensaml.storage.StorageSerializer<StorageBackedIdPSession>

@ThreadSafe
public class StorageBackedIdPSessionSerializer
extends net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
implements org.opensaml.storage.StorageSerializer<StorageBackedIdPSession>

A serializer for instances of StorageBackedIdPSession designed in conjunction with the StorageService-backed SessionManager implementation.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	CREATION_INSTANT_FIELD Field name of creation instant.
private static String	FLOW_ID_ARRAY_FIELD Field name of flow ID array.
private static String	IPV4_ADDRESS_FIELD Field name of IPv4 address.
private static String	IPV6_ADDRESS_FIELD Field name of IPv6 address.
private Logger	log Class logger.
private static String	PRINCIPAL_NAME_FIELD Field name of principal name.
private static String	SERVICE_ID_ARRAY_FIELD Field name of service ID array.
private StorageBackedSessionManager	sessionManager Back-reference to parent instance.
private StorageBackedIdPSession	targetObject Object instance to overwrite with deserialization method.

Constructor Summary

Constructors

Constructor and Description
StorageBackedIdPSessionSerializer(StorageBackedSessionManager manager, StorageBackedIdPSession target) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
StorageBackedIdPSession	deserialize(int version, String context, String key, String value, Long expiration)
String	serialize(StorageBackedIdPSession instance)

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, doInitialize, 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.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

CREATION_INSTANT_FIELD

@Nonnull
@NotEmpty
private static final String CREATION_INSTANT_FIELD

Field name of creation instant.

See Also:

Constant Field Values

PRINCIPAL_NAME_FIELD

@Nonnull
@NotEmpty
private static final String PRINCIPAL_NAME_FIELD

Field name of principal name.

See Also:

Constant Field Values

IPV4_ADDRESS_FIELD

@Nonnull
@NotEmpty
private static final String IPV4_ADDRESS_FIELD

Field name of IPv4 address.

See Also:

Constant Field Values

IPV6_ADDRESS_FIELD

@Nonnull
@NotEmpty
private static final String IPV6_ADDRESS_FIELD

Field name of IPv6 address.

See Also:

Constant Field Values

FLOW_ID_ARRAY_FIELD

@Nonnull
@NotEmpty
private static final String FLOW_ID_ARRAY_FIELD

Field name of flow ID array.

See Also:

Constant Field Values

SERVICE_ID_ARRAY_FIELD

@Nonnull
@NotEmpty
private static final String SERVICE_ID_ARRAY_FIELD

Field name of service ID array.

See Also:

Constant Field Values

log

@Nonnull
private final Logger log

Class logger.

sessionManager

@Nonnull
private final StorageBackedSessionManager sessionManager

Back-reference to parent instance.

targetObject

@Nullable
private final StorageBackedIdPSession targetObject

Object instance to overwrite with deserialization method.

Constructor Detail

StorageBackedIdPSessionSerializer

public StorageBackedIdPSessionSerializer(@Nonnull
                                 StorageBackedSessionManager manager,
                                 @Nullable
                                 StorageBackedIdPSession target)

Constructor.

Parameters:

manager - parent SessionManager instance

target - object to overwrite when deseralizing instead of creating a new instance

Method Detail

serialize

@Nonnull
@NotEmpty
public String serialize(@Nonnull
                                StorageBackedIdPSession instance)
                 throws IOException

Specified by:

serialize in interface org.opensaml.storage.StorageSerializer<StorageBackedIdPSession>

Throws:

IOException

deserialize

@Nonnull
public StorageBackedIdPSession deserialize(int version,
                                          @Nonnull@NotEmpty
                                          String context,
                                          @Nonnull@NotEmpty
                                          String key,
                                          @Nonnull@NotEmpty
                                          String value,
                                          @Nullable
                                          Long expiration)
                                    throws IOException

Specified by:

deserialize in interface org.opensaml.storage.StorageSerializer<StorageBackedIdPSession>

Throws:

IOException