gov.nih.nci.cagrid.opensaml
Class SAMLAttributeStatement

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.SAMLAttributeStatement

All Implemented Interfaces:

java.lang.Cloneable

public class SAMLAttributeStatement
extends SAMLSubjectStatement
implements java.lang.Cloneable

Represents a SAML Attribute Statement

Author:

Scott Cantor

Field Summary

protected java.util.ArrayList

attrs

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

SAMLAttributeStatement()
Default constructor

SAMLAttributeStatement(org.w3c.dom.Element e)
Reconstructs an attribute statement from a DOM tree

SAMLAttributeStatement(java.io.InputStream in)
Reconstructs an attribute statement from a stream

SAMLAttributeStatement(SAMLSubject subject, java.util.Collection attrs)
Builds a statement out of its component parts

Method Summary

void	addAttribute(SAMLAttribute attribute) Adds an attribute to the statement
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	getAttributes() Gets attributes from the statement, if any
void	removeAttribute(int index) Removes an attribute by position (zero-based)
void	setAttributes(java.util.Collection attributes) Sets the attributes 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

attrs

protected java.util.ArrayList attrs

Constructor Detail

SAMLAttributeStatement

public SAMLAttributeStatement()

Default constructor

SAMLAttributeStatement

public SAMLAttributeStatement(SAMLSubject subject,
                              java.util.Collection attrs)
                       throws SAMLException

Builds a statement out of its component parts

Parameters:

subject - Subject of statement

attrs - Collection of attributes

Throws:

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

SAMLAttributeStatement

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

Reconstructs an attribute statement from a DOM tree

Parameters:

e - The root of a DOM tree

Throws:

SAMLException - Thrown if the object cannot be constructed

SAMLAttributeStatement

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

Reconstructs an attribute 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)

getAttributes

public java.util.Iterator getAttributes()

Gets attributes from the statement, if any

Returns:

An array of attributes

setAttributes

public void setAttributes(java.util.Collection attributes)
                   throws SAMLException

Sets the attributes inside the statement

Parameters:

attributes - The attributes to include

Throws:

SAMLException - Raised if the attributes are invalid

addAttribute

public void addAttribute(SAMLAttribute attribute)
                  throws SAMLException

Adds an attribute to the statement

Parameters:

attribute - The attribute to add

Throws:

SAMLException - Raised if the subject is invalid

removeAttribute

public void removeAttribute(int index)

Removes an attribute by position (zero-based)

Parameters:

index - The position of the attribute to remove

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