org.opensaml
Class SAMLAdvice

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

All Implemented Interfaces:

java.lang.Cloneable

public class SAMLAdvice

extends SAMLObject

implements java.lang.Cloneable

Represents a SAML Action

Author:

Helen Rehn

Field Summary

Fields inherited from class org.opensaml.SAMLObject

config, log, root

Constructor Summary

SAMLAdvice(java.util.Collection advice)
Builds an advice element out of its component parts

SAMLAdvice(org.w3c.dom.Element e)
Reconstructs advice from a DOM tree

SAMLAdvice(java.io.InputStream in)
Reconstructs advice from a stream

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 action from a DOM element.
java.util.Iterator	getData() Gets the advice elements
org.w3c.dom.Node	toDOM(org.w3c.dom.Document doc) Overridden method to return a DOM tree representing the action

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

SAMLAdvice

public SAMLAdvice(java.util.Collection advice)
           throws SAMLException

Builds an advice element out of its component parts

Parameters:

advice - A collection of Strings, SAMLAssertions, or arbitrary DOM elements

Throws:

SAMLException - Raised if advice cannot be constructed from the supplied information

SAMLAdvice

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

Reconstructs advice from a DOM tree

Parameters:

e - The root of a DOM tree

Throws:

SAMLException - Thrown if the object cannot be constructed

SAMLAdvice

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

Reconstructs advice 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 action from a DOM element.

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

getData

public java.util.Iterator getData()

Gets the advice elements

Returns:

an Iterator of strings, SAMLAssertions, or DOM Elements

toDOM

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

Overridden method to return a DOM tree representing the action

Overrides:

toDOM in class SAMLObject

Parameters:

doc - A Document object to use in manufacturing the tree

Returns:

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