org.opensaml.saml.common.binding.artifact

Class ExpiringSAMLArtifactMapEntry

java.lang.Object

org.opensaml.saml.common.binding.artifact.BasicSAMLArtifactMapEntry

org.opensaml.saml.common.binding.artifact.ExpiringSAMLArtifactMapEntry

All Implemented Interfaces:

SAMLArtifactMap.SAMLArtifactMapEntry

public class ExpiringSAMLArtifactMapEntry
extends BasicSAMLArtifactMapEntry

Extension of BasicSAMLArtifactMapEntry that tracks expiration.

Field Summary

Fields

Modifier and Type	Field and Description
private long	expiration Expiration in milliseconds since the start of the Unix epoch.

Constructor Summary

Constructors

Constructor and Description
ExpiringSAMLArtifactMapEntry(String samlArtifact, String issuerId, String relyingPartyId, SAMLObject samlMessage) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
long	getExpiration() Returns the expiration in milliseconds since the start of the Unix epoch.
boolean	isValid() Returns true iff the entry is valid as of now.
boolean	isValid(long effectiveTime) Returns true iff the entry is valid as of a specified time.
void	setExpiration(long exp) Sets the expiration in milliseconds since the start of the Unix epoch.

Methods inherited from class org.opensaml.saml.common.binding.artifact.BasicSAMLArtifactMapEntry

getArtifact, getIssuerId, getRelyingPartyId, getSamlMessage

Methods inherited from class java.lang.Object

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

Field Detail

expiration

private long expiration

Expiration in milliseconds since the start of the Unix epoch.

Constructor Detail

ExpiringSAMLArtifactMapEntry

public ExpiringSAMLArtifactMapEntry(@Nonnull@NotEmpty
                            String samlArtifact,
                            @Nonnull@NotEmpty
                            String issuerId,
                            @Nonnull@NotEmpty
                            String relyingPartyId,
                            @Nonnull
                            SAMLObject samlMessage)
                             throws org.opensaml.core.xml.io.MarshallingException,
                                    org.opensaml.core.xml.io.UnmarshallingException

Constructor.

Parameters:

samlArtifact - artifact associated with the message

issuerId - issuer of the artifact

relyingPartyId - intended recipient of the artifact

samlMessage - SAML message mapped to the artifact

Throws:

org.opensaml.core.xml.io.MarshallingException - if an error occurs isolating a message from its parent

org.opensaml.core.xml.io.UnmarshallingException - if an error occurs isolating a message from its parent

Method Detail

getExpiration

public long getExpiration()

Returns the expiration in milliseconds since the start of the Unix epoch.

Returns:

the expiration

setExpiration

public void setExpiration(long exp)

Sets the expiration in milliseconds since the start of the Unix epoch.

Parameters:

exp - the expiration

isValid

public boolean isValid()

Returns true iff the entry is valid as of now.

Returns:

true iff the entry is valid as of now

isValid

public boolean isValid(long effectiveTime)

Returns true iff the entry is valid as of a specified time.

Parameters:

effectiveTime - the time to evaluate validity against

Returns:

true iff the entry is valid as of a specified time