Status (OpenSSO Public API)

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.sun.identity.saml2.protocol
インタフェース Status

public interface Status

This class represents the StatusType complex type in SAML protocol schema.

 <complexType name="StatusType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusCode"/>
         <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusMessage" minOccurs="0"/>
         <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusDetail" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

メソッドの概要
`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 true if the object is mutable, false otherwise
`void`	`makeImmutable()` Makes the obejct 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.

メソッドの詳細

getStatusCode

StatusCode getStatusCode()

Returns the value of the statusCode property.

戻り値:: the value of the statusCode property
関連項目:: Status.setStatusCode(StatusCode)

setStatusCode

void setStatusCode(StatusCode value)
                   throws SAML2Exception

Sets the value of the statusCode property.

パラメータ:: value - the value of the statusCode property to be set
例外:: SAML2Exception - if the object is immutable
関連項目:: Status.getStatusCode()

getStatusMessage

String getStatusMessage()

Returns the value of the statusMessage property.

戻り値:: the value of the statusMessage property
関連項目:: Status.setStatusMessage(String)

setStatusMessage

void setStatusMessage(String value)
                      throws SAML2Exception

Sets the value of the statusMessage property.

パラメータ:: value - the value of the statusMessage property to be set
例外:: SAML2Exception - if the object is immutable
関連項目:: Status.getStatusMessage()

getStatusDetail

StatusDetail getStatusDetail()

Returns the value of the statusDetail property.

戻り値:: the value of the statusDetail property
関連項目:: Status.setStatusDetail(StatusDetail)

setStatusDetail

void setStatusDetail(StatusDetail value)
                     throws SAML2Exception

Sets the value of the statusDetail property.

パラメータ:: value - the value of the statusDetail property to be set
例外:: SAML2Exception - if the object is immutable
関連項目:: Status.getStatusDetail()

toXMLString

String toXMLString()
                   throws SAML2Exception

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

戻り値:: An XML String representing the Status.
例外:: SAML2Exception - if some error occurs during conversion to String.

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
                   throws SAML2Exception

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

パラメータ:: 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.
戻り値:: A XML String representing the Status.
例外:: SAML2Exception - if some error occurs during conversion to String.