org.opensaml.common.binding.artifact
Class BasicSAMLArtifactMapEntry

java.lang.Object
  org.opensaml.util.storage.AbstractExpiringObject
      org.opensaml.common.binding.artifact.BasicSAMLArtifactMapEntry

All Implemented Interfaces:

Serializable, SAMLArtifactMap.SAMLArtifactMapEntry, ExpiringObject

public class BasicSAMLArtifactMapEntry
extends AbstractExpiringObject
implements SAMLArtifactMap.SAMLArtifactMapEntry

Basic implementation of SAMLArtifactMap.SAMLArtifactMapEntry.

See Also:

Serialized Form

Field Summary

private String	artifact SAML artifact being mapped.
private String	issuer Entity ID of the issuer of the artifact.
private org.slf4j.Logger	log Class Logger.
private SAMLObject	message SAML message mapped to the artifact.
private String	relyingParty Entity ID of the receiver of the artifact.
private String	serializedMessage Serialized SAML object mapped to the artifact.
private static long	serialVersionUID Serial version UID.

Constructor Summary

BasicSAMLArtifactMapEntry(String samlArtifact, String issuerId, String relyingPartyId, SAMLObject samlMessage, long lifetime)
Constructor.

BasicSAMLArtifactMapEntry(String samlArtifact, String issuerId, String relyingPartyId, String serializedSAML, long lifetime)
Deprecated. replacement BasicSAMLArtifactMapEntry(String, String, String, SAMLObject, long)

Method Summary

(package private) void	deserializeMessage() Deserialize the serialized message data held by the entry so that it is available as the SAMLObject samleMessage property.
String	getArtifact() Gets the artifact that maps to the SAML message.
String	getIssuerId() Gets the ID of the issuer of the artifact.
String	getRelyingPartyId() Gets the ID of the relying party the artifact was sent to.
SAMLObject	getSamlMessage() Gets SAML message the artifact maps to.
(package private) String	getSeralizedMessage() Deprecated. replacement is: getSerializedMessage()
(package private) String	getSerializedMessage() Gets the serialized form of the SAML message.
private void	readObject(ObjectInputStream in) Deserialize the entry from the input stream.
(package private) void	serializeMessage() Serialize the SAMLObject held by the entry and store in the class.
(package private) void	setSAMLMessage(SAMLObject saml) Sets the SAML message mapped to the artifact.
private void	writeObject(ObjectOutputStream out) Serialize the entry to the object output stream.

Methods inherited from class org.opensaml.util.storage.AbstractExpiringObject

getExpirationTime, isExpired, onExpire

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.util.storage.ExpiringObject

getExpirationTime, isExpired, onExpire

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial version UID.

See Also:

Constant Field Values

log

private org.slf4j.Logger log

Class Logger.

artifact

private String artifact

SAML artifact being mapped.

issuer

private String issuer

Entity ID of the issuer of the artifact.

relyingParty

private String relyingParty

Entity ID of the receiver of the artifact.

message

private transient SAMLObject message

SAML message mapped to the artifact.

serializedMessage

private String serializedMessage

Serialized SAML object mapped to the artifact.

Constructor Detail

BasicSAMLArtifactMapEntry

public BasicSAMLArtifactMapEntry(String samlArtifact,
                                 String issuerId,
                                 String relyingPartyId,
                                 String serializedSAML,
                                 long lifetime)

Deprecated. replacement BasicSAMLArtifactMapEntry(String, String, String, SAMLObject, long)

Constructor.

Parameters:

samlArtifact - artifact associated with the message

issuerId - issuer of the artifact

relyingPartyId - receiver of the artifact

serializedSAML - serialized SAML message mapped to the artifact

lifetime - lifetime of the artifact in milliseconds

BasicSAMLArtifactMapEntry

public BasicSAMLArtifactMapEntry(String samlArtifact,
                                 String issuerId,
                                 String relyingPartyId,
                                 SAMLObject samlMessage,
                                 long lifetime)

Constructor.

Parameters:

samlArtifact - artifact associated with the message

issuerId - issuer of the artifact

relyingPartyId - receiver of the artifact

samlMessage - SAML message mapped to the artifact

lifetime - lifetime of the artifact in milliseconds

Method Detail

getArtifact

public String getArtifact()

Gets the artifact that maps to the SAML message.

Specified by:

getArtifact in interface SAMLArtifactMap.SAMLArtifactMapEntry

Returns:

artifact that maps to the SAML message

getIssuerId

public String getIssuerId()

Gets the ID of the issuer of the artifact.

Specified by:

getIssuerId in interface SAMLArtifactMap.SAMLArtifactMapEntry

Returns:

ID of the issuer of the artifact

getRelyingPartyId

public String getRelyingPartyId()

Gets the ID of the relying party the artifact was sent to.

Specified by:

getRelyingPartyId in interface SAMLArtifactMap.SAMLArtifactMapEntry

Returns:

ID of the relying party the artifact was sent to

getSamlMessage

public SAMLObject getSamlMessage()

Gets SAML message the artifact maps to.

Specified by:

getSamlMessage in interface SAMLArtifactMap.SAMLArtifactMapEntry

Returns:

SAML message the artifact maps to

setSAMLMessage

void setSAMLMessage(SAMLObject saml)

Sets the SAML message mapped to the artifact.

Parameters:

saml - SAML message mapped to the artifact

getSeralizedMessage

String getSeralizedMessage()

Deprecated. replacement is: getSerializedMessage()

Gets the serialized form of the SAML message.

Returns:

serialized form of the SAML message

getSerializedMessage

String getSerializedMessage()

Gets the serialized form of the SAML message.

Returns:

serialized form of the SAML message

serializeMessage

void serializeMessage()

Serialize the SAMLObject held by the entry and store in the class.

This option is provided where explicit pre-serialization of the data is either necessary or desirable.

deserializeMessage

void deserializeMessage()
                  throws IOException

Deserialize the serialized message data held by the entry so that it is available as the SAMLObject samleMessage property.

This option is provided where explicit deserialization of the data is either necessary or desirable.

Throws:

IOException - if there is a problem parsing or unmarshalling the serialized message

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Serialize the entry to the object output stream.

Parameters:

out - the output stream to which to serialize

Throws:

IOException - if there is a problem serializing the entry

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

Deserialize the entry from the input stream.

Parameters:

in - the input stream from which to deserialize

Throws:

IOException - if the is a problem deserializing the object

ClassNotFoundException - if there is a problem loading the class of the object