com.sun.identity.saml2.protocol.impl

Class StatusImpl

java.lang.Object

com.sun.identity.saml2.protocol.impl.StatusImpl

All Implemented Interfaces:

Status

public class StatusImpl
extends Object
implements Status

This class defines methods for Status element.

Constructor Summary

Constructors

Constructor and Description
StatusImpl() Constructs the Status Object.
StatusImpl(Element element) Constructs the Status Object.
StatusImpl(String xmlString) Constructs the Status Object.

Method Summary

Modifier and Type	Method and Description
StatusCode	getStatusCode() Returns the value of the statusCode property.
StatusDetail	getStatusDetail() Returns the value of the statusDetail property.
String	getStatusMessage() Returns the value of the statusMessage 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	setStatusDetail(StatusDetail value) Sets the value of the statusDetail property.
void	setStatusMessage(String value) Sets the value of the statusMessage property.
String	toXMLString() Returns the Status in an XML document String format based on the Status schema described above.
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns the Status in an XML document String format based on the Status schema described above.
protected void	validateStatusCode(StatusCode statusCode)

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusImpl

public StatusImpl()

Constructs the Status Object.

StatusImpl

public StatusImpl(Element element)
           throws SAML2Exception

Constructs the Status Object.

Parameters:

element - the Document Element of Status object.

Throws:

SAML2Exception - if Status cannot be created.

StatusImpl

public StatusImpl(String xmlString)
           throws SAML2Exception

Constructs the Status Object.

Parameters:

xmlString - the XML String representation of this object.

Throws:

SAML2Exception - if Status cannot be created.

Method Detail

getStatusCode

public StatusCode getStatusCode()

Returns the value of the statusCode property.

Specified by:

getStatusCode in interface Status

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 Status

Parameters:

value - the value of the statusCode property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getStatusCode()

getStatusMessage

public String getStatusMessage()

Returns the value of the statusMessage property.

Specified by:

getStatusMessage in interface Status

Returns:

the value of the statusMessage property

See Also:

setStatusMessage(String)

setStatusMessage

public void setStatusMessage(String value)
                      throws SAML2Exception

Sets the value of the statusMessage property.

Specified by:

setStatusMessage in interface Status

Parameters:

value - the value of the statusMessage property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getStatusMessage()

getStatusDetail

public StatusDetail getStatusDetail()

Returns the value of the statusDetail property.

Specified by:

getStatusDetail in interface Status

Returns:

the value of the statusDetail property

See Also:

setStatusDetail(StatusDetail)

setStatusDetail

public void setStatusDetail(StatusDetail value)
                     throws SAML2Exception

Sets the value of the statusDetail property.

Specified by:

setStatusDetail in interface Status

Parameters:

value - the value of the statusDetail property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getStatusDetail()

toXMLString

public String toXMLString()
                   throws SAML2Exception

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

Specified by:

toXMLString in interface Status

Returns:

An XML String representing the Status.

Throws:

SAML2Exception - if some error occurs during conversion to String.

toXMLString

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

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

Specified by:

toXMLString in interface Status

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 Status.

Throws:

SAML2Exception - if some error occurs during conversion to String.

makeImmutable

public void makeImmutable()

Makes this object immutable.

Specified by:

makeImmutable in interface Status

isMutable

public boolean isMutable()

Returns value true if object is mutable.

Specified by:

isMutable in interface Status

Returns:

true if object is mutable.

validateStatusCode

protected void validateStatusCode(StatusCode statusCode)
                           throws SAML2Exception

Throws:

SAML2Exception