org.opensaml
Class SAMLAction

java.lang.Object
  org.opensaml.SAMLObject
      org.opensaml.SAMLAction

All Implemented Interfaces:

Cloneable

public class SAMLAction
extends SAMLObject
implements Cloneable

Represents a SAML Action

Author:

Helen Rehn

Field Summary

static String	SAML_ACTION_NAMESPACE_GHPP
static String	SAML_ACTION_NAMESPACE_RWEDC SAML Action Namespace URI values
static String	SAML_ACTION_NAMESPACE_RWEDC_NEG
static String	SAML_ACTION_NAMESPACE_UNIX

Fields inherited from class org.opensaml.SAMLObject

config, dirty, log, parentObject, root

Constructor Summary

SAMLAction()
Default constructor

SAMLAction(Element e)
Reconstructs an action from a DOM tree

SAMLAction(InputStream in)
Reconstructs an action from a stream

SAMLAction(String namespace, String data)
Builds an action 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
String	getData() Gets the data from the action
String	getNamespace() Gets the namespace from the action
void	setData(String data) Sets the data of the action
void	setNamespace(String namespace) Sets the namespace of the action
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

SAML_ACTION_NAMESPACE_RWEDC

public static final String SAML_ACTION_NAMESPACE_RWEDC

SAML Action Namespace URI values

See Also:

Constant Field Values

SAML_ACTION_NAMESPACE_RWEDC_NEG

public static final String SAML_ACTION_NAMESPACE_RWEDC_NEG

See Also:

Constant Field Values

SAML_ACTION_NAMESPACE_GHPP

public static final String SAML_ACTION_NAMESPACE_GHPP

See Also:

Constant Field Values

SAML_ACTION_NAMESPACE_UNIX

public static final String SAML_ACTION_NAMESPACE_UNIX

See Also:

Constant Field Values

Constructor Detail

SAMLAction

public SAMLAction()

Default constructor

SAMLAction

public SAMLAction(String namespace,
                  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(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(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(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)

getNamespace

public String getNamespace()

Gets the namespace from the action

Returns:

the namespace

getData

public String getData()

Gets the data from the action

Returns:

the data

setNamespace

public void setNamespace(String namespace)

Sets the namespace of the action

Parameters:

namespace - the namespace

setData

public void setData(String data)

Sets the data of the action

Parameters:

data - the data

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