Package com.sun.identity.saml2.assertion.impl

Class ActionImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.ActionImpl

All Implemented Interfaces:

Action

public class ActionImpl
extends Object
implements Action

This class is an implementation of interface Action. The Action element specifies an action on the specified resource for which permission is sought. Its type is ActionType.

 <complexType name="ActionType">
   <simpleContent>
     <extension base="<http://www.w3.org/2001/XMLSchema>string">
       <attribute name="Namespace" use="required"
       type="{http://www.w3.org/2001/XMLSchema}anyURI" />
     </extension>
   </simpleContent>
 </complexType>
 

Constructor Summary

Constructors

Constructor	Description
ActionImpl()	Class constructor.
ActionImpl(String xmlString)	Class constructor with Action in xml string format.
ActionImpl(Element element)	Class constructor with Action in Element format.

Method Summary

Modifier and Type	Method	Description
String	getNamespace()	Returns the value of the Namespace property.
String	getValue()	Returns the value of the value property.
boolean	isMutable()	Returns the mutability of the object.
void	makeImmutable()	Makes the object immutable.
void	setNamespace(String value)	Sets the value of the Namespace property.
void	setValue(String value)	Sets the value of the value property.
String	toXMLString()	Returns a String representation of the element.
String	toXMLString(boolean includeNS, boolean declareNS)	Returns a String representation of the element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionImpl

public ActionImpl()

Class constructor. Caller may need to call setters to populate the object.

ActionImpl

public ActionImpl(Element element)
           throws SAML2Exception

Class constructor with Action in Element format.

Throws:

SAML2Exception

ActionImpl

public ActionImpl(String xmlString)
           throws SAML2Exception

Class constructor with Action in xml string format.

Throws:

SAML2Exception

Method Detail

makeImmutable

public void makeImmutable()

Makes the object immutable.

Specified by:

makeImmutable in interface Action

isMutable

public boolean isMutable()

Returns the mutability of the object.

Specified by:

isMutable in interface Action

Returns:

true if the object is mutable; false otherwise.

getValue

public String getValue()

Returns the value of the value property.

Specified by:

getValue in interface Action

Returns:

A String label for the action.

See Also:

setValue(String)

setValue

public void setValue(String value)
              throws SAML2Exception

Sets the value of the value property.

Specified by:

setValue in interface Action

Parameters:

value - A String lable for the action to be set.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getValue()

getNamespace

public String getNamespace()

Returns the value of the Namespace property.

Specified by:

getNamespace in interface Action

Returns:

A String representing Namespace attribute.

See Also:

setNamespace(String)

setNamespace

public void setNamespace(String value)
                  throws SAML2Exception

Sets the value of the Namespace property.

Specified by:

setNamespace in interface Action

Parameters:

value - A String representing Namespace attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getNamespace()

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of the element.

Specified by:

toXMLString in interface Action

Returns:

A string containing the valid XML for this element. By default name space name is prepended to the element name.

Throws:

SAML2Exception - if the object does not conform to the schema.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws SAML2Exception

Returns a String representation of the element.

Specified by:

toXMLString in interface Action

Parameters:

includeNS - Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the namespace is declared within the Element.

Returns:

A string containing the valid XML for this element

Throws:

SAML2Exception - if the object does not conform to the schema.