org.opensaml
Class SAMLAuthorityBinding

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

public class SAMLAuthorityBinding
extends SAMLObject
implements Cloneable

Wraps a SAML Authority Binding

Author:
Scott Cantor

Field Summary
protected  QName authorityKind
           
protected  String binding
           
protected  String location
           
 
Fields inherited from class org.opensaml.SAMLObject
config, dirty, log, parentObject, root
 
Constructor Summary
SAMLAuthorityBinding()
          Default constructor
SAMLAuthorityBinding(Element e)
          Reconstructs a binding from a DOM tree
SAMLAuthorityBinding(InputStream in)
          Reconstructs a binding from a stream
SAMLAuthorityBinding(String binding, String location, QName authorityKind)
          Constructor builds a SAML AuthorityBinding 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 an object from a DOM element
 QName getAuthorityKind()
          Gets the QName of the query element processable by the authority
 String getBinding()
          Gets the protocol binding attribute of the authority binding
 String getLocation()
          Gets the location attribute of the authority binding
 void setAuthorityKind(QName authorityKind)
          Sets the QName of the query element processable by the authority
 void setBinding(String binding)
          Sets the protocol binding attribute of the authority binding
 void setLocation(String location)
          Sets the location attribute of the authority binding
 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

binding

protected String binding

location

protected String location

authorityKind

protected QName authorityKind
Constructor Detail

SAMLAuthorityBinding

public SAMLAuthorityBinding()
Default constructor


SAMLAuthorityBinding

public SAMLAuthorityBinding(String binding,
                            String location,
                            QName authorityKind)
                     throws SAMLException
Constructor builds a SAML AuthorityBinding out of its component parts

Parameters:
binding - The SAML binding protocol to use
location - The AA address (URI, format dependent on the protocol)
authorityKind - The QName of the Query element that the authority knows how to process
Throws:
SAMLException - Thrown if any parameters are invalid

SAMLAuthorityBinding

public SAMLAuthorityBinding(Element e)
                     throws SAMLException
Reconstructs a binding from a DOM tree

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

SAMLAuthorityBinding

public SAMLAuthorityBinding(InputStream in)
                     throws SAMLException
Reconstructs a binding 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
Description copied from class: SAMLObject
Initialization of an object 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
See Also:
SAMLObject.fromDOM(org.w3c.dom.Element)

getBinding

public String getBinding()
Gets the protocol binding attribute of the authority binding

Returns:
The binding protocol value

setBinding

public void setBinding(String binding)
Sets the protocol binding attribute of the authority binding

Parameters:
binding - The binding protocol value

getLocation

public String getLocation()
Gets the location attribute of the authority binding

Returns:
The location value

setLocation

public void setLocation(String location)
Sets the location attribute of the authority binding

Parameters:
location - The location value

getAuthorityKind

public QName getAuthorityKind()
Gets the QName of the query element processable by the authority

Returns:
The query element QName

setAuthorityKind

public void setAuthorityKind(QName authorityKind)
Sets the QName of the query element processable by the authority

Parameters:
authorityKind - The query element QName

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

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


Copyright ? 2005 UCAID. All Rights Reserved.