Tsukuyomi OpenID
0.2.0

jp.sourceforge.tsukuyomi.openid.message.pape
クラス PapeRequest

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

public class PapeRequest
extends PapeMessage

Implements the extension for OpenID Provider Authentication Policy requests.

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

フィールドの概要
protected static List<String> PAPE_FIELDS
           
 
クラス jp.sourceforge.tsukuyomi.openid.message.pape.PapeMessage から継承されたフィールド
OPENID_NS_PAPE, PAPE_POLICY_MULTI_FACTOR, PAPE_POLICY_MULTI_FACTOR_PHYSICAL, PAPE_POLICY_PHISHING_RESISTANT, parameters
 
コンストラクタの概要
protected PapeRequest()
          Constructs a Pape Request with an empty parameter list.
protected PapeRequest(ParameterList params)
          Constructs a PapeRequest from a parameter list.
 
メソッドの概要
 void addPreferredAuthPolicy(String policyUri)
          Adds an authentication policy URI to the preferred_auth_policies parameter.
static PapeRequest createPapeRequest()
          Constructs a Pape Request with an empty parameter list.
static PapeRequest createPapeRequest(ParameterList params)
          Constructs a PapeRequest from a parameter list.
 int getMaxAuthAge()
          Gets the max_auth_age parameter.
 String getPreferredAuthPolicies()
          Gets the preferred_auth_policies parameter value.
 List<String> getPreferredAuthPoliciesList()
          Gets a list with the preferred_auth_policies.
 boolean isValid()
          Checks the validity of the extension.
 void setMaxAuthAge(int seconds)
          Sets the max_auth_age parameter.
 void setPreferredAuthPolicies(String policyUris)
          Sets a new value for the preferred_auth_policies parameter.
 
クラス jp.sourceforge.tsukuyomi.openid.message.pape.PapeMessage から継承されたメソッド
getExtension, getParameter, getParameters, getParameterValue, getTypeUri, hasParameter, providesIdentifier, set, setParameters
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

PAPE_FIELDS

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

PapeRequest

protected PapeRequest()
Constructs a Pape Request with an empty parameter list.


PapeRequest

protected PapeRequest(ParameterList params)
Constructs a PapeRequest 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.

メソッドの詳細

createPapeRequest

public static PapeRequest createPapeRequest()
Constructs a Pape Request with an empty parameter list.


createPapeRequest

public static PapeRequest createPapeRequest(ParameterList params)
                                     throws MessageException
Constructs a PapeRequest 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

getPreferredAuthPolicies

public String getPreferredAuthPolicies()
Gets the preferred_auth_policies parameter value.


setPreferredAuthPolicies

public void setPreferredAuthPolicies(String policyUris)
Sets a new value for the preferred_auth_policies parameter. The previous value of the parameter will be owerwritten.

パラメータ:
policyUris - Space separated list of authentication policy URIs to be set.
関連項目:
addPreferredAuthPolicy(String)

addPreferredAuthPolicy

public void addPreferredAuthPolicy(String policyUri)
Adds an authentication policy URI to the preferred_auth_policies parameter.

パラメータ:
policyUri - The authentication policy URI to be set.
関連項目:
setPreferredAuthPolicies(String)

getPreferredAuthPoliciesList

public List<String> getPreferredAuthPoliciesList()
Gets a list with the preferred_auth_policies. An empty list is returned if no authentication policies exist.


setMaxAuthAge

public void setMaxAuthAge(int seconds)
Sets the max_auth_age parameter.

パラメータ:
seconds - The number of seconds within which the OP is requested to have actively authenticated the user.

getMaxAuthAge

public int getMaxAuthAge()
Gets the max_auth_age parameter.

戻り値:
The number of seconds within which the OP is requested to have actively authenticated the user, or -1 if max_auth_age is not present in the request.

isValid

public boolean isValid()
Checks the validity of the extension.

Used when constructing a extension from a parameter list.

戻り値:
True if the extension is valid, false otherwise.

Tsukuyomi OpenID
0.2.0

Copyright © 2008 Project Tsukuyomi. All Rights Reserved.