com.sun.identity.saml.protocol
Class StatusCode

java.lang.Object
  |
  +--com.sun.identity.saml.protocol.StatusCode

public class StatusCode

extends java.lang.Object

This class represents the StatusCode and SubStatusCode element. It corresponds to samlp:StatusCodeType in SAML protocol schema.

Constructor Summary

StatusCode(org.w3c.dom.Element statusCode)
This constructor is used to construct a StatusCode from a DOM element.

StatusCode(java.lang.String value)
Construct a StatusCode object from a value String.

StatusCode(java.lang.String value, StatusCode subCode)
Construct a StatusCode object from a value String and a sub StatusCode.

Method Summary

StatusCode	getStatusCode() Gets the sub StatusCode of the StatusCode.
java.lang.String	getValue() Gets the value of the StatusCode.
void	setStatusCode(StatusCode subcode) Sets the sub StatusCode.
java.lang.String	toString() This method translates the StatusCode to an XML document String based on the SAML schema.
java.lang.String	toString(boolean includeNS, boolean declareNS) Creates a String representation of the <samlp:StatusCode> element.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StatusCode

public StatusCode(org.w3c.dom.Element statusCode)
           throws SAMLException

This constructor is used to construct a StatusCode from a DOM element.

Parameters:

status - An DOM Element that's rooted by <StatusCode>.

Throws:

SAMLException - when an error occurs.

StatusCode

public StatusCode(java.lang.String value,
                  StatusCode subCode)
           throws SAMLException

Construct a StatusCode object from a value String and a sub StatusCode.

Parameters:

value - A String that is the value of the StatusCode. The string could be prefixed by "samlp:". If it is not prefixed, or prefixed by prefix other than "samlp:", "samlp:" will be used instead.

subCode - The optional sub StatusCode

Throws:

SAMLException - if value string is null, empty, or contains wrong value.

StatusCode

public StatusCode(java.lang.String value)
           throws SAMLException

Construct a StatusCode object from a value String.

Parameters:

value - A String that is the value of the StatusCode. The string could be prefixed by "samlp:". It it is not prefixed, or prefixed by prefix other than "samlp:", "samlp:" will be used instead.

Throws:

SAMLException - if value string is null, empty, or contains wrong value.

Method Detail

setStatusCode

public void setStatusCode(StatusCode subcode)

Sets the sub StatusCode.

Parameters:

subcode - StatusCode to be included.

getStatusCode

public StatusCode getStatusCode()

Gets the sub StatusCode of the StatusCode.

Returns:

StatusCode.

getValue

public java.lang.String getValue()

Gets the value of the StatusCode.

Returns:

A String representing the value of the StatusCode.

toString

public java.lang.String toString()

This method translates the StatusCode to an XML document String based on the SAML schema.

Overrides:

toString in class java.lang.Object

Returns:

An XML String representing the StatusCode.

toString

public java.lang.String toString(boolean includeNS,
                                 boolean declareNS)

Creates a String representation of the <samlp:StatusCode> 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