com.sun.identity.saml2.assertion

Interface Conditions

public interface Conditions

The Conditions defines the SAML constructs that place constraints on the acceptable use if SAML Assertions.

Method Summary

Modifier and Type	Method and Description
boolean	checkDateValidity(long someTime) Return true if a specific Date falls within the validity interval of this set of conditions.
boolean	checkDateValidityWithSkew(long someTime, int skewTime) Return true if a specific Date falls within the validity interval of this set of conditions.
List<AudienceRestriction>	getAudienceRestrictions() Returns a list of AudienceRestriction
List<Condition>	getConditions() Returns a list of Condition
Date	getNotBefore() Returns the time instant before which the subject cannot be confirmed.
Date	getNotOnOrAfter() Returns the time instant at which the subject can no longer be confirmed.
List<OneTimeUse>	getOneTimeUses() Returns a list of OneTimeUse
List<ProxyRestriction>	getProxyRestrictions() Returns a list of ProxyRestriction
boolean	isMutable() Returns true if the object is mutable
void	makeImmutable() Makes the object immutable
void	setAudienceRestrictions(List<AudienceRestriction> ars) Sets a list of AudienceRestriction
void	setConditions(List<Condition> conditions) Sets a list of Condition
void	setNotBefore(Date value) Sets the time instant before which the subject cannot be confirmed.
void	setNotOnOrAfter(Date value) Sets the time instant at which the subject can no longer be confirmed.
void	setOneTimeUses(List<OneTimeUse> oneTimeUses) Sets a list of OneTimeUse
void	setProxyRestrictions(List<ProxyRestriction> prs) Sets a list of ProxyRestriction
String	toXMLString() Returns a String representation
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a String representation

Method Detail

getNotOnOrAfter

Date getNotOnOrAfter()

Returns the time instant at which the subject can no longer be confirmed.

Returns:

the time instant at which the subject can no longer be confirmed.

setNotOnOrAfter

void setNotOnOrAfter(Date value)
              throws SAML2Exception

Sets the time instant at which the subject can no longer be confirmed.

Parameters:

value - the time instant at which the subject can no longer be confirmed.

Throws:

SAML2Exception - if the object is immutable

getConditions

List<Condition> getConditions()

Returns a list of Condition

Returns:

a list of Condition

getAudienceRestrictions

List<AudienceRestriction> getAudienceRestrictions()

Returns a list of AudienceRestriction

Returns:

a list of AudienceRestriction

getOneTimeUses

List<OneTimeUse> getOneTimeUses()

Returns a list of OneTimeUse

Returns:

a list of OneTimeUse

getProxyRestrictions

List<ProxyRestriction> getProxyRestrictions()

Returns a list of ProxyRestriction

Returns:

a list of ProxyRestriction

setConditions

void setConditions(List<Condition> conditions)
            throws SAML2Exception

Sets a list of Condition

Parameters:

conditions - a list of Condition

Throws:

SAML2Exception - if the object is immutable

setAudienceRestrictions

void setAudienceRestrictions(List<AudienceRestriction> ars)
                      throws SAML2Exception

Sets a list of AudienceRestriction

Parameters:

ars - a list of AudienceRestriction

Throws:

SAML2Exception - if the object is immutable

setOneTimeUses

void setOneTimeUses(List<OneTimeUse> oneTimeUses)
             throws SAML2Exception

Sets a list of OneTimeUse

Parameters:

oneTimeUses - a list of OneTimeUse

Throws:

SAML2Exception - if the object is immutable

setProxyRestrictions

void setProxyRestrictions(List<ProxyRestriction> prs)
                   throws SAML2Exception

Sets a list of ProxyRestriction

Parameters:

prs - a list of ProxyRestriction

Throws:

SAML2Exception - if the object is immutable

getNotBefore

Date getNotBefore()

Returns the time instant before which the subject cannot be confirmed.

Returns:

the time instant before which the subject cannot be confirmed.

setNotBefore

void setNotBefore(Date value)
           throws SAML2Exception

Sets the time instant before which the subject cannot be confirmed.

Parameters:

value - the time instant before which the subject cannot be confirmed.

Throws:

SAML2Exception - if the object is immutable

checkDateValidity

boolean checkDateValidity(long someTime)

Return true if a specific Date falls within the validity interval of this set of conditions.

Parameters:

someTime - a time in milliseconds.

Returns:

true if someTime is within the valid interval of the Conditions.

checkDateValidityWithSkew

boolean checkDateValidityWithSkew(long someTime,
                                  int skewTime)

Return true if a specific Date falls within the validity interval of this set of conditions.

Parameters:

someTime - a time in milliseconds.

skewTime - a skew time in seconds.

Returns:

true if someTime is within the valid interval of the Conditions.

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
            throws SAML2Exception

Returns a String representation

Parameters:

includeNSPrefix - Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the namespace is declared within the Element.

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion

toXMLString

String toXMLString()
            throws SAML2Exception

Returns a String representation

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion

makeImmutable

void makeImmutable()

Makes the object immutable

isMutable

boolean isMutable()

Returns true if the object is mutable

Returns:

true if the object is mutable