列挙 org.xdi.oxauth.model.common.Prompt 詳解

org.xdi.oxauth.model.common.Prompt の継承関係図

org.xdi.oxauth.model.common.Prompt 連携図

公開メンバ関数
String	getParamName ()
String	toString ()
	__construct ($parameter="")
	getParamName ()
	toString ()

静的公開メンバ関数
static Prompt	fromString (String param)
static List< Prompt >	fromString (String paramList, String separator)
static	values ()

公開変数類
	NONE =("none")
	LOGIN =("login")
	CONSENT =("consent")
	SELECT_ACCOUNT =("select_account")
const	NONE = "none"
const	LOGIN = "login"
const	CONSENT = "consent"
const	SELECT_ACCOUNT = "select_account"

非公開メンバ関数
	Prompt (String paramName)

非公開変数類
final String	paramName
	$paramName

詳解

An ASCII string values that specifies whether the Authorization Server prompts the End-User for re-authentication and consent.

著者

Javier Rojas Blum Date: 02.10.2012

An ASCII string values that specifies whether the Authorization Server prompts the End-User for re-authentication and consent.

著者

Gabin Dongmo Date: 29/03/2013

構築子と解体子

Prompt()

org.xdi.oxauth.model.common.Prompt.Prompt ( String  paramName )

inlineprivate

                                     {
        this.paramName = paramName;
    }

__construct()

org.xdi.oxauth.model.common.Prompt.__construct

(

$parameter = ""

)

The constructor sets the parameter name

引数

String

Parameter

                                                 {
        $this->paramName = $parameter;
    }

関数詳解

fromString() [1/2]

static Prompt org.xdi.oxauth.model.common.Prompt.fromString ( String  param )

inlinestatic

Returns the corresponding Prompt for a parameter prompt of the authorization endpoint.

引数

param

The parameter.

戻り値

The corresponding response type if found, otherwise null.

                                                  {
        if (param != null) {
            for (Prompt rt : Prompt.values()) {
                if (param.equals(rt.paramName)) {
                    return rt;
                }
            }
        }
        return null;
    }

fromString() [2/2]

static List<Prompt> org.xdi.oxauth.model.common.Prompt.fromString ( String  paramList, String  separator  )

inlinestatic

Returns a list of the corresponding Prompt from a space-separated list of prompt parameters.

引数

paramList	A space-separated list of prompt parameters.
separator	The separator of the string list.

戻り値

A list of the recognized response types.

                                                                              {
        List<Prompt> prompts = new ArrayList<Prompt>();

        if (paramList != null && !paramList.isEmpty()) {
            String[] params = paramList.split(separator);
            for (String param : params) {
                for (Prompt p : Prompt.values()) {
                    if (param.equals(p.paramName)) {
                        if (!prompts.contains(p)) {
                            prompts.add(p);
                        }
                    }
                }
            }
        }

        return prompts;
    }

getParamName() [1/2]

org.xdi.oxauth.model.common.Prompt.getParamName

(

)

Gets the parameter name entered

戻り値

String Parameter name

org.xdi.oxauth.model.common.HasParamNameを実装しています。

                                   {
        return $this->paramName;
    }

getParamName() [2/2]

String org.xdi.oxauth.model.common.Prompt.getParamName ( )

inline

Gets param name.

戻り値

param name

org.xdi.oxauth.model.common.HasParamNameを実装しています。

                                 {
        return paramName;
    }

toString() [1/2]

org.xdi.oxauth.model.common.Prompt.toString

(

)

Returns a string representation of the object. In this case the parameter name.

戻り値

String Parameter name

                              {
        return $this->paramName;
    }

toString() [2/2]

String org.xdi.oxauth.model.common.Prompt.toString ( )

inline

Returns a string representation of the object. In this case the parameter name.

                             {
        return paramName;
    }

values()

static org.xdi.oxauth.model.common.Prompt.values ( )

static

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

foreach (Prompt::values() as $value) {

return $value;

}

戻り値

Array An array containing the constants of this enum type, in the order they are declared

                                   {
            return new \ArrayIterator(
                        array(
                            Prompt::CONSENT,
                            Prompt::LOGIN,
                            Prompt::NONE,
                            Prompt::SELECT_ACCOUNT
                        )
                    );
    }

メンバ詳解

$paramName

org.xdi.oxauth.model.common.Prompt.$paramName

private

CONSENT [1/2]

const org.xdi.oxauth.model.common.Prompt.CONSENT = "consent"

The Authorization Server MUST prompt the End-User for consent before returning information to the Client.

CONSENT [2/2]

org.xdi.oxauth.model.common.Prompt.CONSENT =("consent")

The Authorization Server MUST prompt the End-User for consent before returning information to the Client.

LOGIN [1/2]

const org.xdi.oxauth.model.common.Prompt.LOGIN = "login"

The Authorization Server MUST prompt the End-User for re-authentication

LOGIN [2/2]

org.xdi.oxauth.model.common.Prompt.LOGIN =("login")

The Authorization Server MUST prompt the End-User for re-authentication

NONE [1/2]

const org.xdi.oxauth.model.common.Prompt.NONE = "none"

The Authorization Server MUST NOT display any authentication or consent user interface pages. An error is returned if the End-User is not already authenticated or the Client does not have pre-configured consent for the requested scopes. This can be used as a method to check for existing authentication and/or consent.

NONE [2/2]

org.xdi.oxauth.model.common.Prompt.NONE =("none")

The Authorization Server MUST NOT display any authentication or consent user interface pages. An error is returned if the End-User is not already authenticated or the Client does not have pre-configured consent for the requested scopes. This can be used as a method to check for existing authentication and/or consent.

paramName

final String org.xdi.oxauth.model.common.Prompt.paramName

private

SELECT_ACCOUNT [1/2]

const org.xdi.oxauth.model.common.Prompt.SELECT_ACCOUNT = "select_account"

The Authorization Server MUST prompt the End-User to select a user account. This allows a user who has multiple accounts at the Authorization Server to select amongst the multiple accounts that they may have current sessions for.

SELECT_ACCOUNT [2/2]

org.xdi.oxauth.model.common.Prompt.SELECT_ACCOUNT =("select_account")

The Authorization Server MUST prompt the End-User to select a user account. This allows a user who has multiple accounts at the Authorization Server to select amongst the multiple accounts that they may have current sessions for.

---

次のファイルからこの列挙についての詳解を抽出しました:

• D:/AppData/OpenId/gluu/src/oxAuth/Model/src/main/java/org/xdi/oxauth/model/common/Prompt.java
• D:/AppData/OpenId/gluu/src/oxAuth/Model/src/main/php/org/xdi/oxauth/model/common/Prompt.php