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

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

public class Status
extends Object

This class represents the Status element. It corresponds to <samlp:StatusType> in SAML protocol schema.

コンストラクタの概要

Status(Element status)
This constructor is used to construct a Status from a DOM element.

Status(StatusCode code)
Constructs a Status object from a StatusCode.

Status(StatusCode code, String message, Element detail)
Constructor.

メソッドの概要

StatusCode	getStatusCode() Gets the StatusCode of the Response.
Element	getStatusDetail() Gets the StatusDetail of the Response.
String	getStatusMessage() Returns the StatusMessage of the Response.
String	toString() This method translates the AssertionArtifact to an XML document String based on the SAML schema.
String	toString(boolean includeNS, boolean declareNS) Creates a String representation of the <samlp:Status> element.

コンストラクタの詳細

Status

public Status(Element status)
       throws SAMLException

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

パラメータ:

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

例外:

SAMLException - when an error occurs.

Status

public Status(StatusCode code,
              String message,
              Element detail)
       throws SAMLException

Constructor.

パラメータ:

code - StatusCode.

message - A String that is the StatusMessage of the response. It could be null when there is no StatusMessage.

detail - A DOM tree element that is the StatusDetail of the response. It could be null when there is no StatusDetail.

例外:

SAMLException

Status

public Status(StatusCode code)
       throws SAMLException

Constructs a Status object from a StatusCode.

パラメータ:

code - StatusCode.

例外:

SAMLException

メソッドの詳細

getStatusCode

public StatusCode getStatusCode()

Gets the StatusCode of the Response.

戻り値:

StatusCode of the response.

getStatusMessage

public String getStatusMessage()

Returns the StatusMessage of the Response.

戻り値:

A String that represents the StatusMessage of the response. null is returned when there is no StatusMessage in the response.

getStatusDetail

public Element getStatusDetail()

Gets the StatusDetail of the Response.

戻り値:

A DOM tree element that represents the StatusDetail of the response. Null is returned if no StatusDetail in the response.

toString

public String toString()

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

オーバーライド:

クラス Object 内の toString

戻り値:

An XML String representing the AssertionArtifact.

toString

public String toString(boolean includeNS,
                       boolean declareNS)

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