com.sun.identity.saml.protocol
クラス StatusCode

java.lang.Object
  com.sun.identity.saml.protocol.StatusCode

public class StatusCode
extends Object

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

コンストラクタの概要

StatusCode(Element statusCode)
Constructs an instance of StatusCode from a DOM element.

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

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

メソッドの概要

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

コンストラクタの詳細

StatusCode

public StatusCode(Element statusCode)
           throws SAMLException

Constructs an instance of StatusCode from a DOM element.

パラメータ:

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

例外:

SAMLException - when an error occurs.

StatusCode

public StatusCode(String value,
                  StatusCode subCode)
           throws SAMLException

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

パラメータ:

value - The value of the StatusCode. This 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.

例外:

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

StatusCode

public StatusCode(String value)
           throws SAMLException

Construct a StatusCode object from a value String.

パラメータ:

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

例外:

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

メソッドの詳細

setStatusCode

public void setStatusCode(StatusCode subcode)

Sets the sub StatusCode.

パラメータ:

subcode - StatusCode to be included.

getStatusCode

public StatusCode getStatusCode()

Gets the sub StatusCode of the StatusCode.

戻り値:

StatusCode.

getValue

public String getValue()

Gets the value of the StatusCode.

戻り値:

A String representing the value of the StatusCode.

toString

public String toString()

Translates the StatusCode to an XML document String based on the SAML schema.

オーバーライド:

クラス Object 内の toString

戻り値:

An XML String representing the StatusCode.

toString

public String toString(boolean includeNS,
                       boolean declareNS)

Creates a String representation of the <samlp:StatusCode> element.

パラメータ:

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.

戻り値:

A string containing the valid XML for this element.