LogoutRequest (OpenSSO Public API)

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

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

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

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

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

すべてのスーパーインタフェース:: RequestAbstract

public interface LogoutRequest
extends RequestAbstract
extends RequestAbstract

This class represents the LogoutRequest element in SAML protocol schema. A session participant or session authority sends a LogoutRequest message to indicate that a session has been terminated.

 <element name="LogoutRequest" type="{urn:oasis:names:tc:SAML:2.0:protocol}LogoutRequestType"/>

 <complexType name="LogoutRequestType">
   <complexContent>
     <extension base="{urn:oasis:names:tc:SAML:2.0:protocol}RequestAbstractType">
       <sequence>
         <choice>
           <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}BaseID"/>
           <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}NameID"/>
           <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}EncryptedID"/>
         </choice>
         <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}SessionIndex" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="NotOnOrAfter" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
       <attribute name="Reason" type="{http://www.w3.org/2001/XMLSchema}string" />
     </extension>
   </complexContent>
 </complexType>

メソッドの概要
`BaseID`	`getBaseID()` Returns the value of the baseID property.
`EncryptedID`	`getEncryptedID()` Returns the value of the encryptedID property.
`NameID`	`getNameID()` Returns the value of the nameID property.
`Date`	`getNotOnOrAfter()` Returns the value of the notOnOrAfter property.
`String`	`getReason()` Returns the value of the reason property.
`List`	`getSessionIndex()` Returns the value of the SessionIndex property.
`void`	`setBaseID(BaseID value)` Sets the value of the baseID property.
`void`	`setEncryptedID(EncryptedID value)` Sets the value of the encryptedID property.
`void`	`setNameID(NameID value)` Sets the value of the nameID property.
`void`	`setNotOnOrAfter(Date value)` Sets the value of the notOnOrAfter property.
`void`	`setReason(String value)` Sets the value of the reason property.
`void`	`setSessionIndex(List sessionIndexList)` Sets the value of the SessionIndex property.

インタフェース com.sun.identity.saml2.protocol.RequestAbstract から継承されたメソッド
`getConsent, getDestination, getExtensions, getID, getIssueInstant, getIssuer, getSignature, getVersion, isMutable, isSignatureValid, isSigned, makeImmutable, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion, sign, toXMLString, toXMLString`

メソッドの詳細

getNotOnOrAfter

Date getNotOnOrAfter()

Returns the value of the notOnOrAfter property.

戻り値:: java.util.Date value of the notOnOrAfter property
関連項目:: LogoutRequest.setNotOnOrAfter(Date)

setNotOnOrAfter

void setNotOnOrAfter(Date value)
                     throws SAML2Exception

Sets the value of the notOnOrAfter property.

パラメータ:: value - java.util.Date value of the notOnOrAfter property to be set
例外:: SAML2Exception - if the object is immutable
関連項目:: LogoutRequest.getNotOnOrAfter()

getReason

String getReason()

Returns the value of the reason property.

戻り値:: String value of the reason property
関連項目:: LogoutRequest.setReason(String)

setReason

void setReason(String value)
               throws SAML2Exception

Sets the value of the reason property.

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

getEncryptedID

EncryptedID getEncryptedID()

Returns the value of the encryptedID property.

戻り値:: the value of the encryptedID property
関連項目:: LogoutRequest.setEncryptedID(EncryptedID)

setEncryptedID

void setEncryptedID(EncryptedID value)
                    throws SAML2Exception

Sets the value of the encryptedID property.

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

getNameID

NameID getNameID()

Returns the value of the nameID property.

戻り値:: the value of the nameID property
関連項目:: LogoutRequest.setNameID(NameID)

setNameID

void setNameID(NameID value)
               throws SAML2Exception

Sets the value of the nameID property.

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

getBaseID

BaseID getBaseID()

Returns the value of the baseID property.

戻り値:: the value of the baseID property
関連項目:: LogoutRequest.setBaseID(BaseID)

setBaseID

void setBaseID(BaseID value)
               throws SAML2Exception

Sets the value of the baseID property.

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

getSessionIndex

List getSessionIndex()

Returns the value of the SessionIndex property.

戻り値:: list containing objects of type java.lang.String
関連項目:: LogoutRequest.setSessionIndex(List)

setSessionIndex

void setSessionIndex(List sessionIndexList)
                     throws SAML2Exception

Sets the value of the SessionIndex property.

パラメータ:: sessionIndexList - list containing objects of type java.lang.String
例外:: SAML2Exception - if the object is immutable
関連項目:: LogoutRequest.getSessionIndex()