Tsukuyomi OpenID
0.2.0

jp.sourceforge.tsukuyomi.openid.message
クラス AssociationResponse

java.lang.Object
  上位を拡張 jp.sourceforge.tsukuyomi.openid.message.Message
      上位を拡張 jp.sourceforge.tsukuyomi.openid.message.AssociationResponse

public class AssociationResponse
extends Message

The OpenID Association Response message.

Handles OpenID 2.0 and OpenID 1.x messages.

作成者:
Marius Scurtescu, Johnny Bufu
関連項目:
AssociationSessionType

フィールドの概要
protected static List<String> OPTIONAL_FIELDS
           
protected static List<String> REQUIRED_FIELDS
           
 
クラス jp.sourceforge.tsukuyomi.openid.message.Message から継承されたフィールド
destinationUrl, MODE_CANCEL, MODE_IDRES, MODE_SETUP_NEEDED, OPENID2_NS
 
コンストラクタの概要
protected AssociationResponse(AssociationRequest assocReq, Association assoc)
          Constructs an AssociationResponse for a given association request.
protected AssociationResponse(ParameterList params)
          Constructs an AssociationResponse message from a parameter list.
 
メソッドの概要
static AssociationResponse createAssociationResponse(AssociationRequest assocReq, Association assoc)
           
static AssociationResponse createAssociationResponse(ParameterList params)
           
 Association getAssociation(DiffieHellmanSession dhSess)
          Generates an Association object from an Association Response.
 List<String> getRequiredFields()
           
 AssociationSessionType getType()
          Gets the association / session type of the association response.
 boolean isValid()
          Checks if the message is a valid OpenID Association Response..
 boolean isVersion2()
          Returns true for OpenID 2.0 messages, false otherwise.
 void setAssocHandle(String handle)
          Sets the handle of the association.
 void setExpire(Long seconds)
          Sets the lifetime, in seconds, of the association.
 void setMacKey(String key)
          Sets the unecrtypted MAC key of the association.
 void setMacKeyEnc(String key)
          Sets the encrypted MAC key of the association.
 void setPublicKey(String key)
          Sets the IdP's (server's) public key for the association.
 void setType(AssociationSessionType type)
          Sets the association / session type for the association response.
 
クラス jp.sourceforge.tsukuyomi.openid.message.Message から継承されたメソッド
addExtension, addExtensionFactory, createMessage, createMessage, getDestinationUrl, getExtension, getExtensionAlias, getExtensionFactory, getExtensions, getParameter, getParameterMap, getParameters, getParameterValue, hasExtension, hasExtensionFactory, hasParameter, keyValueFormEncoding, set, wwwFormEncoding
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

REQUIRED_FIELDS

protected static final List<String> REQUIRED_FIELDS

OPTIONAL_FIELDS

protected static final List<String> OPTIONAL_FIELDS
コンストラクタの詳細

AssociationResponse

protected AssociationResponse(AssociationRequest assocReq,
                              Association assoc)
                       throws AssociationException
Constructs an AssociationResponse for a given association request.

パラメータ:
assocReq - The association request that needs to be responded.
assoc - The association which will be used to sign authentication responses.
例外:
AssociationException

AssociationResponse

protected AssociationResponse(ParameterList params)
Constructs an AssociationResponse message from a parameter list.

Useful for processing incoming messages.

メソッドの詳細

createAssociationResponse

public static AssociationResponse createAssociationResponse(AssociationRequest assocReq,
                                                            Association assoc)
                                                     throws MessageException,
                                                            AssociationException
例外:
MessageException
AssociationException

createAssociationResponse

public static AssociationResponse createAssociationResponse(ParameterList params)
                                                     throws MessageException
例外:
MessageException

getRequiredFields

public List<String> getRequiredFields()
オーバーライド:
クラス Message 内の getRequiredFields

isVersion2

public boolean isVersion2()
Returns true for OpenID 2.0 messages, false otherwise.


setType

public void setType(AssociationSessionType type)
Sets the association / session type for the association response.


getType

public AssociationSessionType getType()
                               throws AssociationException
Gets the association / session type of the association response.

例外:
AssociationException

setAssocHandle

public void setAssocHandle(String handle)
Sets the handle of the association.


setExpire

public void setExpire(Long seconds)
Sets the lifetime, in seconds, of the association.


setMacKey

public void setMacKey(String key)
Sets the unecrtypted MAC key of the association.

Should be called only for association responses using no-encryption sessions.

パラメータ:
key - The unencrypted MAC key.

setPublicKey

public void setPublicKey(String key)
Sets the IdP's (server's) public key for the association.

パラメータ:
key - The server's public key for the association.

setMacKeyEnc

public void setMacKeyEnc(String key)
Sets the encrypted MAC key of the association.

Should be called only for association responses using Diffie-Hellman sessions.

パラメータ:
key - The encrypted MAC key.

isValid

public boolean isValid()
Checks if the message is a valid OpenID Association Response..

オーバーライド:
クラス Message 内の isValid
戻り値:
True if all validation checkes passed, false otherwise.

getAssociation

public Association getAssociation(DiffieHellmanSession dhSess)
                           throws AssociationException
Generates an Association object from an Association Response.

パラメータ:
dhSess - The Diffie-Helman session containing the private key used to encrypt / decrypt the MAC key exchange. Should be null for no-encryption sessions.
例外:
AssociationException

Tsukuyomi OpenID
0.2.0

Copyright © 2008 Project Tsukuyomi. All Rights Reserved.