org.xdi.oxauth.client.UserInfoClient の継承関係図

org.xdi.oxauth.client.UserInfoClient 連携図

公開メンバ関数
	UserInfoClient (String url)

String	getHttpMethod ()

UserInfoResponse	execUserInfo (String accessToken)

UserInfoResponse	exec ()

void	setSharedKey (String sharedKey)

void	setPrivateKey (PrivateKey privateKey)

String	getJwksUri ()

void	setJwksUri (String jwksUri)

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

非公開変数類
String	sharedKey

PrivateKey	privateKey

String	jwksUri

詳解

Encapsulates functionality to make user info request calls to an authorization server via REST Services.

著者: Javier Rojas Blum

バージョン: December 26, 2016

構築子と解体子

◆ UserInfoClient()

org.xdi.oxauth.client.UserInfoClient.UserInfoClient ( String url )

inline

Constructs an User Info client by providing a REST url where the service is located.

引数

url	The REST Service location.

                                       {
         super(url);
     }

関数詳解

◆ addReqParam() [1/2]

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.addReqParam	(	String	p_key,
		HasParamName	p_value
	)

inlineprotectedinherited

                                                                    {
         if (p_value != null) {
             addReqParam(p_key, p_value.getParamName());
         }
     }

◆ addReqParam() [2/2]

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.addReqParam	(	String	p_key,
		String	p_value
	)

inlineprotectedinherited

                                                              {
         if (Util.allNotBlank(p_key, p_value)) {
             if (request.getAuthorizationMethod() == AuthorizationMethod.FORM_ENCODED_BODY_PARAMETER) {
                 clientRequest.formParameter(p_key, p_value);
             } else {
                 clientRequest.queryParameter(p_key, p_value);
             }
         }
     }

◆ closeConnection()

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.closeConnection ( )

inlineinherited

                                   {
         try {
             if (clientResponse != null) {
                 clientResponse.releaseConnection();
             }
             if (clientRequest != null && clientRequest.getExecutor() != null) {
                 clientRequest.getExecutor().close();
             }
         } catch (Exception e) {
             LOG.error(e.getMessage(), e);
         }
     }

◆ exec()

UserInfoResponse org.xdi.oxauth.client.UserInfoClient.exec ( )

inline

Executes the call to the REST Service and processes the response.

戻り値: The service response.

                                    {
         // Prepare request parameters
         initClientRequest();
         clientRequest.header("Content-Type", MediaType.APPLICATION_FORM_URLENCODED);
         clientRequest.setHttpMethod(getHttpMethod());
 
         if (getRequest().getAuthorizationMethod() == null
                 || getRequest().getAuthorizationMethod() == AuthorizationMethod.AUTHORIZATION_REQUEST_HEADER_FIELD) {
             if (StringUtils.isNotBlank(getRequest().getAccessToken())) {
                 clientRequest.header("Authorization", "Bearer " + getRequest().getAccessToken());
             }
         } else if (getRequest().getAuthorizationMethod() == AuthorizationMethod.FORM_ENCODED_BODY_PARAMETER) {
             if (StringUtils.isNotBlank(getRequest().getAccessToken())) {
                 clientRequest.formParameter("access_token", getRequest().getAccessToken());
             }
         } else if (getRequest().getAuthorizationMethod() == AuthorizationMethod.URL_QUERY_PARAMETER) {
             if (StringUtils.isNotBlank(getRequest().getAccessToken())) {
                 clientRequest.queryParameter("access_token", getRequest().getAccessToken());
             }
         }
 
         // Call REST Service and handle response
         try {
             if (getRequest().getAuthorizationMethod() == null
                     || getRequest().getAuthorizationMethod() == AuthorizationMethod.AUTHORIZATION_REQUEST_HEADER_FIELD
                     || getRequest().getAuthorizationMethod() == AuthorizationMethod.URL_QUERY_PARAMETER) {
                 clientResponse = clientRequest.get(String.class);
             } else if (getRequest().getAuthorizationMethod() == AuthorizationMethod.FORM_ENCODED_BODY_PARAMETER) {
                 clientResponse = clientRequest.post(String.class);
             }
 
             int status = clientResponse.getStatus();
 
             setResponse(new UserInfoResponse(status));
 
             String entity = clientResponse.getEntity(String.class);
             getResponse().setEntity(entity);
             getResponse().setHeaders(clientResponse.getMetadata());
             if (StringUtils.isNotBlank(entity)) {
                 List<Object> contentType = clientResponse.getHeaders().get("Content-Type");
                 if (contentType != null && contentType.contains("application/jwt")) {
                     String[] jwtParts = entity.split("\\.");
                     if (jwtParts.length == 5) {
                         byte[] sharedSymmetricKey = sharedKey != null ? sharedKey.getBytes(Util.UTF8_STRING_ENCODING) : null;
                         Jwe jwe = Jwe.parse(entity, privateKey, sharedSymmetricKey);
                         getResponse().setClaims(jwe.getClaims().toMap());
                     } else {
                         Jwt jwt = Jwt.parse(entity);
 
                         OxAuthCryptoProvider cryptoProvider = new OxAuthCryptoProvider();
                         boolean signatureVerified = cryptoProvider.verifySignature(
                                 jwt.getSigningInput(),
                                 jwt.getEncodedSignature(),
                                 jwt.getHeader().getKeyId(),
                                 JwtUtil.getJSONWebKeys(jwksUri),
                                 sharedKey,
                                 jwt.getHeader().getAlgorithm());
 
                         if (signatureVerified) {
                             getResponse().setClaims(jwt.getClaims().toMap());
                         }
                     }
                 } else {
                     try {
                         JSONObject jsonObj = new JSONObject(entity);
 
                         if (jsonObj.has("error")) {
                             getResponse().setErrorType(UserInfoErrorResponseType.fromString(jsonObj.getString("error")));
                             jsonObj.remove("error");
                         }
                         if (jsonObj.has("error_description")) {
                             getResponse().setErrorDescription(jsonObj.getString("error_description"));
                             jsonObj.remove("error_description");
                         }
                         if (jsonObj.has("error_uri")) {
                             getResponse().setErrorUri(jsonObj.getString("error_uri"));
                             jsonObj.remove("error_uri");
                         }
 
                         for (Iterator<String> iterator = jsonObj.keys(); iterator.hasNext(); ) {
                             String key = iterator.next();
                             List<String> values = new ArrayList<String>();
 
                             JSONArray jsonArray = jsonObj.optJSONArray(key);
                             if (jsonArray != null) {
                                 for (int i = 0; i < jsonArray.length(); i++) {
                                     String value = jsonArray.optString(i);
                                     if (value != null) {
                                         values.add(value);
                                     }
                                 }
                             } else {
                                 String value = jsonObj.optString(key);
                                 if (value != null) {
                                     values.add(value);
                                 }
                             }
 
                             getResponse().getClaims().put(key, values);
                         }
                     } catch (JSONException e) {
                         e.printStackTrace();
                     }
                 }
             }
         } catch (Exception e) {
             e.printStackTrace();
         } finally {
             closeConnection();
         }
 
         return getResponse();
     }

◆ execUserInfo()

UserInfoResponse org.xdi.oxauth.client.UserInfoClient.execUserInfo ( String accessToken )

inline

Executes the call to the REST Service and processes the response.

引数

accessToken The access token obtained from the oxAuth authorization request.

戻り値: The service response.

                                                              {
         setRequest(new UserInfoRequest(accessToken));
 
         return exec();
     }

◆ getCookies()

List<Cookie> org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getCookies ( )

inlineinherited

                                      {
         return cookies;
     }

◆ getExecutor()

ClientExecutor org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getExecutor ( )

inlineinherited

                                         {
         return executor;
     }

◆ getHeaders()

Map<String, String> org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getHeaders ( )

inlineinherited

                                             {
         return headers;
     }

◆ getHttpMethod()

String org.xdi.oxauth.client.UserInfoClient.getHttpMethod ( )

inline

                                   {
         if (request.getAuthorizationMethod() == null
                 || request.getAuthorizationMethod() == AuthorizationMethod.AUTHORIZATION_REQUEST_HEADER_FIELD
                 || request.getAuthorizationMethod() == AuthorizationMethod.URL_QUERY_PARAMETER) {
             return HttpMethod.GET;
         } else /*if (request.getAuthorizationMethod() == AuthorizationMethod.FORM_ENCODED_BODY_PARAMETER)*/ {
             return HttpMethod.POST;
         }
     }

◆ getJwksUri()

String org.xdi.oxauth.client.UserInfoClient.getJwksUri ( )

inline

                                {
         return jwksUri;
     }

◆ getRequest()

T org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getRequest ( )

inlineinherited

                           {
         return request;
     }

◆ getRequestAsString()

String org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getRequestAsString ( )

inlineinherited

                                        {
         StringBuilder sb = new StringBuilder();
 
         try {
             URL theUrl = new URL(url);
 
             if (getHttpMethod().equals(HttpMethod.POST)) {
                 sb.append(HttpMethod.POST).append(" ").append(theUrl.getPath()).append(" HTTP/1.1");
                 if (StringUtils.isNotBlank(request.getContentType())) {
                     sb.append("\n");
                     sb.append("Content-Type: ").append(request.getContentType());
                 }
                 if (StringUtils.isNotBlank(request.getMediaType())) {
                     sb.append("\n");
                     sb.append("Accept: ").append(request.getMediaType());
                 }
                 sb.append("\n");
                 sb.append("Host: ").append(theUrl.getHost());
 
                 if (request instanceof AuthorizationRequest) {
                     AuthorizationRequest authorizationRequest = (AuthorizationRequest) request;
                     if (authorizationRequest.isUseNoRedirectHeader()) {
                         sb.append("\n");
                         sb.append("X-Gluu-NoRedirect: true");
                     }
                 }
                 if (request.getAuthorizationMethod() == null) {
                     if (request.getAuthenticationMethod() == null
                             || request.getAuthenticationMethod() == AuthenticationMethod.CLIENT_SECRET_BASIC) {
                         if (request.hasCredentials()) {
                             String encodedCredentials = request.getEncodedCredentials();
                             sb.append("\n");
                             sb.append("Authorization: Basic ").append(encodedCredentials);
                         }
                     }
                 } else if (request.getAuthorizationMethod() == AuthorizationMethod.AUTHORIZATION_REQUEST_HEADER_FIELD) {
                     if (request instanceof UserInfoRequest) {
                         String accessToken = ((UserInfoRequest) request).getAccessToken();
                         sb.append("\n");
                         sb.append("Authorization: Bearer ").append(accessToken);
                     }
                 }
 
                 sb.append("\n");
                 sb.append("\n");
                 sb.append(request.getQueryString());
             } else if (getHttpMethod().equals(HttpMethod.GET)) {
                 sb.append("GET ").append(theUrl.getPath());
                 if (StringUtils.isNotBlank(request.getQueryString())) {
                     sb.append("?").append(request.getQueryString());
                 }
                 sb.append(" HTTP/1.1");
                 sb.append("\n");
                 sb.append("Host: ").append(theUrl.getHost());
 
                 if (request instanceof AuthorizationRequest) {
                     AuthorizationRequest authorizationRequest = (AuthorizationRequest) request;
                     if (authorizationRequest.isUseNoRedirectHeader()) {
                         sb.append("\n");
                         sb.append("X-Gluu-NoRedirect: true");
                     }
                 }
                 if (request.getAuthorizationMethod() == null) {
                     if (request.hasCredentials()) {
                         String encodedCredentials = request.getEncodedCredentials();
                         sb.append("\n");
                         sb.append("Authorization: Basic ").append(encodedCredentials);
                     } else if (request instanceof RegisterRequest) {
                         RegisterRequest r = (RegisterRequest) request;
                         String registrationAccessToken = r.getRegistrationAccessToken();
                         sb.append("\n");
                         sb.append("Authorization: Bearer ").append(registrationAccessToken);
                     }
                 } else if (request.getAuthorizationMethod() == AuthorizationMethod.AUTHORIZATION_REQUEST_HEADER_FIELD) {
                     if (request instanceof UserInfoRequest) {
                         String accessToken = ((UserInfoRequest) request).getAccessToken();
                         sb.append("\n");
                         sb.append("Authorization: Bearer ").append(accessToken);
                     }
                 }
             }
         } catch (MalformedURLException e) {
             LOG.error(e.getMessage(), e);
         }
 
         return sb.toString();
     }

◆ getResponse()

V org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getResponse ( )

inlineinherited

                            {
         return response;
     }

◆ getResponseAsString()

String org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getResponseAsString ( )

inlineinherited

                                         {
         StringBuilder sb = new StringBuilder();
 
         if (response != null) {
             sb.append("HTTP/1.1 ").append(response.getStatus());
             if (response.getHeaders() != null) {
                 for (String key : response.getHeaders().keySet()) {
                     sb.append("\n")
                             .append(key)
                             .append(": ")
                             .append(response.getHeaders().get(key).get(0));
                 }
             }
             if (response.getEntity() != null) {
                 sb.append("\n");
                 sb.append("\n");
                 sb.append(response.getEntity());
             }
         }
         return sb.toString();
     }

◆ getUrl()

String org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.getUrl ( )

inlineinherited

                            {
         return url;
     }

◆ initClientRequest()

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.initClientRequest ( )

inlineprotectedinherited

                                        {
         if (this.executor == null) {
             this.clientRequest = new ClientRequest(getUrl());
         } else {
             this.clientRequest = new ClientRequest(getUrl(), this.executor);
         }
         for (Cookie cookie : cookies) {
             clientRequest.cookie(cookie);
         }
         for (Map.Entry<String, String> headerEntry : headers.entrySet()) {
             clientRequest.header(headerEntry.getKey(), headerEntry.getValue());
         }
     }

◆ putAllFormParameters()

static void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.putAllFormParameters	(	ClientRequest	p_clientRequest,
		BaseRequest	p_request
	)

inlinestaticinherited

                                                                                                   {
         if (p_clientRequest != null && p_request != null) {
             final Map<String, String> parameters = p_request.getParameters();
             if (parameters != null && !parameters.isEmpty()) {
                 for (Map.Entry<String, String> e : parameters.entrySet()) {
                     p_clientRequest.formParameter(e.getKey(), e.getValue());
                 }
             }
         }
     }

◆ setExecutor()

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.setExecutor ( ClientExecutor executor )

inlineinherited

                                                      {
         this.executor = executor;
     }

◆ setJwksUri()

void org.xdi.oxauth.client.UserInfoClient.setJwksUri ( String jwksUri )

inline

                                            {
         this.jwksUri = jwksUri;
     }

◆ setPrivateKey()

void org.xdi.oxauth.client.UserInfoClient.setPrivateKey ( PrivateKey privateKey )

inline

                                                      {
         this.privateKey = privateKey;
     }

◆ setRequest()

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.setRequest ( T request )

inlineinherited

                                       {
         this.request = request;
     }

◆ setResponse()

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.setResponse ( V response )

inlineinherited

                                         {
         this.response = response;
     }

◆ setSharedKey()

void org.xdi.oxauth.client.UserInfoClient.setSharedKey ( String sharedKey )

inline

                                                {
         this.sharedKey = sharedKey;
     }

◆ setUrl()

void org.xdi.oxauth.client.BaseClient< T extends BaseRequest, V extends BaseResponse >.setUrl ( String url )

inlineinherited

                                    {
         this.url = url;
     }

メンバ詳解

◆ 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

◆ jwksUri

String org.xdi.oxauth.client.UserInfoClient.jwksUri

private

◆ privateKey

PrivateKey org.xdi.oxauth.client.UserInfoClient.privateKey

private

◆ 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

◆ sharedKey

String org.xdi.oxauth.client.UserInfoClient.sharedKey

private

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

D:/AppData/OpenId/gluu/src/oxAuth/Client/src/main/java/org/xdi/oxauth/client/UserInfoClient.java

公開メンバ関数

静的公開メンバ関数

限定公開メンバ関数

限定公開変数類

非公開変数類

詳解

構築子と解体子

◆ UserInfoClient()

関数詳解

◆ addReqParam() [1/2]

◆ addReqParam() [2/2]

◆ closeConnection()

◆ exec()

◆ execUserInfo()

◆ getCookies()

◆ getExecutor()

◆ getHeaders()

◆ getHttpMethod()

◆ getJwksUri()

◆ getRequest()

◆ getRequestAsString()

◆ getResponse()

◆ getResponseAsString()

◆ getUrl()

◆ initClientRequest()

◆ putAllFormParameters()

◆ setExecutor()

◆ setJwksUri()

◆ setPrivateKey()

◆ setRequest()

◆ setResponse()

◆ setSharedKey()

◆ setUrl()

メンバ詳解

◆ clientRequest

◆ clientResponse

◆ executor

◆ jwksUri

◆ privateKey

◆ request

◆ response

◆ sharedKey