org.opensaml.common.binding.artifact
Interface SAMLArtifactMap


public interface SAMLArtifactMap

Maps an artifact to a SAML message and back again. Artifacts must be thread safe.


Nested Class Summary
static interface SAMLArtifactMap.SAMLArtifactMapEntry
          Represents a mapping between an artifact a SAML message with some associated metadata.
 
Method Summary
 boolean contains(byte[] artifact)
          Checks if a given artifact has a map entry.
 SAMLArtifactMap.SAMLArtifactMapEntry get(byte[] artifact)
          Gets the artifact entry for the given artifact.
 SAMLArtifactMap.SAMLArtifactMapEntry peek(byte[] artifact)
          Retrieves the entry for the given artifact without removing that entry from the map.
 void put(byte[] artifact, java.lang.String relyingPartyId, java.lang.String issuerId, SAMLObject samlMessage)
          Creates a mapping between a given artifact and the SAML message to which it maps.
 

Method Detail

contains

boolean contains(byte[] artifact)
Checks if a given artifact has a map entry.

Parameters:
artifact - the artifact to check
Returns:
true of this map has an entry for the given artifact, false it not

put

void put(byte[] artifact,
         java.lang.String relyingPartyId,
         java.lang.String issuerId,
         SAMLObject samlMessage)
Creates a mapping between a given artifact and the SAML message to which it maps.

Parameters:
artifact - the artifact
relyingPartyId - ID of the party the artifact was sent to
issuerId - ID of the issuer of the artifact
samlMessage - the SAML message

peek

SAMLArtifactMap.SAMLArtifactMapEntry peek(byte[] artifact)
Retrieves the entry for the given artifact without removing that entry from the map.

Parameters:
artifact - artifact to retrieve the map entry for
Returns:
the map entry for the artifact or null

get

SAMLArtifactMap.SAMLArtifactMapEntry get(byte[] artifact)
Gets the artifact entry for the given artifact. This operation will remove the artifact entry in order to ensure the one-time use semantics of artifacts.

Parameters:
artifact - the artifact to retrive the entry for
Returns:
the entry or null if the artifact has already expired or did not exist