com.sun.identity.saml.assertion
Class AudienceRestrictionCondition

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

public class AudienceRestrictionCondition

extends Condition

This is an implementation of the abstract Condition class, which specifes that the assertion this AuthenticationCondition is part of, is addressed to one or more specific audience.

Fields inherited from class com.sun.identity.saml.assertion.Condition

INDETERMINATE, INVALID, VALID

Constructor Summary

AudienceRestrictionCondition(org.w3c.dom.Element audienceRestrictionConditionElement)
Constructs an AudienceRestrictionCondition element from an existing XML block.

AudienceRestrictionCondition(java.util.List audience)
This constructor takes in a List of audience for this condition, each of them being a String.

Method Summary

boolean	addAudience(java.lang.String audience) Add an audience to this Condition element
boolean	containsAudience(java.lang.String audience) Returns true if a particular audience string is contained within this AudienceRestrictionCondition object
int	evaluate() A method which can be overridden by a plug-in maybe which provides means of evaluating this condition
java.util.List	getAudience() LIst of Audience held within this Condition element
boolean	removeAudience(java.lang.String audience) Remove an audience from the List within this Condition element
boolean	setAudience(java.util.List audience) Add a List of audience held within this Condition element
java.lang.String	toString() Returns a String representation of the element.
java.lang.String	toString(boolean includeNS, boolean declareNS) Returns a String representation of the <AudienceRestrictionCondition> element.

Methods inherited from class java.lang.Object

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

Constructor Detail

AudienceRestrictionCondition

public AudienceRestrictionCondition(org.w3c.dom.Element audienceRestrictionConditionElement)
                             throws SAMLException

Constructs an AudienceRestrictionCondition element from an existing XML block.

Parameters:

audienceRestrictionConditionElement - A org.w3c.dom.Element representing DOM tree for AudienceRestrictionCondition object.

Throws:

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

AudienceRestrictionCondition

public AudienceRestrictionCondition(java.util.List audience)
                             throws SAMLException

This constructor takes in a List of audience for this condition, each of them being a String.

Parameters:

audience - A List of audience to be included within this condition

Throws:

SAMLException - if the List is empty or if there is some error in processing the contents of the List

Method Detail

addAudience

public boolean addAudience(java.lang.String audience)

Add an audience to this Condition element

Parameters:

audience - audience to be added

Returns:

boolean indicating success or failure of operation

setAudience

public boolean setAudience(java.util.List audience)

Add a List of audience held within this Condition element

Parameters:

audience - A List of audience to be included within this condition

Returns:

boolean indicating success or failure of operation.

getAudience

public java.util.List getAudience()

LIst of Audience held within this Condition element

Returns:

An the List of Audience within this Condition element

containsAudience

public boolean containsAudience(java.lang.String audience)

Returns true if a particular audience string is contained within this AudienceRestrictionCondition object

Parameters:

audience - audience to be checked

Returns:

true if the audience exists.

removeAudience

public boolean removeAudience(java.lang.String audience)

Remove an audience from the List within this Condition element

Parameters:

audience - A string representing the value of the Audience

Returns:

boolean true/false representing success or failure of the operation

toString

public java.lang.String toString()

Returns 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 example <saml:AudienceRestrictionCondition>.

toString

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

Returns a String representation of the <AudienceRestrictionCondition> element.

Overrides:

toString in class Condition

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

evaluate

public int evaluate()

A method which can be overridden by a plug-in maybe which provides means of evaluating this condition

Overrides:

evaluate in class Condition

Returns:

evaluation status.