Tsukuyomi OpenID
0.2.0

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

java.lang.Object
  上位を拡張 jp.sourceforge.tsukuyomi.openid.message.Message
直系の既知のサブクラス:
AssociationRequest, AssociationResponse, AuthFailure, AuthImmediateFailure, AuthRequest, AuthSuccess, DirectError, VerifyResponse

public class Message
extends Object

作成者:
Marius Scurtescu, Johnny Bufu

フィールドの概要
protected  String destinationUrl
           
static String MODE_CANCEL
           
static String MODE_IDRES
           
static String MODE_SETUP_NEEDED
           
static String OPENID2_NS
           
 
コンストラクタの概要
protected Message()
           
protected Message(ParameterList params)
           
 
メソッドの概要
 void addExtension(MessageExtension extension)
          Adds a set of extension-specific parameters to a message.
static void addExtensionFactory(Class<? extends MessageExtensionFactory> clazz)
          Adds a new extension factory.
static Message createMessage()
           
static Message createMessage(ParameterList params)
           
 String getDestinationUrl(boolean httpGet)
          Gets the URL where the message should be sent, where applicable.
 MessageExtension getExtension(String typeUri)
          Gets a MessageExtension for the specified Type URI if an implementation is available, or null otherwise.
 String getExtensionAlias(String extensionTypeUri)
          Retrieves the extension alias that will be used for the extension identified by the supplied extension type URI.
static MessageExtensionFactory getExtensionFactory(String typeUri)
          Gets a MessageExtensionFactory for the specified Type URI if an implementation is available, or null otherwise.
 Set<String> getExtensions()
          Gets a set of extension Type URIs that are present in the message.
protected  Parameter getParameter(String name)
           
 Map<String,String> getParameterMap()
           
protected  List<Parameter> getParameters()
           
 String getParameterValue(String name)
           
 List<String> getRequiredFields()
           
 boolean hasExtension(String typeUri)
          Returns true if the message has parameters for the specified extension type URI.
static boolean hasExtensionFactory(String typeUri)
          Returns true if there is an extension factory available for extension identified by the specified Type URI, or false otherwise.
 boolean hasParameter(String name)
           
 boolean isValid()
          Check that all required parameters are present
 String keyValueFormEncoding()
           
protected  void set(String name, String value)
           
 String wwwFormEncoding()
           
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

MODE_IDRES

public static final String MODE_IDRES
関連項目:
定数フィールド値

MODE_CANCEL

public static final String MODE_CANCEL
関連項目:
定数フィールド値

MODE_SETUP_NEEDED

public static final String MODE_SETUP_NEEDED
関連項目:
定数フィールド値

OPENID2_NS

public static final String OPENID2_NS
関連項目:
定数フィールド値

destinationUrl

protected String destinationUrl
コンストラクタの詳細

Message

protected Message()

Message

protected Message(ParameterList params)
メソッドの詳細

createMessage

public static Message createMessage()
                             throws MessageException
例外:
MessageException

createMessage

public static Message createMessage(ParameterList params)
                             throws MessageException
例外:
MessageException

getParameter

protected Parameter getParameter(String name)

getParameterValue

public String getParameterValue(String name)

hasParameter

public boolean hasParameter(String name)

set

protected void set(String name,
                   String value)

getParameters

protected List<Parameter> getParameters()

getParameterMap

public Map<String,String> getParameterMap()

isValid

public boolean isValid()
Check that all required parameters are present


getRequiredFields

public List<String> getRequiredFields()

keyValueFormEncoding

public String keyValueFormEncoding()

wwwFormEncoding

public String wwwFormEncoding()

getDestinationUrl

public String getDestinationUrl(boolean httpGet)
Gets the URL where the message should be sent, where applicable. Null for received messages.

パラメータ:
httpGet - If true, the wwwFormEncoding() is appended to the destination URL; the return value should be used with a GET-redirect. If false, the verbatim destination URL is returned, which should be used with a FORM POST redirect.
関連項目:
wwwFormEncoding()

addExtensionFactory

public static void addExtensionFactory(Class<? extends MessageExtensionFactory> clazz)
                                throws MessageException
Adds a new extension factory.

パラメータ:
clazz - The implementation class for the extension factory, must implement MessageExtensionFactory.
例外:
MessageException

hasExtensionFactory

public static boolean hasExtensionFactory(String typeUri)
Returns true if there is an extension factory available for extension identified by the specified Type URI, or false otherwise.

パラメータ:
typeUri - The Type URI that identifies an extension.

getExtensionFactory

public static MessageExtensionFactory getExtensionFactory(String typeUri)
Gets a MessageExtensionFactory for the specified Type URI if an implementation is available, or null otherwise.

パラメータ:
typeUri - The Type URI that identifies a extension.
関連項目:
Message

hasExtension

public boolean hasExtension(String typeUri)
Returns true if the message has parameters for the specified extension type URI.

パラメータ:
typeUri - The URI that identifies the extension.

getExtensions

public Set<String> getExtensions()
Gets a set of extension Type URIs that are present in the message.


getExtensionAlias

public String getExtensionAlias(String extensionTypeUri)
Retrieves the extension alias that will be used for the extension identified by the supplied extension type URI.

If the message contains no parameters for the specified extension, null will be returned.

パラメータ:
extensionTypeUri - The URI that identifies the extension
戻り値:
The extension alias associated with the extension specifid by the Type URI

addExtension

public void addExtension(MessageExtension extension)
                  throws MessageException
Adds a set of extension-specific parameters to a message.

The parameter names must NOT contain the "openid." prefix; it will be generated dynamically, ensuring there are no conflicts between extensions.

パラメータ:
extension - A MessageExtension containing parameters to be added to the message
例外:
MessageException

getExtension

public MessageExtension getExtension(String typeUri)
                              throws MessageException
Gets a MessageExtension for the specified Type URI if an implementation is available, or null otherwise.

The returned object will contain the parameters from the message belonging to the specified extension.

パラメータ:
typeUri - The Type URI that identifies a extension.
例外:
MessageException

Tsukuyomi OpenID
0.2.0

Copyright © 2008 Project Tsukuyomi. All Rights Reserved.