org.opensaml
Class SAMLAttributeDesignator

java.lang.Object
  extended byorg.opensaml.SAMLObject
      extended byorg.opensaml.SAMLAttributeDesignator
All Implemented Interfaces:
Cloneable

public class SAMLAttributeDesignator
extends SAMLObject
implements Cloneable

SAML Attribute Designator implementation

Author:
Scott Cantor

Field Summary
protected  String name
          Name of attribute
protected  String namespace
          Namespace/qualifier of attribute
 
Fields inherited from class org.opensaml.SAMLObject
config, dirty, log, parentObject, root
 
Constructor Summary
SAMLAttributeDesignator()
          Default constructor
SAMLAttributeDesignator(Element e)
          Reconstructs an AttributeDesignator from a DOM tree
SAMLAttributeDesignator(InputStream in)
          Reconstructs an AttributeDesignator from a stream
SAMLAttributeDesignator(String name, String namespace)
          Builds an AttributeDesignator out of its component parts
 
Method Summary
protected  Element buildRoot(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.
 Object clone()
          Copies a SAML object such that no dependencies exist between the original and the copy.
 void fromDOM(Element e)
          Initialization of AttributeDesignator from a DOM element.
 String getName()
          Gets the AttributeName attribute of the SAML AttributeDesignator
 String getNamespace()
          Gets the AttributeNamespace attribute of the SAML AttributeDesignator
 void setName(String name)
          Sets the AttributeName attribute of the SAML AttributeDesignator
 void setNamespace(String namespace)
          Sets the AttributeNamespace attribute of the SAML AttributeDesignator
 Node toDOM(Document doc, boolean xmlns)
          Transforms the object into a DOM tree using an existing document context
 
Methods inherited from class org.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

name

protected String name
Name of attribute


namespace

protected String namespace
Namespace/qualifier of attribute

Constructor Detail

SAMLAttributeDesignator

public SAMLAttributeDesignator()
Default constructor


SAMLAttributeDesignator

public SAMLAttributeDesignator(String name,
                               String namespace)
                        throws SAMLException
Builds an AttributeDesignator out of its component parts

Parameters:
name - Name of attribute
namespace - Namespace/qualifier of attribute
Throws:
SAMLException - Thrown if attribute cannot be built from the supplied information

SAMLAttributeDesignator

public SAMLAttributeDesignator(Element e)
                        throws SAMLException
Reconstructs an AttributeDesignator from a DOM tree

Parameters:
e - The root of a DOM tree
Throws:
SAMLException - Thrown if the object cannot be constructed

SAMLAttributeDesignator

public SAMLAttributeDesignator(InputStream in)
                        throws SAMLException
Reconstructs an AttributeDesignator 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(Element e)
             throws SAMLException
Initialization of AttributeDesignator from a DOM element.

Overrides:
fromDOM in class SAMLObject
Parameters:
e - Root element of a DOM tree
Throws:
SAMLException - Raised if an exception occurs while constructing the object.

getName

public String getName()
Gets the AttributeName attribute of the SAML AttributeDesignator

Returns:
The name value

setName

public void setName(String name)
Sets the AttributeName attribute of the SAML AttributeDesignator

Parameters:
name - The name value

getNamespace

public String getNamespace()
Gets the AttributeNamespace attribute of the SAML AttributeDesignator

Returns:
The namespace value

setNamespace

public void setNamespace(String namespace)
Sets the AttributeNamespace attribute of the SAML AttributeDesignator

Parameters:
namespace - The name value

buildRoot

protected Element buildRoot(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 Node toDOM(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 SAMLObject
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.

Specified by:
checkValidity in class SAMLObject
Throws:
SAMLException - Raised if the serialized object would be invalid SAML, excluding any embedded objects
See Also:
SAMLObject.checkValidity()

clone

public Object clone()
             throws CloneNotSupportedException
Copies a SAML object such that no dependencies exist between the original and the copy. Does not clone values.

Overrides:
clone in class SAMLObject
Returns:
The new object
Throws:
CloneNotSupportedException
See Also:
Object.clone()


Copyright ? 2005 UCAID. All Rights Reserved.