gluu
公開メンバ関数 | 非公開変数類 | 全メンバ一覧
org.xdi.oxauth.client.AuthorizationRequest クラス
org.xdi.oxauth.client.AuthorizationRequest の継承関係図
Inheritance graph
org.xdi.oxauth.client.AuthorizationRequest 連携図
Collaboration graph

公開メンバ関数

 AuthorizationRequest (List< ResponseType > responseTypes, String clientId, List< String > scopes, String redirectUri, String nonce)
 
CodeVerifier generateAndSetCodeChallengeWithMethod ()
 
String getCodeChallenge ()
 
String getCodeChallengeMethod ()
 
void setCodeChallenge (String codeChallenge)
 
void setCodeChallengeMethod (String codeChallengeMethod)
 
List< ResponseTypegetResponseTypes ()
 
void setResponseTypes (List< ResponseType > responseTypes)
 
String getClientId ()
 
void setClientId (String clientId)
 
List< String > getScopes ()
 
void setScopes (List< String > scopes)
 
String getRedirectUri ()
 
void setRedirectUri (String redirectUri)
 
String getState ()
 
void setState (String state)
 
ResponseMode getResponseMode ()
 
void setResponseMode (ResponseMode responseMode)
 
String getNonce ()
 
void setNonce (String nonce)
 
Display getDisplay ()
 
void setDisplay (Display display)
 
List< PromptgetPrompts ()
 
void setPrompts (List< Prompt > prompts)
 
Integer getMaxAge ()
 
void setMaxAge (Integer maxAge)
 
List< String > getUiLocales ()
 
void setUiLocales (List< String > uiLocales)
 
List< String > getClaimsLocales ()
 
void setClaimsLocales (List< String > claimsLocales)
 
String getIdTokenHint ()
 
void setIdTokenHint (String idTokenHint)
 
String getLoginHint ()
 
void setLoginHint (String loginHint)
 
List< String > getAcrValues ()
 
void setAcrValues (List< String > acrValues)
 
JSONObject getClaims ()
 
void setClaims (JSONObject claims)
 
String getRegistration ()
 
void setRegistration (String registration)
 
String getRequest ()
 
void setRequest (String request)
 
String getRequestUri ()
 
void setRequestUri (String requestUri)
 
boolean isRequestSessionId ()
 
void setRequestSessionId (boolean p_requestSessionId)
 
String getSessionId ()
 
void setSessionId (String p_sessionId)
 
String getAccessToken ()
 
void setAccessToken (String accessToken)
 
boolean isUseNoRedirectHeader ()
 
void setUseNoRedirectHeader (boolean useNoRedirectHeader)
 
String getResponseTypesAsString ()
 
String getScopesAsString ()
 
String getPromptsAsString ()
 
String getUiLocalesAsString ()
 
String getClaimsLocalesAsString ()
 
String getAcrValuesAsString ()
 
String getCustomResponseHeadersAsString () throws JSONException
 
Map< String, String > getCustomResponseHeaders ()
 
void setCustomResponseHeaders (Map< String, String > customResponseHeaders)
 
String getClaimsAsString ()
 
String getQueryString ()
 
Map< String, String > getParameters ()
 
 __construct ($responseTypes, $clientId, $scopes, $redirectUri, $nonce)
 
 getResponseTypes ()
 
 setResponseTypes ($responseTypes)
 
 getClientId ()
 
 setClientId ($clientId)
 
 getScopes ()
 
 setScopes ($scopes)
 
 isRequestSessionId ()
 
 setRequestSessionId ($p_requestSessionId)
 
 getSessionId ()
 
 setSessionId ($p_sessionId)
 
 getRedirectUri ()
 
 setRedirectUri ($redirectUri)
 
 getNonce ()
 
 setNonce ($nonce)
 
 getState ()
 
 setState ($state)
 
 getRequest ()
 
 setRequest ($request)
 
 getRequestUri ()
 
 setRequestUri ($requestUri)
 
 getDisplay ()
 
 setDisplay ($display)
 
 getPrompts ()
 
 getAccessToken ()
 
 setAccessToken ($accessToken)
 
 isUseNoRedirectHeader ()
 
 setUseNoRedirectHeader ($useNoRedirectHeader)
 
 getResponseTypesAsString ()
 
 getQueryString ()
 
String getContentType ()
 
void setContentType (String contentType)
 
String getMediaType ()
 
void setMediaType (String mediaType)
 
String getAuthUsername ()
 
 getAuthUsername ()
 
void setAuthUsername (String authUsername)
 
 setAuthUsername ($authUsername)
 
String getAuthPassword ()
 
 getAuthPassword ()
 
void setAuthPassword (String authPassword)
 
 setAuthPassword ($authPassword)
 
AuthenticationMethod getAuthenticationMethod ()
 
void setAuthenticationMethod (AuthenticationMethod authenticationMethod)
 
AuthorizationMethod getAuthorizationMethod ()
 
void setAuthorizationMethod (AuthorizationMethod authorizationMethod)
 
Map< String, String > getCustomParameters ()
 
 getCustomParameters ()
 
void addCustomParameter (String paramName, String paramValue)
 
 addCustomParameter ($paramName, $paramValue)
 
boolean hasCredentials ()
 
 hasCredentials ()
 
String getCredentials () throws UnsupportedEncodingException
 
 getCredentials ()
 
String getEncodedCredentials ()
 
 getEncodedCredentials ()
 
JSONObject getJSONParameters () throws JSONException
 
 queryString ()
 

非公開変数類

List< ResponseTyperesponseTypes
 
String clientId
 
List< String > scopes
 
String redirectUri
 
String state
 
ResponseMode responseMode
 
String nonce
 
Display display
 
List< Promptprompts
 
Integer maxAge
 
List< String > uiLocales
 
List< String > claimsLocales
 
String idTokenHint
 
String loginHint
 
List< String > acrValues
 
JSONObject claims
 
String registration
 
String request
 
String requestUri
 
boolean requestSessionId
 
String sessionId
 
String accessToken
 
boolean useNoRedirectHeader
 
String codeChallenge
 
String codeChallengeMethod
 
Map< String, String > customResponseHeaders
 
 $responseTypes
 
 $clientId
 
 $scopes
 
 $redirectUri
 
 $nonce
 
 $state
 
 $request
 
 $requestUri
 
 $display
 
 $prompts
 
 $requestSessionId
 
 $sessionId
 
 $accessToken
 
 $useNoRedirectHeader
 

詳解

Represents an authorization request to send to the authorization server.

著者
Javier Rojas Blum
バージョン
August 9, 2017

Represents an authorization request to send to the authorization server.

著者
Gabin Dongmo
バージョン
August 9, 2017

構築子と解体子

◆ AuthorizationRequest()

org.xdi.oxauth.client.AuthorizationRequest.AuthorizationRequest ( List< ResponseType responseTypes,
String  clientId,
List< String >  scopes,
String  redirectUri,
String  nonce 
)
inline

Constructs an authorization request.

引数
responseTypesThe response type informs the authorization server of the desired response type: code, token, id_token a combination of them. The response type parameter is mandatory.
clientIdThe client identifier is mandatory.
scopesThe scope of the access request.
redirectUriRedirection URI
nonceA string value used to associate a user agent session with an ID Token, and to mitigate replay attacks.
81  {
82  super();
84  this.clientId = clientId;
85  this.scopes = scopes;
86  this.redirectUri = redirectUri;
87  this.nonce = nonce;
88  prompts = new ArrayList<Prompt>();
89  useNoRedirectHeader = false;
90  }
List< Prompt > prompts
Definition: AuthorizationRequest.java:44
List< String > scopes
Definition: AuthorizationRequest.java:37
boolean useNoRedirectHeader
Definition: AuthorizationRequest.java:60
List< ResponseType > responseTypes
Definition: AuthorizationRequest.java:35
String redirectUri
Definition: AuthorizationRequest.java:38
String clientId
Definition: AuthorizationRequest.java:36
String nonce
Definition: AuthorizationRequest.java:42

◆ __construct()

org.xdi.oxauth.client.AuthorizationRequest.__construct (   $responseTypes,
  $clientId,
  $scopes,
  $redirectUri,
  $nonce 
)
33  {
34  parent::__construct();
36  $this->clientId = $clientId;
37  $this->scopes = $scopes;
38  $this->redirectUri = $redirectUri;
39  $this->nonce = $nonce;
40  $prompts = array();
41  $useNoRedirectHeader = false;
42  }
List< String > scopes
Definition: AuthorizationRequest.java:37
$clientId
Definition: AuthorizationRequest.php:17
List< ResponseType > responseTypes
Definition: AuthorizationRequest.java:35
$responseTypes
Definition: AuthorizationRequest.php:16
$nonce
Definition: AuthorizationRequest.php:21
$prompts
Definition: AuthorizationRequest.php:26
String redirectUri
Definition: AuthorizationRequest.java:38
String clientId
Definition: AuthorizationRequest.java:36
$redirectUri
Definition: AuthorizationRequest.php:19
String nonce
Definition: AuthorizationRequest.java:42
$useNoRedirectHeader
Definition: AuthorizationRequest.php:31
$scopes
Definition: AuthorizationRequest.php:18

関数詳解

◆ addCustomParameter() [1/2]

org.xdi.oxauth.client.BaseRequest.addCustomParameter (   $paramName,
  $paramValue 
)
inherited
39  {
40  $this->customParameters[$paramName] = $paramValue;
41  }
Map< String, String > customParameters
Definition: BaseRequest.java:36

◆ addCustomParameter() [2/2]

void org.xdi.oxauth.client.BaseRequest.addCustomParameter ( String  paramName,
String  paramValue 
)
inlineinherited
94  {
95  customParameters.put(paramName, paramValue);
96  }
Map< String, String > customParameters
Definition: BaseRequest.java:36

◆ generateAndSetCodeChallengeWithMethod()

CodeVerifier org.xdi.oxauth.client.AuthorizationRequest.generateAndSetCodeChallengeWithMethod ( )
inline
92  {
93  CodeVerifier verifier = new CodeVerifier(CodeVerifier.CodeChallengeMethod.S256);
94  codeChallenge = verifier.getCodeChallenge();
95  codeChallengeMethod = verifier.getTransformationType().getPkceString();
96  return verifier;
97  }
String codeChallengeMethod
Definition: AuthorizationRequest.java:64
String codeChallenge
Definition: AuthorizationRequest.java:63

◆ getAccessToken() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getAccessToken ( )
272  {
273  return $this->accessToken;
274  }
$accessToken
Definition: AuthorizationRequest.php:30

◆ getAccessToken() [2/2]

String org.xdi.oxauth.client.AuthorizationRequest.getAccessToken ( )
inline
419  {
420  return accessToken;
421  }
String accessToken
Definition: AuthorizationRequest.java:59

◆ getAcrValues()

List<String> org.xdi.oxauth.client.AuthorizationRequest.getAcrValues ( )
inline
323  {
324  return acrValues;
325  }
List< String > acrValues
Definition: AuthorizationRequest.java:50

◆ getAcrValuesAsString()

String org.xdi.oxauth.client.AuthorizationRequest.getAcrValuesAsString ( )
inline
455  {
456  return Util.listAsString(acrValues);
457  }
List< String > acrValues
Definition: AuthorizationRequest.java:50

◆ getAuthenticationMethod()

AuthenticationMethod org.xdi.oxauth.client.BaseRequest.getAuthenticationMethod ( )
inlineinherited
74  {
75  return authenticationMethod;
76  }
AuthenticationMethod authenticationMethod
Definition: BaseRequest.java:34

◆ getAuthorizationMethod()

AuthorizationMethod org.xdi.oxauth.client.BaseRequest.getAuthorizationMethod ( )
inlineinherited
82  {
83  return authorizationMethod;
84  }
AuthorizationMethod authorizationMethod
Definition: BaseRequest.java:35

◆ getAuthPassword() [1/2]

org.xdi.oxauth.client.BaseRequest.getAuthPassword ( )
inherited
27  {
28  return $this->authPassword;
29  }
$authPassword
Definition: BaseRequest.php:12

◆ getAuthPassword() [2/2]

String org.xdi.oxauth.client.BaseRequest.getAuthPassword ( )
inlineinherited
66  {
67  return authPassword;
68  }
String authPassword
Definition: BaseRequest.java:33

◆ getAuthUsername() [1/2]

org.xdi.oxauth.client.BaseRequest.getAuthUsername ( )
inherited
19  {
20  return $this->authUsername;
21  }
$authUsername
Definition: BaseRequest.php:11

◆ getAuthUsername() [2/2]

String org.xdi.oxauth.client.BaseRequest.getAuthUsername ( )
inlineinherited
58  {
59  return authUsername;
60  }
String authUsername
Definition: BaseRequest.java:32

◆ getClaims()

JSONObject org.xdi.oxauth.client.AuthorizationRequest.getClaims ( )
inline
331  {
332  return claims;
333  }
JSONObject claims
Definition: AuthorizationRequest.java:51

◆ getClaimsAsString()

String org.xdi.oxauth.client.AuthorizationRequest.getClaimsAsString ( )
inline
471  {
472  if (claims != null) {
473  return claims.toString();
474  } else {
475  return null;
476  }
477  }
JSONObject claims
Definition: AuthorizationRequest.java:51

◆ getClaimsLocales()

List<String> org.xdi.oxauth.client.AuthorizationRequest.getClaimsLocales ( )
inline
299  {
300  return claimsLocales;
301  }
List< String > claimsLocales
Definition: AuthorizationRequest.java:47

◆ getClaimsLocalesAsString()

String org.xdi.oxauth.client.AuthorizationRequest.getClaimsLocalesAsString ( )
inline
451  {
452  return Util.listAsString(claimsLocales);
453  }
List< String > claimsLocales
Definition: AuthorizationRequest.java:47

◆ getClientId() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getClientId ( )

Returns the client identifier.

戻り値
The client identifier.
67  {
68  return $this->clientId;
69  }
$clientId
Definition: AuthorizationRequest.php:17

◆ getClientId() [2/2]

String org.xdi.oxauth.client.AuthorizationRequest.getClientId ( )
inline

Returns the client identifier.

戻り値
The client identifier.
138  {
139  return clientId;
140  }
String clientId
Definition: AuthorizationRequest.java:36

◆ getCodeChallenge()

String org.xdi.oxauth.client.AuthorizationRequest.getCodeChallenge ( )
inline
99  {
100  return codeChallenge;
101  }
String codeChallenge
Definition: AuthorizationRequest.java:63

◆ getCodeChallengeMethod()

String org.xdi.oxauth.client.AuthorizationRequest.getCodeChallengeMethod ( )
inline
103  {
104  return codeChallengeMethod;
105  }
String codeChallengeMethod
Definition: AuthorizationRequest.java:64

◆ getContentType()

String org.xdi.oxauth.client.BaseRequest.getContentType ( )
inlineinherited
42  {
43  return contentType;
44  }
String contentType
Definition: BaseRequest.java:30

◆ getCredentials() [1/2]

org.xdi.oxauth.client.BaseRequest.getCredentials ( )
inherited
49  {
50  return $this->authUsername . ':' . $this->authPassword;
51  }
$authPassword
Definition: BaseRequest.php:12
String authUsername
Definition: BaseRequest.java:32

◆ getCredentials() [2/2]

String org.xdi.oxauth.client.BaseRequest.getCredentials ( ) throws UnsupportedEncodingException
inlineinherited

Returns the client credentials (URL encoded).

戻り値
The client credentials.
109  {
110  return URLEncoder.encode(authUsername, Util.UTF8_STRING_ENCODING)
111  + ":"
112  + URLEncoder.encode(authPassword, Util.UTF8_STRING_ENCODING);
113  }
String authPassword
Definition: BaseRequest.java:33
String authUsername
Definition: BaseRequest.java:32

◆ getCustomParameters() [1/2]

org.xdi.oxauth.client.BaseRequest.getCustomParameters ( )
inherited
35  {
37  }
$customParameters
Definition: BaseRequest.php:13

◆ getCustomParameters() [2/2]

Map<String, String> org.xdi.oxauth.client.BaseRequest.getCustomParameters ( )
inlineinherited
90  {
91  return customParameters;
92  }
Map< String, String > customParameters
Definition: BaseRequest.java:36

◆ getCustomResponseHeaders()

Map<String, String> org.xdi.oxauth.client.AuthorizationRequest.getCustomResponseHeaders ( )
inline
463  {
464  return customResponseHeaders;
465  }
Map< String, String > customResponseHeaders
Definition: AuthorizationRequest.java:66

◆ getCustomResponseHeadersAsString()

String org.xdi.oxauth.client.AuthorizationRequest.getCustomResponseHeadersAsString ( ) throws JSONException
inline
459  {
460  return Util.mapAsString(customResponseHeaders);
461  }
Map< String, String > customResponseHeaders
Definition: AuthorizationRequest.java:66

◆ getDisplay() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getDisplay ( )

Returns an ASCII string value that specifies how the Authorization Server displays the authentication page to the End-User.

戻り値
The display value.
248  {
249  return $this->display;
250  }
$display
Definition: AuthorizationRequest.php:25

◆ getDisplay() [2/2]

Display org.xdi.oxauth.client.AuthorizationRequest.getDisplay ( )
inline

Returns an ASCII string value that specifies how the Authorization Server displays the authentication page to the End-User.

戻り値
The display value.
255  {
256  return display;
257  }
Display display
Definition: AuthorizationRequest.java:43

◆ getEncodedCredentials() [1/2]

org.xdi.oxauth.client.BaseRequest.getEncodedCredentials ( )
inherited
53  {
54  if($this->hasCredentials()){
55  return base64_encode($this->getCredentials());
56  }
57  return NULL;
58  }
boolean hasCredentials()
Definition: BaseRequest.java:98
String getCredentials()
Definition: BaseRequest.java:109

◆ getEncodedCredentials() [2/2]

String org.xdi.oxauth.client.BaseRequest.getEncodedCredentials ( )
inlineinherited

Returns the client credentials encoded using base64.

戻り値
The encoded client credentials.
120  {
121  try {
122  if (hasCredentials()) {
123  return Base64.encodeBase64String(Util.getBytes(getCredentials()));
124  }
125  } catch (UnsupportedEncodingException e) {
126  e.printStackTrace();
127  }
128 
129  return null;
130  }
boolean hasCredentials()
Definition: BaseRequest.java:98
String getCredentials()
Definition: BaseRequest.java:109

◆ getIdTokenHint()

String org.xdi.oxauth.client.AuthorizationRequest.getIdTokenHint ( )
inline
307  {
308  return idTokenHint;
309  }
String idTokenHint
Definition: AuthorizationRequest.java:48

◆ getJSONParameters()

JSONObject org.xdi.oxauth.client.BaseRequest.getJSONParameters ( ) throws JSONException
inlineinherited
136  {
137  return EMPTY_JSON_OBJECT;
138  }
static final JSONObject EMPTY_JSON_OBJECT
Definition: BaseRequest.java:28

◆ getLoginHint()

String org.xdi.oxauth.client.AuthorizationRequest.getLoginHint ( )
inline
315  {
316  return loginHint;
317  }
String loginHint
Definition: AuthorizationRequest.java:49

◆ getMaxAge()

Integer org.xdi.oxauth.client.AuthorizationRequest.getMaxAge ( )
inline
283  {
284  return maxAge;
285  }
Integer maxAge
Definition: AuthorizationRequest.java:45

◆ getMediaType()

String org.xdi.oxauth.client.BaseRequest.getMediaType ( )
inlineinherited
50  {
51  return mediaType;
52  }
String mediaType
Definition: BaseRequest.java:31

◆ getNonce() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getNonce ( )

Returns a string value used to associate a user agent session with an ID Token, and to mitigate replay attacks.

戻り値
The nonce value.
168  {
169  return $this->nonce;
170  }
$nonce
Definition: AuthorizationRequest.php:21

◆ getNonce() [2/2]

String org.xdi.oxauth.client.AuthorizationRequest.getNonce ( )
inline

Returns a string value used to associate a user agent session with an ID Token, and to mitigate replay attacks.

戻り値
The nonce value.
235  {
236  return nonce;
237  }
String nonce
Definition: AuthorizationRequest.java:42

◆ getParameters()

Map<String, String> org.xdi.oxauth.client.AuthorizationRequest.getParameters ( )
inline

Returns a collection of parameters of the authorization request. Any null or empty parameter will be omitted.

戻り値
A collection of parameters.
622  {
623  Map<String, String> parameters = new HashMap<String, String>();
624 
625  try {
626  // OAuth 2.0 request parameters
627  final String responseTypesAsString = getResponseTypesAsString();
628  final String scopesAsString = getScopesAsString();
629  final String promptsAsString = getPromptsAsString();
630  final String customResponseHeadersAsString = getCustomResponseHeadersAsString();
631 
632  if (StringUtils.isNotBlank(responseTypesAsString)) {
633  parameters.put(AuthorizeRequestParam.RESPONSE_TYPE, responseTypesAsString);
634  }
635  if (StringUtils.isNotBlank(clientId)) {
636  parameters.put(AuthorizeRequestParam.CLIENT_ID, clientId);
637  }
638  if (StringUtils.isNotBlank(scopesAsString)) {
639  parameters.put(AuthorizeRequestParam.SCOPE, scopesAsString);
640  }
641  if (StringUtils.isNotBlank(redirectUri)) {
642  parameters.put(AuthorizeRequestParam.REDIRECT_URI, redirectUri);
643  }
644  if (StringUtils.isNotBlank(state)) {
645  parameters.put(AuthorizeRequestParam.STATE, state);
646  }
647 
648  // OpenID Connect request parameters
649  final String uiLocalesAsString = getUiLocalesAsString();
650  final String claimLocalesAsString = getClaimsLocalesAsString();
651  final String acrValuesAsString = getAcrValuesAsString();
652  final String claimsAsString = getClaimsAsString();
653 
654  if (responseMode != null) {
655  parameters.put(AuthorizeRequestParam.RESPONSE_MODE, responseMode.toString());
656  }
657  if (StringUtils.isNotBlank(nonce)) {
658  parameters.put(AuthorizeRequestParam.NONCE, nonce);
659  }
660  if (display != null) {
661  parameters.put(AuthorizeRequestParam.DISPLAY, display.toString());
662  }
663  if (StringUtils.isNotBlank(promptsAsString)) {
664  parameters.put(AuthorizeRequestParam.PROMPT, promptsAsString);
665  }
666  if (maxAge != null) {
667  parameters.put(AuthorizeRequestParam.MAX_AGE, maxAge.toString());
668  }
669  if (StringUtils.isNotBlank(uiLocalesAsString)) {
670  parameters.put(AuthorizeRequestParam.UI_LOCALES, uiLocalesAsString);
671  }
672  if (StringUtils.isNotBlank(claimLocalesAsString)) {
673  parameters.put(AuthorizeRequestParam.CLAIMS_LOCALES, claimLocalesAsString);
674  }
675  if (StringUtils.isNotBlank(idTokenHint)) {
676  parameters.put(AuthorizeRequestParam.ID_TOKEN_HINT, idTokenHint);
677  }
678  if (StringUtils.isNotBlank(loginHint)) {
679  parameters.put(AuthorizeRequestParam.LOGIN_HINT, loginHint);
680  }
681  if (StringUtils.isNotBlank(acrValuesAsString)) {
682  parameters.put(AuthorizeRequestParam.ACR_VALUES, acrValuesAsString);
683  }
684  if (StringUtils.isNotBlank(claimsAsString)) {
685  parameters.put(AuthorizeRequestParam.CLAIMS, claimsAsString);
686  }
687  if (StringUtils.isNotBlank(registration)) {
688  parameters.put(AuthorizeRequestParam.REGISTRATION, registration);
689  }
690  if (StringUtils.isNotBlank(request)) {
691  parameters.put(AuthorizeRequestParam.REQUEST, request);
692  }
693  if (StringUtils.isNotBlank(requestUri)) {
694  parameters.put(AuthorizeRequestParam.REQUEST_URI, requestUri);
695  }
696  if (requestSessionId) {
697  parameters.put(AuthorizeRequestParam.REQUEST_SESSION_ID, Boolean.toString(requestSessionId));
698  }
699  if (StringUtils.isNotBlank(sessionId)) {
700  parameters.put(AuthorizeRequestParam.SESSION_ID, sessionId);
701  }
702  if (StringUtils.isNotBlank(accessToken)) {
703  parameters.put(AuthorizeRequestParam.ACCESS_TOKEN, accessToken);
704  }
705  if (StringUtils.isNotBlank(codeChallenge)) {
706  parameters.put(AuthorizeRequestParam.CODE_CHALLENGE, codeChallenge);
707  }
708  if (StringUtils.isNotBlank(codeChallengeMethod)) {
709  parameters.put(AuthorizeRequestParam.CODE_CHALLENGE_METHOD, codeChallengeMethod);
710  }
711  if (StringUtils.isNotBlank(customResponseHeadersAsString)) {
712  parameters.put(AuthorizeRequestParam.CUSTOM_RESPONSE_HEADERS, customResponseHeadersAsString);
713  }
714 
715  for (String key : getCustomParameters().keySet()) {
716  parameters.put(key, getCustomParameters().get(key));
717  }
718  } catch (JSONException e) {
719  e.printStackTrace();
720  }
721 
722  return parameters;
723  }
String getScopesAsString()
Definition: AuthorizationRequest.java:439
ResponseMode responseMode
Definition: AuthorizationRequest.java:41
String codeChallengeMethod
Definition: AuthorizationRequest.java:64
String accessToken
Definition: AuthorizationRequest.java:59
String getCustomResponseHeadersAsString()
Definition: AuthorizationRequest.java:459
Display display
Definition: AuthorizationRequest.java:43
String getClaimsLocalesAsString()
Definition: AuthorizationRequest.java:451
boolean requestSessionId
Definition: AuthorizationRequest.java:56
String toString()
Definition: Display.java:79
Integer maxAge
Definition: AuthorizationRequest.java:45
String getAcrValuesAsString()
Definition: AuthorizationRequest.java:455
String getResponseTypesAsString()
Definition: AuthorizationRequest.java:435
String codeChallenge
Definition: AuthorizationRequest.java:63
String toString()
Definition: ResponseMode.java:59
String sessionId
Definition: AuthorizationRequest.java:57
String request
Definition: AuthorizationRequest.java:53
String getClaimsAsString()
Definition: AuthorizationRequest.java:471
String redirectUri
Definition: AuthorizationRequest.java:38
Map< String, String > getCustomParameters()
Definition: BaseRequest.java:90
String clientId
Definition: AuthorizationRequest.java:36
String getPromptsAsString()
Definition: AuthorizationRequest.java:443
String requestUri
Definition: AuthorizationRequest.java:54
String getUiLocalesAsString()
Definition: AuthorizationRequest.java:447
String registration
Definition: AuthorizationRequest.java:52
String idTokenHint
Definition: AuthorizationRequest.java:48
String nonce
Definition: AuthorizationRequest.java:42
String state
Definition: AuthorizationRequest.java:39
String loginHint
Definition: AuthorizationRequest.java:49

◆ getPrompts() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getPrompts ( )

Returns a space delimited list of ASCII strings that can contain the values login, consent, select_account, and none.

戻り値
The prompt list.
268  {
269  return $this->prompts;
270  }
$prompts
Definition: AuthorizationRequest.php:26

◆ getPrompts() [2/2]

List<Prompt> org.xdi.oxauth.client.AuthorizationRequest.getPrompts ( )
inline

Returns a space delimited list of ASCII strings that can contain the values login, consent, select_account, and none.

戻り値
The prompt list.
275  {
276  return prompts;
277  }
List< Prompt > prompts
Definition: AuthorizationRequest.java:44

◆ getPromptsAsString()

String org.xdi.oxauth.client.AuthorizationRequest.getPromptsAsString ( )
inline
443  {
444  return Util.asString(prompts);
445  }
List< Prompt > prompts
Definition: AuthorizationRequest.java:44

◆ getQueryString() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getQueryString ( )

Returns a query string with the parameters of the authorization request. Any null or empty parameter will be omitted.

戻り値
A query string of parameters.
298  {
299 
300  $queryStringBuilder;
301 
302  }

◆ getQueryString() [2/2]

String org.xdi.oxauth.client.AuthorizationRequest.getQueryString ( )
inline

Returns a query string with the parameters of the authorization request. Any null or empty parameter will be omitted.

戻り値
A query string of parameters.
486  {
487  StringBuilder queryStringBuilder = new StringBuilder();
488 
489  try {
490  // OAuth 2.0 request parameters
491  final String responseTypesAsString = getResponseTypesAsString();
492  final String scopesAsString = getScopesAsString();
493  final String promptsAsString = getPromptsAsString();
494  final String customResponseHeadersAsString = getCustomResponseHeadersAsString();
495 
496  if (StringUtils.isNotBlank(responseTypesAsString)) {
497  queryStringBuilder.append(AuthorizeRequestParam.RESPONSE_TYPE)
498  .append("=").append(URLEncoder.encode(responseTypesAsString, Util.UTF8_STRING_ENCODING));
499  }
500  if (StringUtils.isNotBlank(clientId)) {
501  queryStringBuilder.append("&").append(AuthorizeRequestParam.CLIENT_ID)
502  .append("=").append(URLEncoder.encode(clientId, Util.UTF8_STRING_ENCODING));
503  }
504  if (StringUtils.isNotBlank(scopesAsString)) {
505  queryStringBuilder.append("&").append(AuthorizeRequestParam.SCOPE)
506  .append("=").append(URLEncoder.encode(scopesAsString, Util.UTF8_STRING_ENCODING));
507  }
508  if (StringUtils.isNotBlank(redirectUri)) {
509  queryStringBuilder.append("&").append(AuthorizeRequestParam.REDIRECT_URI)
510  .append("=").append(URLEncoder.encode(redirectUri, Util.UTF8_STRING_ENCODING));
511  }
512  if (StringUtils.isNotBlank(state)) {
513  queryStringBuilder.append("&").append(AuthorizeRequestParam.STATE)
514  .append("=").append(URLEncoder.encode(state, Util.UTF8_STRING_ENCODING));
515  }
516 
517  // OpenID Connect request parameters
518  final String uiLocalesAsString = getUiLocalesAsString();
519  final String claimLocalesAsString = getClaimsLocalesAsString();
520  final String acrValuesAsString = getAcrValuesAsString();
521  final String claimsAsString = getClaimsAsString();
522 
523  if (responseMode != null) {
524  queryStringBuilder.append("&").append(AuthorizeRequestParam.RESPONSE_MODE)
525  .append("=").append(URLEncoder.encode(responseMode.toString(), Util.UTF8_STRING_ENCODING));
526  }
527  if (StringUtils.isNotBlank(nonce)) {
528  queryStringBuilder.append("&").append(AuthorizeRequestParam.NONCE)
529  .append("=").append(URLEncoder.encode(nonce, Util.UTF8_STRING_ENCODING));
530  }
531  if (display != null) {
532  queryStringBuilder.append("&").append(AuthorizeRequestParam.DISPLAY)
533  .append("=").append(URLEncoder.encode(display.toString(), Util.UTF8_STRING_ENCODING));
534  }
535  if (StringUtils.isNotBlank(promptsAsString)) {
536  queryStringBuilder.append("&").append(AuthorizeRequestParam.PROMPT)
537  .append("=").append(URLEncoder.encode(promptsAsString, Util.UTF8_STRING_ENCODING));
538  }
539  if (maxAge != null) {
540  queryStringBuilder.append("&").append(AuthorizeRequestParam.MAX_AGE)
541  .append("=").append(maxAge);
542  }
543  if (StringUtils.isNotBlank(uiLocalesAsString)) {
544  queryStringBuilder.append("&").append(AuthorizeRequestParam.UI_LOCALES)
545  .append("=").append(URLEncoder.encode(uiLocalesAsString, Util.UTF8_STRING_ENCODING));
546  }
547  if (StringUtils.isNotBlank(claimLocalesAsString)) {
548  queryStringBuilder.append("&").append(AuthorizeRequestParam.CLAIMS_LOCALES)
549  .append("=").append(URLEncoder.encode(claimLocalesAsString, Util.UTF8_STRING_ENCODING));
550  }
551  if (StringUtils.isNotBlank(idTokenHint)) {
552  queryStringBuilder.append("&").append(AuthorizeRequestParam.ID_TOKEN_HINT)
553  .append("=").append(idTokenHint);
554  }
555  if (StringUtils.isNotBlank(loginHint)) {
556  queryStringBuilder.append("&").append(AuthorizeRequestParam.LOGIN_HINT)
557  .append("=").append(loginHint);
558  }
559  if (StringUtils.isNotBlank(acrValuesAsString)) {
560  queryStringBuilder.append("&").append(AuthorizeRequestParam.ACR_VALUES)
561  .append("=").append(URLEncoder.encode(acrValuesAsString, Util.UTF8_STRING_ENCODING));
562  }
563  if (StringUtils.isNotBlank(claimsAsString)) {
564  queryStringBuilder.append("&").append(AuthorizeRequestParam.CLAIMS)
565  .append("=").append(URLEncoder.encode(claimsAsString, Util.UTF8_STRING_ENCODING));
566  }
567  if (StringUtils.isNotBlank(registration)) {
568  queryStringBuilder.append("&").append(AuthorizeRequestParam.REGISTRATION)
569  .append("=").append(registration);
570  }
571  if (StringUtils.isNotBlank(request)) {
572  queryStringBuilder.append("&").append(AuthorizeRequestParam.REQUEST)
573  .append("=").append(URLEncoder.encode(request, Util.UTF8_STRING_ENCODING));
574  }
575  if (StringUtils.isNotBlank(requestUri)) {
576  queryStringBuilder.append("&").append(AuthorizeRequestParam.REQUEST_URI)
577  .append("=").append(URLEncoder.encode(requestUri, Util.UTF8_STRING_ENCODING));
578  }
579  if (requestSessionId) {
580  queryStringBuilder.append("&").append(AuthorizeRequestParam.REQUEST_SESSION_ID)
581  .append("=").append(URLEncoder.encode(Boolean.toString(requestSessionId), Util.UTF8_STRING_ENCODING));
582  }
583  if (StringUtils.isNotBlank(sessionId)) {
584  queryStringBuilder.append("&").append(AuthorizeRequestParam.SESSION_ID)
585  .append("=").append(URLEncoder.encode(sessionId, Util.UTF8_STRING_ENCODING));
586  }
587  if (StringUtils.isNotBlank(accessToken)) {
588  queryStringBuilder.append("&").append(AuthorizeRequestParam.ACCESS_TOKEN)
589  .append("=").append(URLEncoder.encode(accessToken, Util.UTF8_STRING_ENCODING));
590  }
591  if (StringUtils.isNotBlank(codeChallenge)) {
592  queryStringBuilder.append("&").append(AuthorizeRequestParam.CODE_CHALLENGE)
593  .append("=").append(codeChallenge);
594  }
595  if (StringUtils.isNotBlank(codeChallengeMethod)) {
596  queryStringBuilder.append("&").append(AuthorizeRequestParam.CODE_CHALLENGE_METHOD)
597  .append("=").append(codeChallengeMethod);
598  }
599  if (StringUtils.isNotBlank(customResponseHeadersAsString)) {
600  queryStringBuilder.append("&").append(AuthorizeRequestParam.CUSTOM_RESPONSE_HEADERS)
601  .append("=").append(URLEncoder.encode(customResponseHeadersAsString, Util.UTF8_STRING_ENCODING));
602  }
603  for (String key : getCustomParameters().keySet()) {
604  queryStringBuilder.append("&");
605  queryStringBuilder.append(key).append("=").append(getCustomParameters().get(key));
606  }
607  } catch (UnsupportedEncodingException e) {
608  e.printStackTrace();
609  } catch (JSONException e) {
610  e.printStackTrace();
611  }
612 
613  return queryStringBuilder.toString();
614  }
String getScopesAsString()
Definition: AuthorizationRequest.java:439
ResponseMode responseMode
Definition: AuthorizationRequest.java:41
String codeChallengeMethod
Definition: AuthorizationRequest.java:64
String accessToken
Definition: AuthorizationRequest.java:59
String getCustomResponseHeadersAsString()
Definition: AuthorizationRequest.java:459
Display display
Definition: AuthorizationRequest.java:43
String getClaimsLocalesAsString()
Definition: AuthorizationRequest.java:451
boolean requestSessionId
Definition: AuthorizationRequest.java:56
String toString()
Definition: Display.java:79
Integer maxAge
Definition: AuthorizationRequest.java:45
String getAcrValuesAsString()
Definition: AuthorizationRequest.java:455
String getResponseTypesAsString()
Definition: AuthorizationRequest.java:435
String codeChallenge
Definition: AuthorizationRequest.java:63
String toString()
Definition: ResponseMode.java:59
String sessionId
Definition: AuthorizationRequest.java:57
String request
Definition: AuthorizationRequest.java:53
String getClaimsAsString()
Definition: AuthorizationRequest.java:471
String redirectUri
Definition: AuthorizationRequest.java:38
Map< String, String > getCustomParameters()
Definition: BaseRequest.java:90
String clientId
Definition: AuthorizationRequest.java:36
String getPromptsAsString()
Definition: AuthorizationRequest.java:443
String requestUri
Definition: AuthorizationRequest.java:54
String getUiLocalesAsString()
Definition: AuthorizationRequest.java:447
String registration
Definition: AuthorizationRequest.java:52
String idTokenHint
Definition: AuthorizationRequest.java:48
String nonce
Definition: AuthorizationRequest.java:42
String state
Definition: AuthorizationRequest.java:39
String loginHint
Definition: AuthorizationRequest.java:49

◆ getRedirectUri() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getRedirectUri ( )

Returns the redirection URI.

戻り値
The redirection URI.
149  {
150  return $this->redirectUri;
151  }
$redirectUri
Definition: AuthorizationRequest.php:19

◆ getRedirectUri() [2/2]

String org.xdi.oxauth.client.AuthorizationRequest.getRedirectUri ( )
inline

Returns the redirection URI.

戻り値
The redirection URI.
184  {
185  return redirectUri;
186  }
String redirectUri
Definition: AuthorizationRequest.java:38

◆ getRegistration()

String org.xdi.oxauth.client.AuthorizationRequest.getRegistration ( )
inline
339  {
340  return registration;
341  }
String registration
Definition: AuthorizationRequest.java:52

◆ getRequest() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getRequest ( )

Returns a JWT encoded OpenID Request Object.

戻り値
A JWT encoded OpenID Request Object.
211  {
212  return $this->request;
213  }
$request
Definition: AuthorizationRequest.php:23

◆ getRequest() [2/2]

String org.xdi.oxauth.client.AuthorizationRequest.getRequest ( )
inline

Returns a JWT encoded OpenID Request Object.

戻り値
A JWT encoded OpenID Request Object.
352  {
353  return request;
354  }
String request
Definition: AuthorizationRequest.java:53

◆ getRequestUri() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getRequestUri ( )

Returns an URL that points to an OpenID Request Object.

戻り値
An URL that points to an OpenID Request Object.
229  {
230  return $this->requestUri;
231  }
$requestUri
Definition: AuthorizationRequest.php:24

◆ getRequestUri() [2/2]

String org.xdi.oxauth.client.AuthorizationRequest.getRequestUri ( )
inline

Returns an URL that points to an OpenID Request Object.

戻り値
An URL that points to an OpenID Request Object.
370  {
371  return requestUri;
372  }
String requestUri
Definition: AuthorizationRequest.java:54

◆ getResponseMode()

ResponseMode org.xdi.oxauth.client.AuthorizationRequest.getResponseMode ( )
inline
221  {
222  return responseMode;
223  }
ResponseMode responseMode
Definition: AuthorizationRequest.java:41

◆ getResponseTypes() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getResponseTypes ( )

Returns the response types.

戻り値
The response types.
49  {
50  return $this->responseTypes;
51  }
$responseTypes
Definition: AuthorizationRequest.php:16

◆ getResponseTypes() [2/2]

List<ResponseType> org.xdi.oxauth.client.AuthorizationRequest.getResponseTypes ( )
inline

Returns the response types.

戻り値
The response types.
120  {
121  return responseTypes;
122  }
List< ResponseType > responseTypes
Definition: AuthorizationRequest.java:35

◆ getResponseTypesAsString() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getResponseTypesAsString ( )
288  {
289  return Util.asString(responseTypes);
290  }
List< ResponseType > responseTypes
Definition: AuthorizationRequest.java:35

◆ getResponseTypesAsString() [2/2]

String org.xdi.oxauth.client.AuthorizationRequest.getResponseTypesAsString ( )
inline
435  {
436  return Util.asString(responseTypes);
437  }
List< ResponseType > responseTypes
Definition: AuthorizationRequest.java:35

◆ getScopes() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getScopes ( )

Returns the scopes of the access request. The authorization endpoint allow the client to specify the scope of the access request using the scope request parameter. In turn, the authorization server uses the scope response parameter to inform the client of the scope of the access token issued. The value of the scope parameter is expressed as a list of space-delimited, case sensitive strings.

戻り値
The scopes of the access request.
90  {
91  return $this->scopes;
92  }
$scopes
Definition: AuthorizationRequest.php:18

◆ getScopes() [2/2]

List<String> org.xdi.oxauth.client.AuthorizationRequest.getScopes ( )
inline

Returns the scopes of the access request. The authorization endpoint allow the client to specify the scope of the access request using the scope request parameter. In turn, the authorization server uses the scope response parameter to inform the client of the scope of the access token issued. The value of the scope parameter is expressed as a list of space-delimited, case sensitive strings.

戻り値
The scopes of the access request.
161  {
162  return scopes;
163  }
List< String > scopes
Definition: AuthorizationRequest.java:37

◆ getScopesAsString()

String org.xdi.oxauth.client.AuthorizationRequest.getScopesAsString ( )
inline
439  {
440  return Util.listAsString(scopes);
441  }
List< String > scopes
Definition: AuthorizationRequest.java:37

◆ getSessionId() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getSessionId ( )

Gets session id.

戻り値
session id.
131  {
132  return $this->sessionId;
133  }
$sessionId
Definition: AuthorizationRequest.php:28

◆ getSessionId() [2/2]

String org.xdi.oxauth.client.AuthorizationRequest.getSessionId ( )
inline

Gets session id.

戻り値
session id.
406  {
407  return sessionId;
408  }
String sessionId
Definition: AuthorizationRequest.java:57

◆ getState() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.getState ( )

Returns the state. The state is an opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client. The parameter should be used for preventing cross-site request forgery.

戻り値
The state.
190  {
191  return $this->state;
192  }
$state
Definition: AuthorizationRequest.php:22

◆ getState() [2/2]

String org.xdi.oxauth.client.AuthorizationRequest.getState ( )
inline

Returns the state. The state is an opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client. The parameter should be used for preventing cross-site request forgery.

戻り値
The state.
205  {
206  return state;
207  }
String state
Definition: AuthorizationRequest.java:39

◆ getUiLocales()

List<String> org.xdi.oxauth.client.AuthorizationRequest.getUiLocales ( )
inline
291  {
292  return uiLocales;
293  }
List< String > uiLocales
Definition: AuthorizationRequest.java:46

◆ getUiLocalesAsString()

String org.xdi.oxauth.client.AuthorizationRequest.getUiLocalesAsString ( )
inline
447  {
448  return Util.listAsString(uiLocales);
449  }
List< String > uiLocales
Definition: AuthorizationRequest.java:46

◆ hasCredentials() [1/2]

org.xdi.oxauth.client.BaseRequest.hasCredentials ( )
inherited
43  {
44  return isset($this->authUsername, $this->authPassword)
45  && empty($this->authUsername)
46  && empty($this->authPassword);
47  }
String authPassword
Definition: BaseRequest.java:33
String authUsername
Definition: BaseRequest.java:32

◆ hasCredentials() [2/2]

boolean org.xdi.oxauth.client.BaseRequest.hasCredentials ( )
inlineinherited
98  {
99  return authUsername != null && authPassword != null
100  && !authUsername.isEmpty()
101  && !authPassword.isEmpty();
102  }
String authPassword
Definition: BaseRequest.java:33
String authUsername
Definition: BaseRequest.java:32

◆ isRequestSessionId() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.isRequestSessionId ( )

Returns whether session id is requested.

戻り値
whether session id is requested.
113  {
115  }
$requestSessionId
Definition: AuthorizationRequest.php:27

◆ isRequestSessionId() [2/2]

boolean org.xdi.oxauth.client.AuthorizationRequest.isRequestSessionId ( )
inline

Returns whether session id is requested.

戻り値
whether session id is requested
388  {
389  return requestSessionId;
390  }
boolean requestSessionId
Definition: AuthorizationRequest.java:56

◆ isUseNoRedirectHeader() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.isUseNoRedirectHeader ( )
280  {
282  }
$useNoRedirectHeader
Definition: AuthorizationRequest.php:31

◆ isUseNoRedirectHeader() [2/2]

boolean org.xdi.oxauth.client.AuthorizationRequest.isUseNoRedirectHeader ( )
inline
427  {
428  return useNoRedirectHeader;
429  }
boolean useNoRedirectHeader
Definition: AuthorizationRequest.java:60

◆ queryString()

org.xdi.oxauth.client.BaseRequest.queryString ( )
abstractinherited

◆ setAccessToken() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setAccessToken (   $accessToken)
276  {
277  $this->accessToken = $accessToken;
278  }
String accessToken
Definition: AuthorizationRequest.java:59
$accessToken
Definition: AuthorizationRequest.php:30

◆ setAccessToken() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setAccessToken ( String  accessToken)
inline
423  {
424  this.accessToken = accessToken;
425  }
String accessToken
Definition: AuthorizationRequest.java:59

◆ setAcrValues()

void org.xdi.oxauth.client.AuthorizationRequest.setAcrValues ( List< String >  acrValues)
inline
327  {
328  this.acrValues = acrValues;
329  }
List< String > acrValues
Definition: AuthorizationRequest.java:50

◆ setAuthenticationMethod()

void org.xdi.oxauth.client.BaseRequest.setAuthenticationMethod ( AuthenticationMethod  authenticationMethod)
inlineinherited
78  {
80  }
AuthenticationMethod authenticationMethod
Definition: BaseRequest.java:34

◆ setAuthorizationMethod()

void org.xdi.oxauth.client.BaseRequest.setAuthorizationMethod ( AuthorizationMethod  authorizationMethod)
inlineinherited
86  {
88  }
AuthorizationMethod authorizationMethod
Definition: BaseRequest.java:35

◆ setAuthPassword() [1/2]

org.xdi.oxauth.client.BaseRequest.setAuthPassword (   $authPassword)
inherited
31  {
32  $this->authPassword = $authPassword;
33  }
$authPassword
Definition: BaseRequest.php:12
String authPassword
Definition: BaseRequest.java:33

◆ setAuthPassword() [2/2]

void org.xdi.oxauth.client.BaseRequest.setAuthPassword ( String  authPassword)
inlineinherited
70  {
72  }
String authPassword
Definition: BaseRequest.java:33

◆ setAuthUsername() [1/2]

org.xdi.oxauth.client.BaseRequest.setAuthUsername (   $authUsername)
inherited
23  {
24  $this->authUsername = $authUsername;
25  }
$authUsername
Definition: BaseRequest.php:11
String authUsername
Definition: BaseRequest.java:32

◆ setAuthUsername() [2/2]

void org.xdi.oxauth.client.BaseRequest.setAuthUsername ( String  authUsername)
inlineinherited
62  {
64  }
String authUsername
Definition: BaseRequest.java:32

◆ setClaims()

void org.xdi.oxauth.client.AuthorizationRequest.setClaims ( JSONObject  claims)
inline
335  {
336  this.claims = claims;
337  }
JSONObject claims
Definition: AuthorizationRequest.java:51

◆ setClaimsLocales()

void org.xdi.oxauth.client.AuthorizationRequest.setClaimsLocales ( List< String >  claimsLocales)
inline
303  {
305  }
List< String > claimsLocales
Definition: AuthorizationRequest.java:47

◆ setClientId() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setClientId (   $clientId)

Sets the client identifier.

引数
clientIdThe client identifier.
76  {
77  $this->clientId = $clientId;
78  }
$clientId
Definition: AuthorizationRequest.php:17
String clientId
Definition: AuthorizationRequest.java:36

◆ setClientId() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setClientId ( String  clientId)
inline

Sets the client identifier.

引数
clientIdThe client identifier.
147  {
148  this.clientId = clientId;
149  }
String clientId
Definition: AuthorizationRequest.java:36

◆ setCodeChallenge()

void org.xdi.oxauth.client.AuthorizationRequest.setCodeChallenge ( String  codeChallenge)
inline
107  {
109  }
String codeChallenge
Definition: AuthorizationRequest.java:63

◆ setCodeChallengeMethod()

void org.xdi.oxauth.client.AuthorizationRequest.setCodeChallengeMethod ( String  codeChallengeMethod)
inline
111  {
113  }
String codeChallengeMethod
Definition: AuthorizationRequest.java:64

◆ setContentType()

void org.xdi.oxauth.client.BaseRequest.setContentType ( String  contentType)
inlineinherited
46  {
47  this.contentType = contentType;
48  }
String contentType
Definition: BaseRequest.java:30

◆ setCustomResponseHeaders()

void org.xdi.oxauth.client.AuthorizationRequest.setCustomResponseHeaders ( Map< String, String >  customResponseHeaders)
inline
467  {
469  }
Map< String, String > customResponseHeaders
Definition: AuthorizationRequest.java:66

◆ setDisplay() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setDisplay (   $display)

Sets an ASCII string value that specifies how the Authorization Server displays the authentication page to the End-User.

引数
displayThe display value.
258  {
259  $this->display = $display;
260  }
$display
Definition: AuthorizationRequest.php:25
Display display
Definition: AuthorizationRequest.java:43

◆ setDisplay() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setDisplay ( Display  display)
inline

Sets an ASCII string value that specifies how the Authorization Server displays the authentication page to the End-User.

引数
displayThe display value.
265  {
266  this.display = display;
267  }
Display display
Definition: AuthorizationRequest.java:43

◆ setIdTokenHint()

void org.xdi.oxauth.client.AuthorizationRequest.setIdTokenHint ( String  idTokenHint)
inline
311  {
312  this.idTokenHint = idTokenHint;
313  }
String idTokenHint
Definition: AuthorizationRequest.java:48

◆ setLoginHint()

void org.xdi.oxauth.client.AuthorizationRequest.setLoginHint ( String  loginHint)
inline
319  {
320  this.loginHint = loginHint;
321  }
String loginHint
Definition: AuthorizationRequest.java:49

◆ setMaxAge()

void org.xdi.oxauth.client.AuthorizationRequest.setMaxAge ( Integer  maxAge)
inline
287  {
288  this.maxAge = maxAge;
289  }
Integer maxAge
Definition: AuthorizationRequest.java:45

◆ setMediaType()

void org.xdi.oxauth.client.BaseRequest.setMediaType ( String  mediaType)
inlineinherited
54  {
55  this.mediaType = mediaType;
56  }
String mediaType
Definition: BaseRequest.java:31

◆ setNonce() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setNonce (   $nonce)

Sets a string value used to associate a user agent session with an ID Token, and to mitigate replay attacks.

引数
nonceThe nonce value.
178  {
179  $this->nonce = $nonce;
180  }
$nonce
Definition: AuthorizationRequest.php:21
String nonce
Definition: AuthorizationRequest.java:42

◆ setNonce() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setNonce ( String  nonce)
inline

Sets a string value used to associate a user agent session with an ID Token, and to mitigate replay attacks.

引数
nonceThe nonce value.
245  {
246  this.nonce = nonce;
247  }
String nonce
Definition: AuthorizationRequest.java:42

◆ setPrompts()

void org.xdi.oxauth.client.AuthorizationRequest.setPrompts ( List< Prompt prompts)
inline
279  {
280  this.prompts = prompts;
281  }
List< Prompt > prompts
Definition: AuthorizationRequest.java:44

◆ setRedirectUri() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setRedirectUri (   $redirectUri)

Sets the redirection URI.

引数
redirectUriThe redirection URI.
158  {
159  $this->redirectUri = $redirectUri;
160  }
String redirectUri
Definition: AuthorizationRequest.java:38
$redirectUri
Definition: AuthorizationRequest.php:19

◆ setRedirectUri() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setRedirectUri ( String  redirectUri)
inline

Sets the redirection URI.

引数
redirectUriThe redirection URI.
193  {
194  this.redirectUri = redirectUri;
195  }
String redirectUri
Definition: AuthorizationRequest.java:38

◆ setRegistration()

void org.xdi.oxauth.client.AuthorizationRequest.setRegistration ( String  registration)
inline
343  {
344  this.registration = registration;
345  }
String registration
Definition: AuthorizationRequest.java:52

◆ setRequest() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setRequest (   $request)

Sets a JWT encoded OpenID Request Object.

引数
requestA JWT encoded OpenID Request Object.
220  {
221  $this->request = $request;
222  }
String request
Definition: AuthorizationRequest.java:53
$request
Definition: AuthorizationRequest.php:23

◆ setRequest() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setRequest ( String  request)
inline

Sets a JWT encoded OpenID Request Object.

引数
requestA JWT encoded OpenID Request Object.
361  {
362  this.request = request;
363  }
String request
Definition: AuthorizationRequest.java:53

◆ setRequestSessionId() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setRequestSessionId (   $p_requestSessionId)

Sets whether session id should be requested.

引数
$p_requestSessionIdsession id.
122  {
123  $this->requestSessionId = $p_requestSessionId;
124  }
boolean requestSessionId
Definition: AuthorizationRequest.java:56

◆ setRequestSessionId() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setRequestSessionId ( boolean  p_requestSessionId)
inline

Sets whether session id should be requested.

引数
p_requestSessionIdsession id.
397  {
398  requestSessionId = p_requestSessionId;
399  }
boolean requestSessionId
Definition: AuthorizationRequest.java:56

◆ setRequestUri() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setRequestUri (   $requestUri)

Sets an URL that points to an OpenID Request Object.

引数
requestUriAn URL that points to an OpenID Request Object.
238  {
239  $this->requestUri = $requestUri;
240  }
$requestUri
Definition: AuthorizationRequest.php:24
String requestUri
Definition: AuthorizationRequest.java:54

◆ setRequestUri() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setRequestUri ( String  requestUri)
inline

Sets an URL that points to an OpenID Request Object.

引数
requestUriAn URL that points to an OpenID Request Object.
379  {
380  this.requestUri = requestUri;
381  }
String requestUri
Definition: AuthorizationRequest.java:54

◆ setResponseMode()

void org.xdi.oxauth.client.AuthorizationRequest.setResponseMode ( ResponseMode  responseMode)
inline
225  {
226  this.responseMode = responseMode;
227  }
ResponseMode responseMode
Definition: AuthorizationRequest.java:41

◆ setResponseTypes() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setResponseTypes (   $responseTypes)

Sets the response types.

引数
responseTypesThe response types.
58  {
60  }
List< ResponseType > responseTypes
Definition: AuthorizationRequest.java:35
$responseTypes
Definition: AuthorizationRequest.php:16

◆ setResponseTypes() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setResponseTypes ( List< ResponseType responseTypes)
inline

Sets the response types.

引数
responseTypesThe response types.
129  {
131  }
List< ResponseType > responseTypes
Definition: AuthorizationRequest.java:35

◆ setScopes() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setScopes (   $scopes)

Sets the scope of the access request. The authorization endpoint allow the client to specify the scope of the access request using the scope request parameter. In turn, the authorization server uses the scope response parameter to inform the client of the scope of the access token issued. The value of the scope parameter is expressed as a list of space-delimited, case sensitive strings.

引数
scopesThe scope of the access request.
104  {
105  $this->scopes = $scopes;
106  }
List< String > scopes
Definition: AuthorizationRequest.java:37
$scopes
Definition: AuthorizationRequest.php:18

◆ setScopes() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setScopes ( List< String >  scopes)
inline

Sets the scope of the access request. The authorization endpoint allow the client to specify the scope of the access request using the scope request parameter. In turn, the authorization server uses the scope response parameter to inform the client of the scope of the access token issued. The value of the scope parameter is expressed as a list of space-delimited, case sensitive strings.

引数
scopesThe scope of the access request.
175  {
176  this.scopes = scopes;
177  }
List< String > scopes
Definition: AuthorizationRequest.java:37

◆ setSessionId() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setSessionId (   $p_sessionId)

Sets session id.

引数
$p_sessionIdsession id.
140  {
141  $this->sessionId = $p_sessionId;
142  }
String sessionId
Definition: AuthorizationRequest.java:57

◆ setSessionId() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setSessionId ( String  p_sessionId)
inline

Sets session id.

引数
p_sessionIdsession id
415  {
416  sessionId = p_sessionId;
417  }
String sessionId
Definition: AuthorizationRequest.java:57

◆ setState() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setState (   $state)

Sets the state. The state is an opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client. The parameter should be used for preventing cross-site request forgery.

引数
stateThe state.
202  {
203  $this->state = $state;
204  }
$state
Definition: AuthorizationRequest.php:22
String state
Definition: AuthorizationRequest.java:39

◆ setState() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setState ( String  state)
inline

Sets the state. The state is an opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client. The parameter should be used for preventing cross-site request forgery.

引数
stateThe state.
217  {
218  this.state = state;
219  }
String state
Definition: AuthorizationRequest.java:39

◆ setUiLocales()

void org.xdi.oxauth.client.AuthorizationRequest.setUiLocales ( List< String >  uiLocales)
inline
295  {
296  this.uiLocales = uiLocales;
297  }
List< String > uiLocales
Definition: AuthorizationRequest.java:46

◆ setUseNoRedirectHeader() [1/2]

org.xdi.oxauth.client.AuthorizationRequest.setUseNoRedirectHeader (   $useNoRedirectHeader)
284  {
286  }
boolean useNoRedirectHeader
Definition: AuthorizationRequest.java:60
$useNoRedirectHeader
Definition: AuthorizationRequest.php:31

◆ setUseNoRedirectHeader() [2/2]

void org.xdi.oxauth.client.AuthorizationRequest.setUseNoRedirectHeader ( boolean  useNoRedirectHeader)
inline
431  {
433  }
boolean useNoRedirectHeader
Definition: AuthorizationRequest.java:60

メンバ詳解

◆ $accessToken

org.xdi.oxauth.client.AuthorizationRequest.$accessToken
private

◆ $clientId

org.xdi.oxauth.client.AuthorizationRequest.$clientId
private

◆ $display

org.xdi.oxauth.client.AuthorizationRequest.$display
private

◆ $nonce

org.xdi.oxauth.client.AuthorizationRequest.$nonce
private

◆ $prompts

org.xdi.oxauth.client.AuthorizationRequest.$prompts
private

◆ $redirectUri

org.xdi.oxauth.client.AuthorizationRequest.$redirectUri
private

◆ $request

org.xdi.oxauth.client.AuthorizationRequest.$request
private

◆ $requestSessionId

org.xdi.oxauth.client.AuthorizationRequest.$requestSessionId
private

◆ $requestUri

org.xdi.oxauth.client.AuthorizationRequest.$requestUri
private

◆ $responseTypes

org.xdi.oxauth.client.AuthorizationRequest.$responseTypes
private

◆ $scopes

org.xdi.oxauth.client.AuthorizationRequest.$scopes
private

◆ $sessionId

org.xdi.oxauth.client.AuthorizationRequest.$sessionId
private

◆ $state

org.xdi.oxauth.client.AuthorizationRequest.$state
private

◆ $useNoRedirectHeader

org.xdi.oxauth.client.AuthorizationRequest.$useNoRedirectHeader
private

◆ accessToken

String org.xdi.oxauth.client.AuthorizationRequest.accessToken
private

◆ acrValues

List<String> org.xdi.oxauth.client.AuthorizationRequest.acrValues
private

◆ claims

JSONObject org.xdi.oxauth.client.AuthorizationRequest.claims
private

◆ claimsLocales

List<String> org.xdi.oxauth.client.AuthorizationRequest.claimsLocales
private

◆ clientId

String org.xdi.oxauth.client.AuthorizationRequest.clientId
private

◆ codeChallenge

String org.xdi.oxauth.client.AuthorizationRequest.codeChallenge
private

◆ codeChallengeMethod

String org.xdi.oxauth.client.AuthorizationRequest.codeChallengeMethod
private

◆ customResponseHeaders

Map<String, String> org.xdi.oxauth.client.AuthorizationRequest.customResponseHeaders
private

◆ display

Display org.xdi.oxauth.client.AuthorizationRequest.display
private

◆ idTokenHint

String org.xdi.oxauth.client.AuthorizationRequest.idTokenHint
private

◆ loginHint

String org.xdi.oxauth.client.AuthorizationRequest.loginHint
private

◆ maxAge

Integer org.xdi.oxauth.client.AuthorizationRequest.maxAge
private

◆ nonce

String org.xdi.oxauth.client.AuthorizationRequest.nonce
private

◆ prompts

List<Prompt> org.xdi.oxauth.client.AuthorizationRequest.prompts
private

◆ redirectUri

String org.xdi.oxauth.client.AuthorizationRequest.redirectUri
private

◆ registration

String org.xdi.oxauth.client.AuthorizationRequest.registration
private

◆ request

String org.xdi.oxauth.client.AuthorizationRequest.request
private

◆ requestSessionId

boolean org.xdi.oxauth.client.AuthorizationRequest.requestSessionId
private

◆ requestUri

String org.xdi.oxauth.client.AuthorizationRequest.requestUri
private

◆ responseMode

ResponseMode org.xdi.oxauth.client.AuthorizationRequest.responseMode
private

◆ responseTypes

List<ResponseType> org.xdi.oxauth.client.AuthorizationRequest.responseTypes
private

◆ scopes

List<String> org.xdi.oxauth.client.AuthorizationRequest.scopes
private

◆ sessionId

String org.xdi.oxauth.client.AuthorizationRequest.sessionId
private

◆ state

String org.xdi.oxauth.client.AuthorizationRequest.state
private

◆ uiLocales

List<String> org.xdi.oxauth.client.AuthorizationRequest.uiLocales
private

◆ useNoRedirectHeader

boolean org.xdi.oxauth.client.AuthorizationRequest.useNoRedirectHeader
private

このクラス詳解は次のファイルから抽出されました: