Package com.sun.identity.saml2.assertion

Interface Action

All Known Implementing Classes:

ActionImpl

public 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>
 

Method Summary

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

Method Detail

makeImmutable

void makeImmutable()

Makes the object immutable.

isMutable

boolean isMutable()

Returns the mutability of the object.

Returns:

true if the object is mutable; false otherwise.

getValue

String getValue()

Returns the value of the Action.

Returns:

the value of this Action.

See Also:

setValue(String)

setValue

void setValue(String value)
       throws SAML2Exception

Sets the value of this Action.

Parameters:

value - new Action.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getValue()

getNamespace

String getNamespace()

Returns the value of Namespace attribute.

Returns:

the value of Namespace attribute.

See Also:

setNamespace(String)

setNamespace

void setNamespace(String value)
           throws SAML2Exception

Sets the value of the Namespace attribute.

Parameters:

value - new value of Namespace attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getNamespace()

toXMLString

String toXMLString()
            throws SAML2Exception

Returns a String representation of the element.

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

String toXMLString(boolean includeNS,
                   boolean declareNS)
            throws SAML2Exception

Returns a String representation of the element.

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.