gov.nih.nci.cagrid.opensaml
Class SAMLAuthorizationDecisionStatement

java.lang.Object
  gov.nih.nci.cagrid.opensaml.SAMLObject
      gov.nih.nci.cagrid.opensaml.SAMLStatement
          gov.nih.nci.cagrid.opensaml.SAMLSubjectStatement
              gov.nih.nci.cagrid.opensaml.SAMLAuthorizationDecisionStatement

All Implemented Interfaces:

java.lang.Cloneable

public class SAMLAuthorizationDecisionStatement
extends SAMLSubjectStatement
implements java.lang.Cloneable

Represents a SAML authorization decision statement.

Author:

Helen Rehn, Scott Cantor

Field Summary

protected java.util.ArrayList	actions
protected java.lang.String	decision
protected java.util.ArrayList	evidence
protected java.lang.String	resource

Fields inherited from class gov.nih.nci.cagrid.opensaml.SAMLSubjectStatement

subject

Fields inherited from class gov.nih.nci.cagrid.opensaml.SAMLStatement

statementTypeMap

Fields inherited from class gov.nih.nci.cagrid.opensaml.SAMLObject

config, dirty, log, parentObject, root

Constructor Summary

SAMLAuthorizationDecisionStatement()
Default constructor

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

void	addAction(SAMLAction action) Adds an action to the statement
void	addEvidence(java.lang.Object evidence) Adds an evidence element
protected org.w3c.dom.Element	buildRoot(org.w3c.dom.Document doc, boolean xmlns) Delegates the process of building the root element of an object and inserting appropriate namespaces.
void	checkValidity() Evaluates the object's content to see if it is currently valid if serialized.
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 an object 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
void	removeAction(int index) Removes an action by position (zero-based)
void	removeEvidence(int index) Removes an evidence element by position (zero-based)
void	setActions(java.util.Collection actions) Sets the actions to include in the statement
void	setDecision(java.lang.String decision) Sets the decision inside the statement
void	setEvidence(java.util.Collection evidence) Sets the evidence to include in the statement
void	setResource(java.lang.String resource) Sets the resource URI inside the statement
org.w3c.dom.Node	toDOM(org.w3c.dom.Document doc, boolean xmlns) Transforms the object into a DOM tree using an existing document context

Methods inherited from class gov.nih.nci.cagrid.opensaml.SAMLSubjectStatement

getSubject, setSubject

Methods inherited from class gov.nih.nci.cagrid.opensaml.SAMLStatement

getInstance, getInstance, regFactory, unregFactory

Methods inherited from class gov.nih.nci.cagrid.opensaml.SAMLObject

fromStream, fromStream, getParent, plantRoot, setDirty, setParent, toBase64, toDOM, toDOM, toDOM, toStream, toString

Methods inherited from class java.lang.Object

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

Field Detail

resource

protected java.lang.String resource

decision

protected java.lang.String decision

actions

protected java.util.ArrayList actions

evidence

protected java.util.ArrayList evidence

Constructor Detail

SAMLAuthorizationDecisionStatement

public SAMLAuthorizationDecisionStatement()

Default constructor

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, must be SAMLAction objects

evidence - evidence which may be considered, must be String or SAMLAssertion objects

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

Description copied from class: SAMLObject

Initialization of an object from a DOM element

Overrides:

fromDOM in class SAMLSubjectStatement

Parameters:

e - Root element of a DOM tree

Throws:

SAMLException - Raised if an exception occurs while constructing the object

See Also:

SAMLObject.fromDOM(org.w3c.dom.Element)

getResource

public java.lang.String getResource()

Gets the resource URI inside the statement

Returns:

the resource URI

setResource

public void setResource(java.lang.String resource)

Sets the resource URI inside the statement

Parameters:

resource - The resource URI

getDecision

public java.lang.String getDecision()

Gets the decision from inside the statement

Returns:

The decision

setDecision

public void setDecision(java.lang.String decision)

Sets the decision inside the statement

Parameters:

decision - The decision

getActions

public java.util.Iterator getActions()

Gets the actions inside the statement

Returns:

An iterator over the actions

setActions

public void setActions(java.util.Collection actions)
                throws SAMLException

Sets the actions to include in the statement

Parameters:

actions - The actions to include

Throws:

SAMLException - Raised if the actions are invalid

addAction

public void addAction(SAMLAction action)
               throws SAMLException

Adds an action to the statement

Parameters:

action - The action to add

Throws:

SAMLException - Raised if the action if invalid

removeAction

public void removeAction(int index)

Removes an action by position (zero-based)

Parameters:

index - The position of the action to remove

getEvidence

public java.util.Iterator getEvidence()

Gets the evidence inside the statement

Returns:

An iterator over the evidence

setEvidence

public void setEvidence(java.util.Collection evidence)
                 throws SAMLException

Sets the evidence to include in the statement

Parameters:

evidence - The evidence to include

Throws:

SAMLException - Raised if the evidence is invalid

addEvidence

public void addEvidence(java.lang.Object evidence)
                 throws SAMLException

Adds an evidence element

Parameters:

evidence - a String or SAMLAssertion

Throws:

SAMLException - Raised if an invalid kind of object is provided

removeEvidence

public void removeEvidence(int index)
                    throws java.lang.IndexOutOfBoundsException

Removes an evidence element by position (zero-based)

Parameters:

index - The position of the element to remove

Throws:

java.lang.IndexOutOfBoundsException

buildRoot

protected org.w3c.dom.Element buildRoot(org.w3c.dom.Document doc,
                                        boolean xmlns)

Description copied from class: SAMLObject

Delegates the process of building the root element of an object and inserting appropriate namespaces.

Specified by:

buildRoot in class SAMLObject

Parameters:

doc - The document context to use

xmlns - Include namespace(s) on root element?

Returns:

A new root element for the object

See Also:

SAMLObject.buildRoot(org.w3c.dom.Document,boolean)

toDOM

public org.w3c.dom.Node toDOM(org.w3c.dom.Document doc,
                              boolean xmlns)
                       throws SAMLException

Description copied from class: SAMLObject

Transforms the object into a DOM tree using an existing document context

Overrides:

toDOM in class SAMLSubjectStatement

Parameters:

doc - A Document object to use in manufacturing the tree

xmlns - Include namespace(s) on root element?

Returns:

Root element node of the DOM tree capturing the object

Throws:

SAMLException - Raised if the object is incompletely defined

See Also:

SAMLObject.toDOM(org.w3c.dom.Document,boolean)

checkValidity

public void checkValidity()
                   throws SAMLException

Description copied from class: SAMLObject

Evaluates the object's content to see if it is currently valid if serialized. Does not evaluate embedded objects except on the basis of whether they exist. For example, an Assertion must have a Statement, but if an invalid statement is added, SAMLAssertion.checkValidity() would succeed, while SAMLStatement.checkValidity would raise an exception.

Overrides:

checkValidity in class SAMLSubjectStatement

Throws:

SAMLException - Raised if the serialized object would be invalid SAML, excluding any embedded objects

See Also:

SAMLObject.checkValidity()

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 SAMLSubjectStatement

Returns:

The new object

Throws:

java.lang.CloneNotSupportedException

See Also:

Object.clone()