org.opensaml.common.binding.artifact
Class BasicSAMLArtifactMapEntryFactory

java.lang.Object
  org.opensaml.common.binding.artifact.BasicSAMLArtifactMapEntryFactory

All Implemented Interfaces:

SAMLArtifactMap.SAMLArtifactMapEntryFactory

public class BasicSAMLArtifactMapEntryFactory
extends Object
implements SAMLArtifactMap.SAMLArtifactMapEntryFactory

A basic factory for instances of SAMLArtifactMap.SAMLArtifactMapEntryFactory.

If this implementation, if the SAMLObject being stored does not have a parent, then it will be stored as-is. If it does have a parent, it will first be cloned, with its cloned and cached DOM rooted in a new Document.

If the serializeMessage property is true, then the SAMLObject held by the entry will be internally serialized within the entry before it is returned. This option defaults to false.

Field Summary

private boolean

serializeMessage Flag determining whether the SAMLObject message should be explicitly serialized on creation of the new artifact map entry.

Constructor Summary

BasicSAMLArtifactMapEntryFactory()

Method Summary

private SAMLObject	getStorableSAMLMessage(SAMLObject samlMessage) Get the SAMLObject which will actually be stored in the produced SAMLArtifactMapEntry.
boolean	isSerializeMessage() Get the flag determining whether the SAMLObject message should be explicitly serialized on creation of the new artifact map entry.
SAMLArtifactMap.SAMLArtifactMapEntry	newEntry(String artifact, String issuerId, String relyingPartyId, SAMLObject samlMessage, long lifetime) Factory method which produces a SAMLArtifactMap.SAMLArtifactMapEntry.
void	setSerializeMessage(boolean newSerializeMessage) Set the flag determining whether the SAMLObject message should be explicitly serialized on creation of the new artifact map entry.

Methods inherited from class java.lang.Object

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

Field Detail

serializeMessage

private boolean serializeMessage

Flag determining whether the SAMLObject message should be explicitly serialized on creation of the new artifact map entry.

Constructor Detail

BasicSAMLArtifactMapEntryFactory

public BasicSAMLArtifactMapEntryFactory()

Method Detail

setSerializeMessage

public void setSerializeMessage(boolean newSerializeMessage)

Set the flag determining whether the SAMLObject message should be explicitly serialized on creation of the new artifact map entry. Defaults to false.

Parameters:

newSerializeMessage - the new flag value

isSerializeMessage

public boolean isSerializeMessage()

Get the flag determining whether the SAMLObject message should be explicitly serialized on creation of the new artifact map entry. Defaults to false.

Returns:

the current flag value

newEntry

public SAMLArtifactMap.SAMLArtifactMapEntry newEntry(String artifact,
                                                     String issuerId,
                                                     String relyingPartyId,
                                                     SAMLObject samlMessage,
                                                     long lifetime)

Factory method which produces a SAMLArtifactMap.SAMLArtifactMapEntry.

Specified by:

newEntry in interface SAMLArtifactMap.SAMLArtifactMapEntryFactory

Parameters:

artifact - the artifact

issuerId - ID of the issuer of the artifact

relyingPartyId - ID of the party the artifact was sent to

samlMessage - the SAML message

lifetime - the lifetime of the artifact entry, in milliseconds

Returns:

the new map entry instance

getStorableSAMLMessage

private SAMLObject getStorableSAMLMessage(SAMLObject samlMessage)

Get the SAMLObject which will actually be stored in the produced SAMLArtifactMapEntry.

This may or may not be the same SAMLObject that is passed in. If the SAMLObject does not have a parent, the same object will be returned. Otherwise, the object will be cloned and the cloned instance returned.

Parameters:

samlMessage - the SAML message to process

Returns:

an equivalent SAML Message