com.sun.identity.saml.assertion
Class Conditions

java.lang.Object
  |
  +--com.sun.identity.saml.assertion.Conditions

public class Conditions

extends java.lang.Object

The validity of an Assertion MAY be subject to a set of Conditions. Each Condition evaluates to a value that is Valid, Invalid or Indeterminate.

Constructor Summary

Conditions()
Constructor taking in nothing (SAML spec allows it)

Conditions(java.util.Date notBefore, java.util.Date notOnOrAfter)
Constructor

Conditions(java.util.Date notBefore, java.util.Date notOnOrAfter, Condition condition, AudienceRestrictionCondition arc)
Constructor

Conditions(org.w3c.dom.Element conditionsElement)
This constructor builds a Conditions element from an existing XML block.

Method Summary

boolean	addAudienceRestrictionCondition(AudienceRestrictionCondition arc) Add an audience restriction condition within this Conditions Element
boolean	checkDateValidity(java.util.Date someDate) Check for whether or not a specific Date falls within the validity interval of this set of conditions
java.util.Set	getAudienceRestrictionCondition() Get Set of the AudienceRestrictionCondition elements held within this Conditions element
java.util.Date	getNotBefore() Get the earliest time at which the assertion is valid held in this Conditions object.
java.util.Date	getNotOnorAfter() Get the time instant held within this Conditions object at which the Assertion has expired.
boolean	removeAudienceRestrictionCondition(java.lang.String audience) Remove an audience restriction condition AudienceRestrictionCondition from this Conditions object wherein the specified audience has been defined.
java.lang.String	toString() Create a String representation of the element
java.lang.String	toString(boolean includeNS, boolean declareNS) Create a String representation of the <Conditions> element

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Conditions

public Conditions()

Constructor taking in nothing (SAML spec allows it)

Conditions

public Conditions(java.util.Date notBefore,
                  java.util.Date notOnOrAfter)
           throws SAMLException

Constructor

Parameters:

notBefore - : specifies the earliest time instant at which the assertion is valid.

notOnOrAfter: - specifies the time instant at which the assertion has expired.

Throws:

SAMLException - if the notBeofore instant is after notOnOrAfter instant.

Conditions

public Conditions(java.util.Date notBefore,
                  java.util.Date notOnOrAfter,
                  Condition condition,
                  AudienceRestrictionCondition arc)
           throws SAMLException

Constructor

Parameters:

notBefore: - specifies the earliest time instant at which the assertion is valid.

notOnOrAfter: - specifies the time instant at which the assertion has expired.

arc - : the to be added.Can be null, if no audience restriction

trc - : the to be added.Can be null if no target restriction

Throws:

SAMLException - if there is a problem in input data and it cannot be processed correctly.

Conditions

public Conditions(org.w3c.dom.Element conditionsElement)
           throws SAMLException

This constructor builds a Conditions element from an existing XML block.

Parameters:

conditionsElement: - A org.w3c.dom.Element>/code> representing DOM tree for Conditions object

Throws:

SAMLException - if it could not process the Element properly, implying that there is an error in the sender or in the element definition.

Method Detail

getNotBefore

public java.util.Date getNotBefore()

Get the earliest time at which the assertion is valid held in this Conditions object.

Returns:

A Date containing the NotBefore time held within this Conditions element

getNotOnorAfter

public java.util.Date getNotOnorAfter()

Get the time instant held within this Conditions object at which the Assertion has expired.

Returns:

time instant (at which assertion has expired) held within this Conditions element

addAudienceRestrictionCondition

public boolean addAudienceRestrictionCondition(AudienceRestrictionCondition arc)

Add an audience restriction condition within this Conditions Element

Parameters:

arc: - a AudienceRestrictionCondition to be added to this Conditions

Returns:

boolean representing success or failure of operation

checkDateValidity

public boolean checkDateValidity(java.util.Date someDate)

Check for whether or not a specific Date falls within the validity interval of this set of conditions

Parameters:

someDate - : Any Date

Returns:

A boolean representing if someDate is within the valid interval of the Conditions.

getAudienceRestrictionCondition

public java.util.Set getAudienceRestrictionCondition()

Get Set of the AudienceRestrictionCondition elements held within this Conditions element

Returns:

A Set of the audience restriction conditions. Each element contained within is an object of AudienceRestrictionCondition type.

removeAudienceRestrictionCondition

public boolean removeAudienceRestrictionCondition(java.lang.String audience)

Remove an audience restriction condition AudienceRestrictionCondition from this Conditions object wherein the specified audience has been defined.

Parameters:

audience: - A string representing audience.

Returns:

boolean indicating success or failure of the operation

toString

public java.lang.String toString()

Create a String representation of the element

Overrides:

toString in class java.lang.Object

Returns:

A string containing the valid XML for this element By default name space name is prepended to the element name eg <saml:Conditions>

toString

public java.lang.String toString(boolean includeNS,
                                 boolean declareNS)

Create a String representation of the <Conditions> element

Parameters:

IncludeNS - : 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 containing the valid XML for this element