public interface SAMLArtifactMap
An implementation of this interface MUST ensure that the persisted SAML message is no longer tied to any parent
XMLObject
that may have contained it. This ensures that it can be safely added to
another object once retrieved from the map. This might for example be achieved by: 1) cloning the SAMLObject prior to
storage, or 2) by serializing it to a string and re-parsing and unmarshalling it once retrieved from the underlying
data store. This requirement may be handled by the SAMLArtifactMap directly, or by the use of of a specific
implementation of SAMLArtifactMap.SAMLArtifactMapEntryFactory
.
Modifier and Type | Interface and Description |
---|---|
static interface |
SAMLArtifactMap.SAMLArtifactMapEntry
Represents a mapping between an artifact and a SAML message with some associated information.
|
static interface |
SAMLArtifactMap.SAMLArtifactMapEntryFactory
A factory for producing SAMLArtifactMapEntry instances based on standard inputs, and reading/writing them from/to
storage.
|
Modifier and Type | Method and Description |
---|---|
boolean |
contains(String artifact)
Checks if a given artifact has a map entry.
|
SAMLArtifactMap.SAMLArtifactMapEntry |
get(String artifact)
Gets the artifact entry for the given artifact.
|
void |
put(String artifact,
String relyingPartyId,
String issuerId,
SAMLObject samlMessage)
Creates a mapping between a given artifact and the SAML message to which it maps.
|
void |
remove(String artifact)
Removes the artifact from this map.
|
boolean contains(@Nonnull @NotEmpty String artifact) throws IOException
artifact
- the artifact to checkIOException
- if an error occurs retrieving the informationvoid put(@Nonnull @NotEmpty String artifact, @Nonnull @NotEmpty String relyingPartyId, @Nonnull @NotEmpty String issuerId, @Nonnull SAMLObject samlMessage) throws IOException
artifact
- the artifactrelyingPartyId
- ID of the party the artifact was sent toissuerId
- ID of the issuer of the artifactsamlMessage
- the SAML messageIOException
- if an error occurs storing the information@Nullable SAMLArtifactMap.SAMLArtifactMapEntry get(@Nonnull @NotEmpty String artifact) throws IOException
artifact
- the artifact to retrieve the entry forIOException
- if an error occurs retrieving the informationvoid remove(@Nonnull @NotEmpty String artifact) throws IOException
artifact
- artifact to be removedIOException
- if an error occurs retrieving the informationCopyright © 1999–2020 Shibboleth Consortium. All rights reserved.