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

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

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

String	getHttpMethod ()

EndSessionResponse	execEndSession (String idTokenHint, String postLogoutRedirectUri, String state)

EndSessionResponse	exec ()

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

静的非公開変数類
static final String	mediaType = MediaType.TEXT_PLAIN

詳解

Encapsulates functionality to make end session request calls to an authorization server via REST Services.

著者: Javier Rojas Blum

バージョン: August 9, 2017

構築子と解体子

◆ EndSessionClient()

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

inline

Constructs an end session client by providing an URL where the REST 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()

EndSessionResponse org.xdi.oxauth.client.EndSessionClient.exec ( )

inline

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

戻り値: The service response.

                                      {
         // Prepare request parameters
         initClientRequest();
         clientRequest.accept(mediaType);
         clientRequest.setHttpMethod(getHttpMethod());
 
         if (StringUtils.isNotBlank(getRequest().getIdTokenHint())) {
             clientRequest.queryParameter(EndSessionRequestParam.ID_TOKEN_HINT, getRequest().getIdTokenHint());
         }
         if (StringUtils.isNotBlank(getRequest().getPostLogoutRedirectUri())) {
             clientRequest.queryParameter(EndSessionRequestParam.POST_LOGOUT_REDIRECT_URI, getRequest().getPostLogoutRedirectUri());
         }
         if (StringUtils.isNotBlank(getRequest().getState())) {
             clientRequest.queryParameter(EndSessionRequestParam.STATE, getRequest().getState());
         }
         if (StringUtils.isNotBlank(getRequest().getSessionId())) {
             clientRequest.queryParameter(EndSessionRequestParam.SESSION_ID, getRequest().getSessionId());
         }
 
         // Call REST Service and handle response
         try {
             clientResponse = clientRequest.get(String.class);
             int status = clientResponse.getStatus();
 
             setResponse(new EndSessionResponse(status));
             String entity = clientResponse.getEntity(String.class);
             getResponse().setEntity(entity);
             getResponse().setHeaders(clientResponse.getMetadata());
             if (clientResponse.getLocationLink() != null) {
                 String location = clientResponse.getLocationLink().getHref();
                 getResponse().setLocation(location);
 
                 int queryStringIndex = location.indexOf("?");
                 if (queryStringIndex != -1) {
                     String queryString = location
                             .substring(queryStringIndex + 1);
                     Map<String, String> params = QueryStringDecoder.decode(queryString);
                     if (params.containsKey(EndSessionResponseParam.STATE)) {
                         getResponse().setState(params.get(EndSessionResponseParam.STATE));
                     }
                 }
             }
 
             if (!Util.isNullOrEmpty(entity) && !entity.contains("<html>")) {
                 try {
                     JSONObject jsonObj = new JSONObject(entity);
                     if (jsonObj.has("error")) {
                         getResponse().setErrorType(EndSessionErrorResponseType.fromString(jsonObj.getString("error")));
                     }
                     if (jsonObj.has("error_description")) {
                         getResponse().setErrorDescription(jsonObj.getString("error_description"));
                     }
                     if (jsonObj.has("error_uri")) {
                         getResponse().setErrorUri(jsonObj.getString("error_uri"));
                     }
                 } catch (JSONException e) {
                     e.printStackTrace();
                 }
             }
         } catch (Exception e) {
             e.printStackTrace();
         } finally {
             closeConnection();
         }
 
         return getResponse();
     }

◆ execEndSession()

EndSessionResponse org.xdi.oxauth.client.EndSessionClient.execEndSession	(	String	idTokenHint,
		String	postLogoutRedirectUri,
		String	state
	)

inline

Executes the call to the REST Service requesting to end session and processes the response.

引数

idTokenHint	The issued ID Token.
postLogoutRedirectUri	The URL to which the RP is requesting that the End-User's User-Agent be redirected after a logout has been performed.
state	The state.

戻り値: The service response.

                                                                                                              {
         setRequest(new EndSessionRequest(idTokenHint, postLogoutRedirectUri, state));
 
         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.EndSessionClient.getHttpMethod ( )

inline

                                   {
         return HttpMethod.GET;
     }

◆ 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;
     }

◆ 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;
     }

◆ 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

◆ mediaType

final String org.xdi.oxauth.client.EndSessionClient.mediaType = MediaType.TEXT_PLAIN

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

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

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

公開メンバ関数

静的公開メンバ関数

限定公開メンバ関数

限定公開変数類

静的非公開変数類

詳解

構築子と解体子

◆ EndSessionClient()

関数詳解

◆ addReqParam() [1/2]

◆ addReqParam() [2/2]

◆ closeConnection()

◆ exec()

◆ execEndSession()

◆ getCookies()

◆ getExecutor()

◆ getHeaders()

◆ getHttpMethod()

◆ getRequest()

◆ getRequestAsString()

◆ getResponse()

◆ getResponseAsString()

◆ getUrl()

◆ initClientRequest()

◆ putAllFormParameters()

◆ setExecutor()

◆ setRequest()

◆ setResponse()

◆ setUrl()

メンバ詳解

◆ clientRequest

◆ clientResponse

◆ executor

◆ mediaType

◆ request

◆ response