org.opensaml
Class SAMLAuthorityBinding

java.lang.Object
  |
  +--org.opensaml.SAMLObject
        |
        +--org.opensaml.SAMLAuthorityBinding

All Implemented Interfaces:

java.lang.Cloneable

public class SAMLAuthorityBinding

extends SAMLObject

implements java.lang.Cloneable

Wraps a SAML Authority Binding

Author:

Scott Cantor

Field Summary

Fields inherited from class org.opensaml.SAMLObject

config, log, root

Constructor Summary

SAMLAuthorityBinding(org.w3c.dom.Element e)
Reconstructs a binding from a DOM tree

SAMLAuthorityBinding(java.io.InputStream in)
Reconstructs a binding from a stream

SAMLAuthorityBinding(java.lang.String binding, java.lang.String location, QName authorityKind)
Constructor builds a SAML AuthorityBinding 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 binding from a DOM element.
QName	getAuthorityKind() Gets the QName of the query element processable by the authority
java.lang.String	getBinding() Gets the protocol binding attribute of the authority binding
java.lang.String	getLocation() Gets the location attribute of the authority binding
org.w3c.dom.Node	toDOM(org.w3c.dom.Document doc) Overridden method to return a DOM tree representing the authority binding

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

SAMLAuthorityBinding

public SAMLAuthorityBinding(java.lang.String binding,
                            java.lang.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(org.w3c.dom.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(java.io.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(org.w3c.dom.Element e)
             throws SAMLException

Initialization of binding from a DOM element.

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

getBinding

public java.lang.String getBinding()

Gets the protocol binding attribute of the authority binding

Returns:

The binding protocol value

getLocation

public java.lang.String getLocation()

Gets the location attribute of the authority binding

Returns:

The location value

getAuthorityKind

public QName getAuthorityKind()

Gets the QName of the query element processable by the authority

Returns:

The query element QName

toDOM

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

Overridden method to return a DOM tree representing the authority binding

Overrides:

toDOM in class SAMLObject

Parameters:

doc - A Document object to use in manufacturing the tree

Returns:

Root "AuthorityBinding" 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()