org.opensaml
Class SAMLAction

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

All Implemented Interfaces:

java.lang.Cloneable

public class SAMLAction

extends SAMLObject

implements java.lang.Cloneable

Represents a SAML Action

Author:

Helen Rehn

Field Summary

static java.lang.String

SAML_ACTION_NAMESPACE Default SAML Action Namespace URI

Fields inherited from class org.opensaml.SAMLObject

config, log, root

Constructor Summary

SAMLAction(org.w3c.dom.Element e)
Reconstructs an action from a DOM tree

SAMLAction(java.io.InputStream in)
Reconstructs an action from a stream

SAMLAction(java.lang.String namespace, java.lang.String data)
Builds an action 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 action from a DOM element.
java.lang.String	getData() Gets the data from the action
java.lang.String	getNamespace() Gets the namespace from the action
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

Field Detail

SAML_ACTION_NAMESPACE

public static final java.lang.String SAML_ACTION_NAMESPACE

Default SAML Action Namespace URI

See Also:

Constant Field Values

Constructor Detail

SAMLAction

public SAMLAction(java.lang.String namespace,
                  java.lang.String data)
           throws SAMLException

Builds an action out of its component parts

Parameters:

namespace - a URI reference representing the namespace in which the name of the specified action is to be interpreted

data - an action sought to be performed on the specified resource

Throws:

SAMLException - Raised if an action cannot be constructed from the supplied information

SAMLAction

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

Reconstructs an action from a DOM tree

Parameters:

e - The root of a DOM tree

Throws:

SAMLException - Thrown if the object cannot be constructed

SAMLAction

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

Reconstructs an action 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.

getNamespace

public java.lang.String getNamespace()

Gets the namespace from the action

Returns:

the namespace

getData

public java.lang.String getData()

Gets the data from the action

Returns:

the data

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