com.sun.identity.saml2.protocol.impl

Class StatusCodeImpl

java.lang.Object

com.sun.identity.saml2.protocol.impl.StatusCodeImpl

All Implemented Interfaces:

StatusCode

public class StatusCodeImpl
extends Object
implements StatusCode

This class defines methods for StatusCode element.

Constructor Summary

Constructors

Constructor and Description
StatusCodeImpl() Constructs the StatusCode Object.
StatusCodeImpl(Element element) Constructs the StatusCode Object.
StatusCodeImpl(String xmlString) Constructs the StatusCode Object.

Method Summary

Modifier and Type	Method and Description
StatusCode	getStatusCode() Returns the value of the statusCode property.
String	getValue() Returns the status code value of the value property.
boolean	isMutable() Returns value true if object is mutable.
void	makeImmutable() Makes this object immutable.
void	setStatusCode(StatusCode value) Sets the value of the statusCode property.
void	setValue(String value) Sets the status code value of the value property.
String	toXMLString() Returns the StatusCode in an XML document String format based on the StatusCode schema described above.
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns the StatusCode in an XML document String format based on the StatusCode schema described above.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusCodeImpl

public StatusCodeImpl()

Constructs the StatusCode Object.

StatusCodeImpl

public StatusCodeImpl(Element element)
               throws SAML2Exception

Constructs the StatusCode Object.

Parameters:

element - the Document Element of StatusCode object.

Throws:

SAML2Exception - if StatusCode cannot be created.

StatusCodeImpl

public StatusCodeImpl(String xmlString)
               throws SAML2Exception

Constructs the StatusCode Object.

Parameters:

xmlString - the XML String representation of this object.

Throws:

SAML2Exception - if StatusCode cannot be created.

Method Detail

getStatusCode

public StatusCode getStatusCode()

Returns the value of the statusCode property.

Specified by:

getStatusCode in interface StatusCode

Returns:

the value of the statusCode property

See Also:

setStatusCode(StatusCode)

setStatusCode

public void setStatusCode(StatusCode value)
                   throws SAML2Exception

Sets the value of the statusCode property.

Specified by:

setStatusCode in interface StatusCode

Parameters:

value - the value of the statusCode property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getStatusCode()

getValue

public String getValue()

Returns the status code value of the value property.

Specified by:

getValue in interface StatusCode

Returns:

the value of the value property

See Also:

setValue(String)

setValue

public void setValue(String value)
              throws SAML2Exception

Sets the status code value of the value property.

Specified by:

setValue in interface StatusCode

Parameters:

value - the value of the value property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getValue()

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns the StatusCode in an XML document String format based on the StatusCode schema described above.

Specified by:

toXMLString in interface StatusCode

Returns:

An XML String representing the StatusCode.

Throws:

SAML2Exception - if some error occurs during conversion to String.

toXMLString

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

Returns the StatusCode in an XML document String format based on the StatusCode schema described above.

Specified by:

toXMLString in interface StatusCode

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 XML String representing the StatusCode.

Throws:

SAML2Exception - if some error occurs during conversion to String.

makeImmutable

public void makeImmutable()

Makes this object immutable.

Specified by:

makeImmutable in interface StatusCode

isMutable

public boolean isMutable()

Returns value true if object is mutable.

Specified by:

isMutable in interface StatusCode

Returns:

true if object is mutable.