org.sourceid.saml20.service
Interface ArtifactPersistenceService

All Known Implementing Classes:

ArtifactPersistenceServiceMapImpl, ArtifactPersistenceSvcMulticastEncodedNodeIdxImpl, ArtifactPersistenceSvcMulticastImpl, ArtifactPersistenceSvcProxy

public interface ArtifactPersistenceService

Defines the methods needed by PingFederate to store/create, and retrieve/remove artifact references.

Note that this interface is utilized only when you have PingFederate configured to send protocol messages via the artifact binding.

Author:

Brian Campbell

Nested Class Summary

static class	ArtifactPersistenceService.Handle A handle (or reference, or pointer) to a protocol message.
static class	ArtifactPersistenceService.Message A wrapper around the actual protocol message along with some additional data that is needed when processing the artifact resolution request.

Method Summary

ArtifactPersistenceService.Message	retrieveAndRemoveArtifact(byte[] messageHandle) Retrieves (and removes from the underlying storage mechanism) the protocol message associated to the given message handle.
ArtifactPersistenceService.Handle	saveArtifact(ArtifactPersistenceService.Message msg, int timeoutSeconds) Saves a protocol message associated to a byte array message handle for retrieval later (usually a very short time later) via artifact.

Method Detail

saveArtifact

ArtifactPersistenceService.Handle saveArtifact(ArtifactPersistenceService.Message msg,
                                               int timeoutSeconds)
                                               throws ArtifactPersistenceServiceException

Saves a protocol message associated to a byte array message handle for retrieval later (usually a very short time later) via artifact.

Parameters:

msg - the protocol xml message.

timeoutSeconds - the number of seconds after which the message/artifact are no longer valid.

Returns:

a Handle object that contains the message handle byte array as well as the endpoint index. This object will be used to create the full artifact string value.

Throws:

ArtifactPersistenceServiceException - for any unexpected runtime problem that the implementation cannot handle.

retrieveAndRemoveArtifact

ArtifactPersistenceService.Message retrieveAndRemoveArtifact(byte[] messageHandle)
                                                             throws ArtifactPersistenceServiceException

Retrieves (and removes from the underlying storage mechanism) the protocol message associated to the given message handle.

Parameters:

messageHandle - the 20 bytes that reference a specific protocol message.

Returns:

the Message object that is referred to by the messageHandle.

Throws:

ArtifactPersistenceServiceException - for any unexpected runtime problem that the implementation cannot handle.