gluu
公開メンバ関数 | 静的公開メンバ関数 | 公開変数類 | 非公開メンバ関数 | 非公開変数類 | 静的非公開変数類 | 全メンバ一覧
列挙 org.xdi.oxauth.model.common.ResponseType 詳解
org.xdi.oxauth.model.common.ResponseType の継承関係図
Inheritance graph
org.xdi.oxauth.model.common.ResponseType 連携図
Collaboration graph

公開メンバ関数

String getParamName ()
 
String getDisplayName ()
 
String getValue ()
 
Enum<? extends LdapEnum > resolveByValue (String value)
 
String toString ()
 
 __construct ($parameter="")
 
 getParamName ()
 
 toString ()
 

静的公開メンバ関数

 [static initializer]
 
static ResponseType fromString (String param)
 
static List< ResponseTypefromString (String paramList, String separator)
 
static boolean isImplicitFlow (String responseTypes)
 
static String [] toStringArray (ResponseType[] responseTypes)
 
static ResponseType getByValue (String value)
 
static values ()
 

公開変数類

 CODE =("code", "Authorization Code Grant Type")
 
 TOKEN =("token", "Implicit Grant Type")
 
 ID_TOKEN =("id_token", "ID Token")
 
const CODE = "code"
 
const TOKEN = "token"
 
const ID_TOKEN = "id_token"
 

非公開メンバ関数

 ResponseType (String value, String displayName)
 

非公開変数類

final String value
 
final String displayName
 
 $paramName
 

静的非公開変数類

static Map< String, ResponseTypemapByValues = new HashMap<String, ResponseType>()
 

詳解

This class allows to enumerate and identify the possible values of the parameter response_type for the authorization endpoint.

The client informs the authorization server of the desired grant type.

The authorization endpoint is used by the authorization code grant type and implicit grant type flows.

著者
Javier Rojas Blum
バージョン
July 18, 2017

This class allows to enumerate and identify the possible values of the parameter response_type for the authorization endpoint.

The client informs the authorization server of the desired grant type.

The authorization endpoint is used by the authorization code grant type and implicit grant type flows.

著者
Gabin Dongmo Date: 29/03/2013

構築子と解体子

◆ ResponseType()

org.xdi.oxauth.model.common.ResponseType.ResponseType ( String  value,
String  displayName 
)
inlineprivate
60  {
61  this.value = value;
62  this.displayName = displayName;
63  }
final String displayName
Definition: ResponseType.java:50
final String value
Definition: ResponseType.java:49

◆ __construct()

org.xdi.oxauth.model.common.ResponseType.__construct (   $parameter = "")

The constructor sets the parameter

引数
StringParameter
44  {
45  $this->paramName = $parameter;
46  }

関数詳解

◆ [static initializer]()

org.xdi.oxauth.model.common.ResponseType.[static initializer] ( )
inlinestatic

◆ fromString() [1/2]

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

Returns the corresponding ResponseType for a single parameter response_type.

引数
paramThe response_type parameter.
戻り値
The corresponding response type if found, otherwise null.
72  {
73  return getByValue(param);
74  }
static ResponseType getByValue(String value)
Definition: ResponseType.java:143

◆ fromString() [2/2]

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

Returns a list of the corresponding ResponseType from a space-separated list of response_type parameters.

引数
paramListA space-separated list of response_type parameters.
separatorThe separator of the string list.
戻り値
A list of the recognized response types.
107  {
108  List<ResponseType> responseTypes = new ArrayList<ResponseType>();
109 
110  if (paramList != null && !paramList.isEmpty()) {
111  String[] params = paramList.split(separator);
112  for (String param : params) {
113  for (ResponseType rt : ResponseType.values()) {
114  if (param.equals(rt.value)) {
115  if (!responseTypes.contains(rt)) {
116  responseTypes.add(rt);
117  }
118  }
119  }
120  }
121  }
122 
123  return responseTypes;
124  }
ResponseType(String value, String displayName)
Definition: ResponseType.java:60

◆ getByValue()

static ResponseType org.xdi.oxauth.model.common.ResponseType.getByValue ( String  value)
inlinestatic
143  {
144  return mapByValues.get(value);
145  }
static Map< String, ResponseType > mapByValues
Definition: ResponseType.java:52
final String value
Definition: ResponseType.java:49

◆ getDisplayName()

String org.xdi.oxauth.model.common.ResponseType.getDisplayName ( )
inline

Gets display name

戻り値
display name name
90  {
91  return displayName;
92  }
final String displayName
Definition: ResponseType.java:50

◆ getParamName() [1/2]

org.xdi.oxauth.model.common.ResponseType.getParamName ( )

Gets the parameter name entered

戻り値
String Parameter

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

52  {
53  return $this->paramName;
54  }
$paramName
Definition: ResponseType.php:38

◆ getParamName() [2/2]

String org.xdi.oxauth.model.common.ResponseType.getParamName ( )
inline

Gets param name.

戻り値
param name

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

81  {
82  return value;
83  }
final String value
Definition: ResponseType.java:49

◆ getValue()

String org.xdi.oxauth.model.common.ResponseType.getValue ( )
inline
95  {
96  return value;
97  }
final String value
Definition: ResponseType.java:49

◆ isImplicitFlow()

static boolean org.xdi.oxauth.model.common.ResponseType.isImplicitFlow ( String  responseTypes)
inlinestatic
126  {
127  return !responseTypes.contains("code") && (responseTypes.contains("id_token") || responseTypes.contains("token"));
128  }

◆ resolveByValue()

Enum<? extends LdapEnum> org.xdi.oxauth.model.common.ResponseType.resolveByValue ( String  value)
inline
147  {
148  return getByValue(value);
149  }
static ResponseType getByValue(String value)
Definition: ResponseType.java:143
final String value
Definition: ResponseType.java:49

◆ toString() [1/2]

org.xdi.oxauth.model.common.ResponseType.toString ( )

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

戻り値
String Parameter name
62  {
63  return $this->paramName;
64  }
$paramName
Definition: ResponseType.php:38

◆ toString() [2/2]

String org.xdi.oxauth.model.common.ResponseType.toString ( )
inline

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

157  {
158  return value;
159  }
final String value
Definition: ResponseType.java:49

◆ toStringArray()

static String [] org.xdi.oxauth.model.common.ResponseType.toStringArray ( ResponseType []  responseTypes)
inlinestatic
130  {
131  if (responseTypes == null) {
132  return null;
133  }
134 
135  String[] resultResponseTypes = new String[responseTypes.length];
136  for (int i = 0; i < responseTypes.length; i++) {
137  resultResponseTypes[i] = responseTypes[i].getValue();
138  }
139 
140  return resultResponseTypes;
141  }

◆ values()

static org.xdi.oxauth.model.common.ResponseType.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 (ResponseType::values() as $value) {

return $value;

}

戻り値
Array An array containing the constants of this enum type, in the order they are declared
82  {
83  return new \ArrayIterator(
84  array(
88  )
89  );
90  }
ID_TOKEN
Definition: ResponseType.java:47
CODE
Definition: ResponseType.java:39
TOKEN
Definition: ResponseType.java:43

メンバ詳解

◆ $paramName

org.xdi.oxauth.model.common.ResponseType.$paramName
private

◆ CODE [1/2]

const org.xdi.oxauth.model.common.ResponseType.CODE = "code"

Used for the authorization code grant type.

◆ CODE [2/2]

org.xdi.oxauth.model.common.ResponseType.CODE =("code", "Authorization Code Grant Type")

Used for the authorization code grant type.

◆ displayName

final String org.xdi.oxauth.model.common.ResponseType.displayName
private

◆ ID_TOKEN [1/2]

const org.xdi.oxauth.model.common.ResponseType.ID_TOKEN = "id_token"

Include an ID Token in the authorization response.

◆ ID_TOKEN [2/2]

org.xdi.oxauth.model.common.ResponseType.ID_TOKEN =("id_token", "ID Token")

Include an ID Token in the authorization response.

◆ mapByValues

static Map<String, ResponseType> org.xdi.oxauth.model.common.ResponseType.mapByValues = new HashMap<String, ResponseType>()
staticprivate

◆ TOKEN [1/2]

const org.xdi.oxauth.model.common.ResponseType.TOKEN = "token"

Used for the implicit grant type.

◆ TOKEN [2/2]

org.xdi.oxauth.model.common.ResponseType.TOKEN =("token", "Implicit Grant Type")

Used for the implicit grant type.

◆ value

final String org.xdi.oxauth.model.common.ResponseType.value
private

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