org.opensaml
Class SAMLAudienceRestrictionCondition

java.lang.Object
  |
  +--org.opensaml.SAMLObject
        |
        +--org.opensaml.SAMLCondition
              |
              +--org.opensaml.SAMLAudienceRestrictionCondition

All Implemented Interfaces:

java.lang.Cloneable

public class SAMLAudienceRestrictionCondition

extends SAMLCondition

implements java.lang.Cloneable

Represents a SAML AudienceRestrictionCondition

Author:

Scott Cantor

Field Summary

Fields inherited from class org.opensaml.SAMLCondition

conditionTypeMap

Fields inherited from class org.opensaml.SAMLObject

config, log, root

Constructor Summary

SAMLAudienceRestrictionCondition(java.util.Collection audiences)
Builds a condition out of its component parts

SAMLAudienceRestrictionCondition(org.w3c.dom.Element e)
Reconstructs a condition from a DOM tree

SAMLAudienceRestrictionCondition(java.io.InputStream in)
Reconstructs a condition from a stream

Method Summary

java.lang.Object	clone() Copies a SAML object such that no dependencies exist between the original and the copy
boolean	eval(java.util.Collection audiences) Evaluates the condition
void	fromDOM(org.w3c.dom.Element e) Initialization of condition from a DOM element.
org.w3c.dom.Node	toDOM(org.w3c.dom.Document doc) Overridden method to return a DOM tree representing the condition

Methods inherited from class org.opensaml.SAMLObject

fromStream, plantRoot, toBase64, toDOM, toStream, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SAMLAudienceRestrictionCondition

public SAMLAudienceRestrictionCondition(java.util.Collection audiences)
                                 throws SAMLException

Builds a condition out of its component parts

Parameters:

audiences - Array of audiences to embed in condition

Throws:

SAMLException - Raised if a condition cannot be constructed from the supplied information

SAMLAudienceRestrictionCondition

public SAMLAudienceRestrictionCondition(org.w3c.dom.Element e)
                                 throws SAMLException

Reconstructs a condition from a DOM tree

Parameters:

e - The root of a DOM tree

Throws:

SAMLException - Thrown if the object cannot be constructed

SAMLAudienceRestrictionCondition

public SAMLAudienceRestrictionCondition(java.io.InputStream in)
                                 throws SAMLException

Reconstructs a condition from a stream

Parameters:

in - A stream containing XML

Throws:

SAMLException - Raised if an exception occurs while constructing the object.

Method Detail

fromDOM

public void fromDOM(org.w3c.dom.Element e)
             throws SAMLException

Initialization of condition from a DOM element.

Checks the condition's syntactic validity. An exception is thrown if any problems are detected. The exception will contain a message describing the problem, and may wrap another exception.

Overrides:

fromDOM in class SAMLObject

Parameters:

e - Root element of a DOM tree

Throws:

SAMLException - Raised if an exception occurs while constructing the object.

toDOM

public org.w3c.dom.Node toDOM(org.w3c.dom.Document doc)

Overridden method to return a DOM tree representing the condition

Overrides:

toDOM in class SAMLObject

Parameters:

doc - A Document object to use in manufacturing the tree

Returns:

Root "AudienceRestrictionCondition" element of a DOM tree

eval

public boolean eval(java.util.Collection audiences)

Evaluates the condition

Parameters:

audiences - A collection of audiences deemed acceptable by the evaluator

Returns:

Returns true iff the condition's audiences intersect with those of the evaluator

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Copies a SAML object such that no dependencies exist between the original and the copy

Overrides:

clone in class SAMLObject

Returns:

The new object

java.lang.CloneNotSupportedException

See Also:

Object.clone()