Tsukuyomi OpenID
0.2.0

jp.sourceforge.tsukuyomi.openid.message.ax
クラス StoreResponse

java.lang.Object
  上位を拡張 jp.sourceforge.tsukuyomi.openid.message.ax.AxMessage
      上位を拡張 jp.sourceforge.tsukuyomi.openid.message.ax.StoreResponse
すべての実装されたインタフェース:
MessageExtension, MessageExtensionFactory

public class StoreResponse
extends AxMessage

Implements the extension for Attribute Exchange store responses.

作成者:
Marius Scurtescu, Johnny Bufu

フィールドの概要
 
クラス jp.sourceforge.tsukuyomi.openid.message.ax.AxMessage から継承されたフィールド
OPENID_NS_AX, parameters
 
コンストラクタの概要
protected StoreResponse()
          Constructs a Store Response with an empty parameter list.
protected StoreResponse(ParameterList params)
          Constructs a StoreResponse from a parameter list.
 
メソッドの概要
static StoreResponse createStoreResponse()
          Constructs a Store Response with an empty parameter list.
static StoreResponse createStoreResponse(ParameterList params)
          Constructs a StoreResponse from a parameter list.
 String getStatus()
          Gets the status of the Store Response if the 'status' parameter is part of the response, or null otherwise.
 String getStatusDescription()
          Gets the status of the Store Response if the 'status.description' parameter is part of the response, or null otherwise.
 boolean hasFailed()
          Returns true if the Store Response is a failure message, true if it is a success response.
protected  void setFailure(String description)
          Marks the Store Response as a failure, by setting the appropirate parameters.
 
クラス jp.sourceforge.tsukuyomi.openid.message.ax.AxMessage から継承されたメソッド
getExtension, getParameters, getParameterValue, getTypeUri, multivalDecode, multivalEncode, providesIdentifier, setParameters
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

StoreResponse

protected StoreResponse()
Constructs a Store Response with an empty parameter list.


StoreResponse

protected StoreResponse(ParameterList params)
Constructs a StoreResponse from a parameter list.

The parameter list can be extracted from a received message with the getExtensionParams method of the Message class, and MUST NOT contain the "openid.." prefix.

メソッドの詳細

createStoreResponse

public static StoreResponse createStoreResponse()
Constructs a Store Response with an empty parameter list.


createStoreResponse

public static StoreResponse createStoreResponse(ParameterList params)
                                         throws MessageException
Constructs a StoreResponse from a parameter list.

The parameter list can be extracted from a received message with the getExtensionParams method of the Message class, and MUST NOT contain the "openid.." prefix.

例外:
MessageException

setFailure

protected void setFailure(String description)
Marks the Store Response as a failure, by setting the appropirate parameters.

パラメータ:
description - Describes the error condition leading to the failure response

hasFailed

public boolean hasFailed()
Returns true if the Store Response is a failure message, true if it is a success response.


getStatus

public String getStatus()
Gets the status of the Store Response if the 'status' parameter is part of the response, or null otherwise.


getStatusDescription

public String getStatusDescription()
Gets the status of the Store Response if the 'status.description' parameter is part of the response, or null otherwise.


Tsukuyomi OpenID
0.2.0

Copyright © 2008 Project Tsukuyomi. All Rights Reserved.