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

公開メンバ関数

 OpenIdConfigurationClient (String url)
 
String getHttpMethod ()
 
OpenIdConfigurationResponse execOpenIdConfiguration ()
 
OpenIdConfigurationResponse execOpenIdConfiguration (ClientExecutor executor)
 
String getUrl ()
 
void setUrl (String url)
 
T getRequest ()
 
void setRequest (T request)
 
V getResponse ()
 
void setResponse (V response)
 
ClientExecutor getExecutor ()
 
void setExecutor (ClientExecutor executor)
 
String getRequestAsString ()
 
String getResponseAsString ()
 
void closeConnection ()
 
List< Cookie > getCookies ()
 
Map< String, String > getHeaders ()
 

静的公開メンバ関数

static void putAllFormParameters (ClientRequest p_clientRequest, BaseRequest p_request)
 

限定公開メンバ関数

void addReqParam (String p_key, HasParamName p_value)
 
void addReqParam (String p_key, String p_value)
 
void initClientRequest ()
 

限定公開変数類

T request
 
V response
 
ClientRequest clientRequest
 
ClientResponse< String > clientResponse
 
ClientExecutor executor
 

非公開メンバ関数

OpenIdConfigurationResponse _execOpenIdConfiguration ()
 

静的非公開変数類

static final Logger LOG = Logger.getLogger(OpenIdConfigurationClient.class)
 
static final String mediaTypes = String.join(",",MediaType.TEXT_PLAIN, MediaType.APPLICATION_JSON)
 

詳解

Encapsulates functionality to make OpenId Configuration request calls to an authorization server via REST Services.

著者
Javier Rojas Blum
バージョン
April 26, 2017

構築子と解体子

◆ OpenIdConfigurationClient()

org.xdi.oxauth.client.OpenIdConfigurationClient.OpenIdConfigurationClient ( String  url)
inline

Constructs an OpenID Configuration Client by providing an url where the REST service is located.

引数
urlThe REST service location.
38  {
39  super(url);
40  }

関数詳解

◆ _execOpenIdConfiguration()

OpenIdConfigurationResponse org.xdi.oxauth.client.OpenIdConfigurationClient._execOpenIdConfiguration ( )
inlineprivate

Executes the call to the REST Service requesting the OpenID Configuration and processes the response.

戻り値
The service response.
65  {
66  setRequest(new OpenIdConfigurationRequest());
67 
68  // Prepare request parameters
69  clientRequest.accept(mediaTypes);
70  clientRequest.setHttpMethod(getHttpMethod());
71 
72  // Call REST Service and handle response
73  try {
74  clientResponse = clientRequest.get(String.class);
75  int status = clientResponse.getStatus();
76 
77  setResponse(new OpenIdConfigurationResponse(status));
78 
79  String entity = clientResponse.getEntity(String.class);
80  getResponse().setEntity(entity);
81  getResponse().setHeaders(clientResponse.getMetadata());
82  if (StringUtils.isNotBlank(entity)) {
83  JSONObject jsonObj = new JSONObject(entity);
84 
85  if (jsonObj.has(ISSUER)) {
86  getResponse().setIssuer(jsonObj.getString(ISSUER));
87  }
88  if (jsonObj.has(AUTHORIZATION_ENDPOINT)) {
89  getResponse().setAuthorizationEndpoint(jsonObj.getString(AUTHORIZATION_ENDPOINT));
90  }
91  if (jsonObj.has(TOKEN_ENDPOINT)) {
92  getResponse().setTokenEndpoint(jsonObj.getString(TOKEN_ENDPOINT));
93  }
94  if (jsonObj.has(USER_INFO_ENDPOINT)) {
95  getResponse().setUserInfoEndpoint(jsonObj.getString(USER_INFO_ENDPOINT));
96  }
97  if (jsonObj.has(CLIENT_INFO_ENDPOINT)) {
98  getResponse().setClientInfoEndpoint(jsonObj.getString(CLIENT_INFO_ENDPOINT));
99  }
100  if (jsonObj.has(CHECK_SESSION_IFRAME)) {
101  getResponse().setCheckSessionIFrame(jsonObj.getString(CHECK_SESSION_IFRAME));
102  }
103  if (jsonObj.has(END_SESSION_ENDPOINT)) {
104  getResponse().setEndSessionEndpoint(jsonObj.getString(END_SESSION_ENDPOINT));
105  }
106  if (jsonObj.has(JWKS_URI)) {
107  getResponse().setJwksUri(jsonObj.getString(JWKS_URI));
108  }
109  if (jsonObj.has(REGISTRATION_ENDPOINT)) {
110  getResponse().setRegistrationEndpoint(jsonObj.getString(REGISTRATION_ENDPOINT));
111  }
112  if (jsonObj.has(ID_GENERATION_ENDPOINT)) {
113  getResponse().setIdGenerationEndpoint(jsonObj.getString(ID_GENERATION_ENDPOINT));
114  }
115  if (jsonObj.has(INTROSPECTION_ENDPOINT)) {
116  getResponse().setIntrospectionEndpoint(jsonObj.getString(INTROSPECTION_ENDPOINT));
117  }
118  if (jsonObj.has(SCOPE_TO_CLAIMS_MAPPING)) {
119  getResponse().setScopeToClaimsMapping(OpenIdConfigurationResponse.parseScopeToClaimsMapping(jsonObj.getJSONArray(SCOPE_TO_CLAIMS_MAPPING)));
120  }
121  Util.addToListIfHas(getResponse().getScopesSupported(), jsonObj, SCOPES_SUPPORTED);
122  Util.addToListIfHas(getResponse().getResponseTypesSupported(), jsonObj, RESPONSE_TYPES_SUPPORTED);
123  Util.addToListIfHas(getResponse().getGrantTypesSupported(), jsonObj, GRANT_TYPES_SUPPORTED);
124  Util.addToListIfHas(getResponse().getAcrValuesSupported(), jsonObj, ACR_VALUES_SUPPORTED);
125  Util.addToListIfHas(getResponse().getSubjectTypesSupported(), jsonObj, SUBJECT_TYPES_SUPPORTED);
126  Util.addToListIfHas(getResponse().getUserInfoSigningAlgValuesSupported(), jsonObj, USER_INFO_SIGNING_ALG_VALUES_SUPPORTED);
127  Util.addToListIfHas(getResponse().getUserInfoEncryptionAlgValuesSupported(), jsonObj, USER_INFO_ENCRYPTION_ALG_VALUES_SUPPORTED);
128  Util.addToListIfHas(getResponse().getUserInfoEncryptionEncValuesSupported(), jsonObj, USER_INFO_ENCRYPTION_ENC_VALUES_SUPPORTED);
129  Util.addToListIfHas(getResponse().getIdTokenSigningAlgValuesSupported(), jsonObj, ID_TOKEN_SIGNING_ALG_VALUES_SUPPORTED);
130  Util.addToListIfHas(getResponse().getIdTokenEncryptionAlgValuesSupported(), jsonObj, ID_TOKEN_ENCRYPTION_ALG_VALUES_SUPPORTED);
131  Util.addToListIfHas(getResponse().getIdTokenEncryptionEncValuesSupported(), jsonObj, ID_TOKEN_ENCRYPTION_ENC_VALUES_SUPPORTED);
132  Util.addToListIfHas(getResponse().getRequestObjectSigningAlgValuesSupported(), jsonObj, REQUEST_OBJECT_SIGNING_ALG_VALUES_SUPPORTED);
133  Util.addToListIfHas(getResponse().getRequestObjectEncryptionAlgValuesSupported(), jsonObj, REQUEST_OBJECT_ENCRYPTION_ALG_VALUES_SUPPORTED);
134  Util.addToListIfHas(getResponse().getRequestObjectEncryptionEncValuesSupported(), jsonObj, REQUEST_OBJECT_ENCRYPTION_ENC_VALUES_SUPPORTED);
135  Util.addToListIfHas(getResponse().getTokenEndpointAuthMethodsSupported(), jsonObj, TOKEN_ENDPOINT_AUTH_METHODS_SUPPORTED);
136  Util.addToListIfHas(getResponse().getTokenEndpointAuthSigningAlgValuesSupported(), jsonObj, TOKEN_ENDPOINT_AUTH_SIGNING_ALG_VALUES_SUPPORTED);
137  Util.addToListIfHas(getResponse().getDisplayValuesSupported(), jsonObj, DISPLAY_VALUES_SUPPORTED);
138  Util.addToListIfHas(getResponse().getClaimTypesSupported(), jsonObj, CLAIM_TYPES_SUPPORTED);
139  Util.addToListIfHas(getResponse().getClaimsSupported(), jsonObj, CLAIMS_SUPPORTED);
140  if (jsonObj.has(SERVICE_DOCUMENTATION)) {
141  getResponse().setServiceDocumentation(jsonObj.getString(SERVICE_DOCUMENTATION));
142  }
143  Util.addToListIfHas(getResponse().getClaimsLocalesSupported(), jsonObj, CLAIMS_LOCALES_SUPPORTED);
144  Util.addToListIfHas(getResponse().getUiLocalesSupported(), jsonObj, UI_LOCALES_SUPPORTED);
145  if (jsonObj.has(CLAIMS_PARAMETER_SUPPORTED)) {
146  getResponse().setClaimsParameterSupported(jsonObj.getBoolean(CLAIMS_PARAMETER_SUPPORTED));
147  }
148  if (jsonObj.has(REQUEST_PARAMETER_SUPPORTED)) {
149  getResponse().setRequestParameterSupported(jsonObj.getBoolean(REQUEST_PARAMETER_SUPPORTED));
150  }
151  if (jsonObj.has(REQUEST_URI_PARAMETER_SUPPORTED)) {
152  getResponse().setRequestUriParameterSupported(jsonObj.getBoolean(REQUEST_URI_PARAMETER_SUPPORTED));
153  }
154  if (jsonObj.has(FRONTCHANNEL_LOGOUT_SUPPORTED)) {
155  getResponse().setFrontChannelLogoutSupported(jsonObj.getBoolean(FRONTCHANNEL_LOGOUT_SUPPORTED));
156  }
157  if (jsonObj.has(FRONTCHANNEL_LOGOUT_SESSION_SUPPORTED)) {
158  getResponse().setFrontChannelLogoutSessionSupported(jsonObj.getBoolean(FRONTCHANNEL_LOGOUT_SESSION_SUPPORTED));
159  }
160  if (jsonObj.has(REQUIRE_REQUEST_URI_REGISTRATION)) {
161  getResponse().setRequireRequestUriRegistration(jsonObj.getBoolean(REQUIRE_REQUEST_URI_REGISTRATION));
162  }
163  if (jsonObj.has(OP_POLICY_URI)) {
164  getResponse().setOpPolicyUri(jsonObj.getString(OP_POLICY_URI));
165  }
166  if (jsonObj.has(OP_TOS_URI)) {
167  getResponse().setOpTosUri(jsonObj.getString(OP_TOS_URI));
168  }
169  }
170  } catch (Exception e) {
171  LOG.error(e.getMessage(), e);
172  } finally {
173  closeConnection();
174  }
175 
176  return getResponse();
177  }
org.xdi.oxauth.client.OpenIdConfigurationClient.getHttpMethod
String getHttpMethod()
Definition: OpenIdConfigurationClient.java:43
org.xdi.oxauth.client.OpenIdConfigurationClient.LOG
static final Logger LOG
Definition: OpenIdConfigurationClient.java:29
org.xdi.oxauth.client.OpenIdConfigurationClient.mediaTypes
static final String mediaTypes
Definition: OpenIdConfigurationClient.java:31

◆ addReqParam() [1/2]

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.addReqParam ( String  p_key,
HasParamName  p_value 
)
inlineprotectedinherited
88  {
89  if (p_value != null) {
90  addReqParam(p_key, p_value.getParamName());
91  }
92  }
org.xdi.oxauth.client.BaseClient< OpenIdConfigurationRequest, OpenIdConfigurationResponse >::addReqParam
void addReqParam(String p_key, HasParamName p_value)
Definition: BaseClient.java:88

◆ addReqParam() [2/2]

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.addReqParam ( String  p_key,
String  p_value 
)
inlineprotectedinherited
94  {
95  if (Util.allNotBlank(p_key, p_value)) {
96  if (request.getAuthorizationMethod() == AuthorizationMethod.FORM_ENCODED_BODY_PARAMETER) {
97  clientRequest.formParameter(p_key, p_value);
98  } else {
99  clientRequest.queryParameter(p_key, p_value);
100  }
101  }
102  }

◆ closeConnection()

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.closeConnection ( )
inlineinherited
239  {
240  try {
241  if (clientResponse != null) {
242  clientResponse.releaseConnection();
243  }
244  if (clientRequest != null && clientRequest.getExecutor() != null) {
245  clientRequest.getExecutor().close();
246  }
247  } catch (Exception e) {
248  LOG.error(e.getMessage(), e);
249  }
250  }

◆ execOpenIdConfiguration() [1/2]

OpenIdConfigurationResponse org.xdi.oxauth.client.OpenIdConfigurationClient.execOpenIdConfiguration ( )
inline
47  {
48  initClientRequest();
49 
50  return _execOpenIdConfiguration();
51  }
org.xdi.oxauth.client.OpenIdConfigurationClient._execOpenIdConfiguration
OpenIdConfigurationResponse _execOpenIdConfiguration()
Definition: OpenIdConfigurationClient.java:65

◆ execOpenIdConfiguration() [2/2]

OpenIdConfigurationResponse org.xdi.oxauth.client.OpenIdConfigurationClient.execOpenIdConfiguration ( ClientExecutor  executor)
inline
54  {
55  this.clientRequest = new ClientRequest(getUrl(), executor);
56 
57  return _execOpenIdConfiguration();
58  }
org.xdi.oxauth.client.OpenIdConfigurationClient._execOpenIdConfiguration
OpenIdConfigurationResponse _execOpenIdConfiguration()
Definition: OpenIdConfigurationClient.java:65

◆ getCookies()

List<Cookie> org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getCookies ( )
inlineinherited
254  {
255  return cookies;
256  }

◆ getExecutor()

ClientExecutor org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getExecutor ( )
inlineinherited
80  {
81  return executor;
82  }

◆ getHeaders()

Map<String, String> org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getHeaders ( )
inlineinherited
258  {
259  return headers;
260  }

◆ getHttpMethod()

String org.xdi.oxauth.client.OpenIdConfigurationClient.getHttpMethod ( )
inline
43  {
44  return HttpMethod.GET;
45  }

◆ getRequest()

T org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getRequest ( )
inlineinherited
64  {
65  return request;
66  }

◆ getRequestAsString()

String org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getRequestAsString ( )
inlineinherited
115  {
116  StringBuilder sb = new StringBuilder();
117 
118  try {
119  URL theUrl = new URL(url);
120 
121  if (getHttpMethod().equals(HttpMethod.POST)) {
122  sb.append(HttpMethod.POST).append(" ").append(theUrl.getPath()).append(" HTTP/1.1");
123  if (StringUtils.isNotBlank(request.getContentType())) {
124  sb.append("\n");
125  sb.append("Content-Type: ").append(request.getContentType());
126  }
127  if (StringUtils.isNotBlank(request.getMediaType())) {
128  sb.append("\n");
129  sb.append("Accept: ").append(request.getMediaType());
130  }
131  sb.append("\n");
132  sb.append("Host: ").append(theUrl.getHost());
133 
134  if (request instanceof AuthorizationRequest) {
135  AuthorizationRequest authorizationRequest = (AuthorizationRequest) request;
136  if (authorizationRequest.isUseNoRedirectHeader()) {
137  sb.append("\n");
138  sb.append("X-Gluu-NoRedirect: true");
139  }
140  }
141  if (request.getAuthorizationMethod() == null) {
142  if (request.getAuthenticationMethod() == null
143  || request.getAuthenticationMethod() == AuthenticationMethod.CLIENT_SECRET_BASIC) {
144  if (request.hasCredentials()) {
145  String encodedCredentials = request.getEncodedCredentials();
146  sb.append("\n");
147  sb.append("Authorization: Basic ").append(encodedCredentials);
148  }
149  }
150  } else if (request.getAuthorizationMethod() == AuthorizationMethod.AUTHORIZATION_REQUEST_HEADER_FIELD) {
151  if (request instanceof UserInfoRequest) {
152  String accessToken = ((UserInfoRequest) request).getAccessToken();
153  sb.append("\n");
154  sb.append("Authorization: Bearer ").append(accessToken);
155  }
156  }
157 
158  sb.append("\n");
159  sb.append("\n");
160  sb.append(request.getQueryString());
161  } else if (getHttpMethod().equals(HttpMethod.GET)) {
162  sb.append("GET ").append(theUrl.getPath());
163  if (StringUtils.isNotBlank(request.getQueryString())) {
164  sb.append("?").append(request.getQueryString());
165  }
166  sb.append(" HTTP/1.1");
167  sb.append("\n");
168  sb.append("Host: ").append(theUrl.getHost());
169 
170  if (request instanceof AuthorizationRequest) {
171  AuthorizationRequest authorizationRequest = (AuthorizationRequest) request;
172  if (authorizationRequest.isUseNoRedirectHeader()) {
173  sb.append("\n");
174  sb.append("X-Gluu-NoRedirect: true");
175  }
176  }
177  if (request.getAuthorizationMethod() == null) {
178  if (request.hasCredentials()) {
179  String encodedCredentials = request.getEncodedCredentials();
180  sb.append("\n");
181  sb.append("Authorization: Basic ").append(encodedCredentials);
182  } else if (request instanceof RegisterRequest) {
183  RegisterRequest r = (RegisterRequest) request;
184  String registrationAccessToken = r.getRegistrationAccessToken();
185  sb.append("\n");
186  sb.append("Authorization: Bearer ").append(registrationAccessToken);
187  }
188  } else if (request.getAuthorizationMethod() == AuthorizationMethod.AUTHORIZATION_REQUEST_HEADER_FIELD) {
189  if (request instanceof UserInfoRequest) {
190  String accessToken = ((UserInfoRequest) request).getAccessToken();
191  sb.append("\n");
192  sb.append("Authorization: Bearer ").append(accessToken);
193  }
194  }
195  }
196  } catch (MalformedURLException e) {
197  LOG.error(e.getMessage(), e);
198  }
199 
200  return sb.toString();
201  }

◆ getResponse()

V org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getResponse ( )
inlineinherited
72  {
73  return response;
74  }

◆ getResponseAsString()

String org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getResponseAsString ( )
inlineinherited
203  {
204  StringBuilder sb = new StringBuilder();
205 
206  if (response != null) {
207  sb.append("HTTP/1.1 ").append(response.getStatus());
208  if (response.getHeaders() != null) {
209  for (String key : response.getHeaders().keySet()) {
210  sb.append("\n")
211  .append(key)
212  .append(": ")
213  .append(response.getHeaders().get(key).get(0));
214  }
215  }
216  if (response.getEntity() != null) {
217  sb.append("\n");
218  sb.append("\n");
219  sb.append(response.getEntity());
220  }
221  }
222  return sb.toString();
223  }

◆ getUrl()

String org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getUrl ( )
inlineinherited
56  {
57  return url;
58  }

◆ initClientRequest()

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.initClientRequest ( )
inlineprotectedinherited
225  {
226  if (this.executor == null) {
227  this.clientRequest = new ClientRequest(getUrl());
228  } else {
229  this.clientRequest = new ClientRequest(getUrl(), this.executor);
230  }
231  for (Cookie cookie : cookies) {
232  clientRequest.cookie(cookie);
233  }
234  for (Map.Entry<String, String> headerEntry : headers.entrySet()) {
235  clientRequest.header(headerEntry.getKey(), headerEntry.getValue());
236  }
237  }

◆ putAllFormParameters()

static void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.putAllFormParameters ( ClientRequest  p_clientRequest,
BaseRequest  p_request 
)
inlinestaticinherited
104  {
105  if (p_clientRequest != null && p_request != null) {
106  final Map<String, String> parameters = p_request.getParameters();
107  if (parameters != null && !parameters.isEmpty()) {
108  for (Map.Entry<String, String> e : parameters.entrySet()) {
109  p_clientRequest.formParameter(e.getKey(), e.getValue());
110  }
111  }
112  }
113  }

◆ setExecutor()

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.setExecutor ( ClientExecutor  executor)
inlineinherited
84  {
85  this.executor = executor;
86  }

◆ setRequest()

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.setRequest ( T  request)
inlineinherited
68  {
69  this.request = request;
70  }

◆ setResponse()

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.setResponse ( V  response)
inlineinherited
76  {
77  this.response = response;
78  }

◆ setUrl()

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.setUrl ( String  url)
inlineinherited
60  {
61  this.url = url;
62  }

メンバ詳解

◆ clientRequest

ClientRequest org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.clientRequest
protectedinherited

◆ clientResponse

ClientResponse<String> org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.clientResponse
protectedinherited

◆ executor

ClientExecutor org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.executor
protectedinherited

◆ LOG

final Logger org.xdi.oxauth.client.OpenIdConfigurationClient.LOG = Logger.getLogger(OpenIdConfigurationClient.class)
staticprivate

◆ mediaTypes

final String org.xdi.oxauth.client.OpenIdConfigurationClient.mediaTypes = String.join(",",MediaType.TEXT_PLAIN, MediaType.APPLICATION_JSON)
staticprivate

◆ request

T org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.request
protectedinherited

◆ response

V org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.response
protectedinherited
このクラス詳解は次のファイルから抽出されました:
2018年09月30日(日) 14時45分44秒作成 - gluu / 構成:   doxygen 1.8.13