Package com.sun.identity.saml2.ecp.impl

Class ECPRelayStateImpl

java.lang.Object

com.sun.identity.saml2.ecp.impl.ECPRelayStateImpl

All Implemented Interfaces:

ECPRelayState

public class ECPRelayStateImpl
extends Object
implements ECPRelayState

This class implements ECPRelayState element. It provides all the methods required by ECPRelayState

Constructor Summary

Constructors

Constructor	Description
ECPRelayStateImpl()	Constructs the ECPRelayState Object.
ECPRelayStateImpl(String xmlString)	Constructs the ECPRelayState Object.
ECPRelayStateImpl(Element element)	Constructs the ECPRelayState Object.

Method Summary

Modifier and Type	Method	Description
String	getActor()	Returns value of actor attribute.
String	getValue()	Returns the value of the RelayState.
Boolean	isMustUnderstand()	Returns value of mustUnderstand attribute.
boolean	isMutable()	Returns true if object is mutable.
void	makeImmutable()	Makes this object immutable.
void	setActor(String actor)	Sets the value of actor attribute.
void	setMustUnderstand(Boolean mustUnderstand)	Sets the value of the mustUnderstand attribute.
void	setValue(String value)	Sets the value of the RelayState.
String	toXMLString()	Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation
protected void	validateData()

Methods inherited from class java.lang.Object

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

Constructor Detail

ECPRelayStateImpl

public ECPRelayStateImpl()

Constructs the ECPRelayState Object.

ECPRelayStateImpl

public ECPRelayStateImpl(Element element)
                  throws SAML2Exception

Constructs the ECPRelayState Object.

Parameters:

element - the Document Element of ECP RelayState object.

Throws:

SAML2Exception - if ECPRelayState cannot be created.

ECPRelayStateImpl

public ECPRelayStateImpl(String xmlString)
                  throws SAML2Exception

Constructs the ECPRelayState Object.

Parameters:

xmlString - the XML String representation of this object.

Throws:

SAML2Exception - if ECPRelayState cannot be created.

Method Detail

getValue

public String getValue()

Returns the value of the RelayState.

Specified by:

getValue in interface ECPRelayState

Returns:

value of the RelayState.

See Also:

setValue(String)

setValue

public void setValue(String value)
              throws SAML2Exception

Sets the value of the RelayState.

Specified by:

setValue in interface ECPRelayState

Parameters:

value - new value of the RelayState.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getValue()

isMustUnderstand

public Boolean isMustUnderstand()

Returns value of mustUnderstand attribute.

Specified by:

isMustUnderstand in interface ECPRelayState

Returns:

value of mustUnderstand attribute.

setMustUnderstand

public void setMustUnderstand(Boolean mustUnderstand)
                       throws SAML2Exception

Sets the value of the mustUnderstand attribute.

Specified by:

setMustUnderstand in interface ECPRelayState

Parameters:

mustUnderstand - the value of mustUnderstand attribute.

Throws:

SAML2Exception - if the object is immutable.

getActor

public String getActor()

Returns value of actor attribute.

Specified by:

getActor in interface ECPRelayState

Returns:

value of actor attribute

setActor

public void setActor(String actor)
              throws SAML2Exception

Sets the value of actor attribute.

Specified by:

setActor in interface ECPRelayState

Parameters:

actor - the value of actor attribute

Throws:

SAML2Exception - if the object is immutable.

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

Specified by:

toXMLString in interface ECPRelayState

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if it could not create String object

toXMLString

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

Returns a String representation

Specified by:

toXMLString in interface ECPRelayState

Parameters:

includeNSPrefix - 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 representation of this Object.

Throws:

SAML2Exception - ,if it could not create String object.

makeImmutable

public void makeImmutable()

Makes this object immutable.

Specified by:

makeImmutable in interface ECPRelayState

isMutable

public boolean isMutable()

Returns true if object is mutable.

Specified by:

isMutable in interface ECPRelayState

Returns:

true if object is mutable.

validateData

protected void validateData()
                     throws SAML2Exception

Throws:

SAML2Exception