Package com.sun.identity.saml2.assertion.impl

Class ConditionsImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.ConditionsImpl

All Implemented Interfaces:

Conditions

public class ConditionsImpl
extends Object
implements Conditions

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUDIENCE_RESTRICTION_ELEMENT
static String	CONDITION_ELEMENT
static String	CONDITIONS_ELEMENT
static String	NOT_BEFORE_ATTR
static String	NOT_ON_OR_AFTER_ATTR
static String	ONETIMEUSE_ELEMENT
static String	PROXY_RESTRICTION_ELEMENT

Constructor Summary

Constructors

Constructor	Description
ConditionsImpl()	Default constructor
ConditionsImpl(String xml)	This constructor is used to build Conditions object from a XML string.
ConditionsImpl(Element element)	This constructor is used to build Conditions object from a block of existing XML that has already been built into a DOM.

Method Summary

Modifier and Type	Method	Description
boolean	checkDateValidity(long someTime)	Return true if a specific Date falls within the validity interval of this set of conditions.
boolean	checkDateValidity(long someTime, int skewSeconds)	Return true if a specific Date falls within the validity interval of this set of conditions.
List	getAudienceRestrictions()	Returns a list of AudienceRestriction
List	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	getOneTimeUses()	Returns a list of OneTimeUse
List	getProxyRestrictions()	Returns a list of ProxyRestriction
boolean	isMutable()	Returns true if the object is mutable
void	makeImmutable()	Makes the object immutable
void	setAudienceRestrictions(List ars)	Sets a list of AudienceRestriction
void	setConditions(List 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 oneTimeUses)	Sets a list of OneTimeUse
void	setProxyRestrictions(List prs)	Sets a list of ProxyRestriction
String	toXMLString()	Returns a String representation
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation

Methods inherited from class java.lang.Object

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

Field Detail

CONDITIONS_ELEMENT

public static final String CONDITIONS_ELEMENT

See Also:

Constant Field Values

CONDITION_ELEMENT

public static final String CONDITION_ELEMENT

See Also:

Constant Field Values

ONETIMEUSE_ELEMENT

public static final String ONETIMEUSE_ELEMENT

See Also:

Constant Field Values

AUDIENCE_RESTRICTION_ELEMENT

public static final String AUDIENCE_RESTRICTION_ELEMENT

See Also:

Constant Field Values

PROXY_RESTRICTION_ELEMENT

public static final String PROXY_RESTRICTION_ELEMENT

See Also:

Constant Field Values

NOT_BEFORE_ATTR

public static final String NOT_BEFORE_ATTR

See Also:

Constant Field Values

NOT_ON_OR_AFTER_ATTR

public static final String NOT_ON_OR_AFTER_ATTR

See Also:

Constant Field Values

Constructor Detail

ConditionsImpl

public ConditionsImpl()

Default constructor

ConditionsImpl

public ConditionsImpl(String xml)
               throws SAML2Exception

This constructor is used to build Conditions object from a XML string.

Parameters:

xml - A java.lang.String representing a Conditions object

Throws:

SAML2Exception - if it could not process the XML string

ConditionsImpl

public ConditionsImpl(Element element)
               throws SAML2Exception

This constructor is used to build Conditions object from a block of existing XML that has already been built into a DOM.

Parameters:

element - A org.w3c.dom.Element representing DOM tree for Conditions object

Throws:

SAML2Exception - if it could not process the Element

Method Detail

getNotOnOrAfter

public Date getNotOnOrAfter()

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

Specified by:

getNotOnOrAfter in interface Conditions

Returns:

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

setNotOnOrAfter

public void setNotOnOrAfter(Date value)
                     throws SAML2Exception

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

Specified by:

setNotOnOrAfter in interface Conditions

Parameters:

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

Throws:

SAML2Exception - if the object is immutable

getConditions

public List getConditions()

Returns a list of Condition

Specified by:

getConditions in interface Conditions

Returns:

a list of Condition

getAudienceRestrictions

public List getAudienceRestrictions()

Returns a list of AudienceRestriction

Specified by:

getAudienceRestrictions in interface Conditions

Returns:

a list of AudienceRestriction

getOneTimeUses

public List getOneTimeUses()

Returns a list of OneTimeUse

Specified by:

getOneTimeUses in interface Conditions

Returns:

a list of OneTimeUse

getProxyRestrictions

public List getProxyRestrictions()

Returns a list of ProxyRestriction

Specified by:

getProxyRestrictions in interface Conditions

Returns:

a list of ProxyRestriction

setConditions

public void setConditions(List conditions)
                   throws SAML2Exception

Sets a list of Condition

Specified by:

setConditions in interface Conditions

Parameters:

conditions - a list of Condition

Throws:

SAML2Exception - if the object is immutable

setAudienceRestrictions

public void setAudienceRestrictions(List ars)
                             throws SAML2Exception

Sets a list of AudienceRestriction

Specified by:

setAudienceRestrictions in interface Conditions

Parameters:

ars - a list of AudienceRestriction

Throws:

SAML2Exception - if the object is immutable

setOneTimeUses

public void setOneTimeUses(List oneTimeUses)
                    throws SAML2Exception

Sets a list of OneTimeUse

Specified by:

setOneTimeUses in interface Conditions

Parameters:

oneTimeUses - a list of OneTimeUse

Throws:

SAML2Exception - if the object is immutable

setProxyRestrictions

public void setProxyRestrictions(List prs)
                          throws SAML2Exception

Sets a list of ProxyRestriction

Specified by:

setProxyRestrictions in interface Conditions

Parameters:

prs - a list of ProxyRestriction

Throws:

SAML2Exception - if the object is immutable

getNotBefore

public Date getNotBefore()

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

Specified by:

getNotBefore in interface Conditions

Returns:

the time instant before which the subject cannot be confirmed.

setNotBefore

public void setNotBefore(Date value)
                  throws SAML2Exception

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

Specified by:

setNotBefore in interface Conditions

Parameters:

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

Throws:

SAML2Exception - if the object is immutable

checkDateValidity

public boolean checkDateValidity(long someTime,
                                 int skewSeconds)

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

Specified by:

checkDateValidity in interface Conditions

Parameters:

someTime - Any time in milliseconds.

skewSeconds - Clock skew in seconds.

Returns:

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

checkDateValidity

public boolean checkDateValidity(long someTime)

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

Specified by:

checkDateValidity in interface Conditions

Parameters:

someTime - Any time in milliseconds.

Returns:

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

toXMLString

public String toXMLString(boolean includeNSPrefix,
                          boolean declareNS)
                   throws SAML2Exception

Returns a String representation

Specified by:

toXMLString in interface Conditions

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

public String toXMLString()
                   throws SAML2Exception

Returns a String representation

Specified by:

toXMLString in interface Conditions

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion

makeImmutable

public void makeImmutable()

Makes the object immutable

Specified by:

makeImmutable in interface Conditions

isMutable

public boolean isMutable()

Returns true if the object is mutable

Specified by:

isMutable in interface Conditions

Returns:

true if the object is mutable