org.opensaml
Class SAMLAuthorizationDecisionStatement

java.lang.Object
  |
  +--org.opensaml.SAMLObject
        |
        +--org.opensaml.SAMLStatement
              |
              +--org.opensaml.SAMLAuthorizationDecisionStatement

All Implemented Interfaces:

java.lang.Cloneable

public class SAMLAuthorizationDecisionStatement

extends SAMLStatement

implements java.lang.Cloneable

Represents a SAML authorization decision statement.

Author:

Helen Rehn, Scott Cantor

Field Summary

Fields inherited from class org.opensaml.SAMLStatement

statementTypeMap

Fields inherited from class org.opensaml.SAMLObject

config, log, root

Constructor Summary

SAMLAuthorizationDecisionStatement(org.w3c.dom.Element e)
Reconstructs a statement from a DOM tree

SAMLAuthorizationDecisionStatement(java.io.InputStream in)
Reconstructs a statement from a stream

SAMLAuthorizationDecisionStatement(SAMLSubject subject, java.lang.String resource, java.lang.String decision, java.util.Collection actions, java.util.Collection evidence)
Builds an AuthorizationDecisionStatement out of its component parts

Method Summary

java.lang.Object	clone() Copies a SAML object such that no dependencies exist between the original and the copy
void	fromDOM(org.w3c.dom.Element e) Initialization of statement from a DOM element.
java.util.Iterator	getActions() Gets the actions inside the statement
java.lang.String	getDecision() Gets the decision from inside the statement
java.util.Iterator	getEvidence() Gets the evidence inside the statement
java.lang.String	getResource() Gets the resource URI inside the statement
SAMLSubject	getSubject() Gets the statement subject
org.w3c.dom.Node	toDOM(org.w3c.dom.Document doc) Overridden method to return a DOM tree representing the statement

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

SAMLAuthorizationDecisionStatement

public SAMLAuthorizationDecisionStatement(SAMLSubject subject,
                                          java.lang.String resource,
                                          java.lang.String decision,
                                          java.util.Collection actions,
                                          java.util.Collection evidence)
                                   throws SAMLException

Builds an AuthorizationDecisionStatement out of its component parts

Parameters:

subject - subject of the statement

resource - URI of the resource being accessed at the time of the statement

actions - specific actions the decision applies to

evidence - evidence which may be considered

Throws:

SAMLException - Raised if an AuthorizationDecisionStatement cannot be constructed from the supplied information

SAMLAuthorizationDecisionStatement

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

Reconstructs a statement from a DOM tree

Parameters:

e - The root of a DOM tree

Throws:

SAMLException - Thrown if the object cannot be constructed

SAMLAuthorizationDecisionStatement

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

Reconstructs a statement 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 statement from a DOM element.

Checks the statement'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.

getSubject

public SAMLSubject getSubject()

Gets the statement subject

Returns:

the statement subject

getResource

public java.lang.String getResource()

Gets the resource URI inside the statement

Returns:

the resource URI

getDecision

public java.lang.String getDecision()

Gets the decision from inside the statement

Returns:

the decision

getActions

public java.util.Iterator getActions()

Gets the actions inside the statement

Returns:

An iterator over the actions

getEvidence

public java.util.Iterator getEvidence()

Gets the evidence inside the statement

Returns:

An iterator over the evidence

toDOM

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

Overridden method to return a DOM tree representing the statement

Overrides:

toDOM in class SAMLObject

Parameters:

doc - A Document object to use in manufacturing the tree

Returns:

Root element of a DOM tree

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()