Package net.shibboleth.sp.saml.saml2

Class SessionDataSupport

java.lang.Object

net.shibboleth.sp.saml.saml2.SessionDataSupport

public final class SessionDataSupport
extends Object

Helper class encapsulating the creation and parsing of the opaque session data for SAML sessions, which consists of a NameID object.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Map<String,Object>	NO_XML_DECL_PARAMS	DOM configuration parameters used by LSSerializer to exclude XML declaration.

Constructor Summary

Constructors

Constructor	Description
SessionDataSupport()

Method Summary

Modifier and Type	Method	Description
static String	preserveSessionData(NameID nameID)	Encode a NameID for preservation as a String.
static NameID	recoverSessionData(ParserPool parserPool, String sessionData)	Recover a NameID from a String created by the preserveSessionData(NameID) method.

Methods inherited from class java.lang.Object

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

Field Details

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.

Constructor Details

SessionDataSupport

public SessionDataSupport()

Method Details

preserveSessionData

@Nullable
public static String preserveSessionData(@Nonnull
 NameID nameID)
                                  throws MarshallingException,
EncodingException

Encode a NameID for preservation as a String.

Parameters:

nameID - the object to peserve

Returns:

the encoded object or null

Throws:

MarshallingException - if unable to marshall the object into XML

EncodingException - if unable to encode the XML

recoverSessionData

@Nullable
public static NameID recoverSessionData(@Nonnull
 ParserPool parserPool,
 @Nonnull
 String sessionData)
                                 throws DecodingException,
IOException,
XMLParserException,
UnmarshallingException

Recover a NameID from a String created by the preserveSessionData(NameID) method.

Parameters:

parserPool - XML parser to use

sessionData - encoded data

Returns:

recovered object or null

Throws:

DecodingException - if unable to decode the string

IOException - if unable to process the resulting data

UnmarshallingException - if unable to unmarshall the XML

XMLParserException - if the parse fails or the data is of an incorrect type