org.xdi.oxauth.client.EndSessionRequest クラス

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

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

公開メンバ関数
	EndSessionRequest (String idTokenHint, String postLogoutRedirectUri, String state)
String	getIdTokenHint ()
void	setAccessToken (String idTokenHint)
String	getPostLogoutRedirectUri ()
void	setPostLogoutRedirectUri (String postLogoutRedirectUri)
String	getSessionId ()
void	setSessionId (String p_sessionId)
String	getState ()
void	setState (String state)
String	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 ()
Map< String, String >	getParameters ()
	getParameters ()
JSONObject	getJSONParameters () throws JSONException
	queryString ()

非公開変数類
String	idTokenHint
String	postLogoutRedirectUri
String	sessionId
String	state

詳解

Represents an end session request to send to the authorization server.

著者

Javier Rojas Blum

バージョン

August 9, 2017

構築子と解体子

EndSessionRequest()

org.xdi.oxauth.client.EndSessionRequest.EndSessionRequest ( String  idTokenHint, String  postLogoutRedirectUri, String  state  )

inline

Constructs an end session request.

                                                                                             {
        this.idTokenHint = idTokenHint;
        this.postLogoutRedirectUri = postLogoutRedirectUri;
        this.state = state;
    }

関数詳解

addCustomParameter() [1/2]

org.xdi.oxauth.client.BaseRequest.addCustomParameter (   $paramName,   $paramValue  )

inherited

                                                               {
        $this->customParameters[$paramName] = $paramValue;
    }

addCustomParameter() [2/2]

void org.xdi.oxauth.client.BaseRequest.addCustomParameter ( String  paramName, String  paramValue  )

inlineinherited

                                                                        {
        customParameters.put(paramName, paramValue);
    }

getAuthenticationMethod()

AuthenticationMethod org.xdi.oxauth.client.BaseRequest.getAuthenticationMethod ( )

inlineinherited

                                                          {
        return authenticationMethod;
    }

getAuthorizationMethod()

AuthorizationMethod org.xdi.oxauth.client.BaseRequest.getAuthorizationMethod ( )

inlineinherited

                                                        {
        return authorizationMethod;
    }

getAuthPassword() [1/2]

org.xdi.oxauth.client.BaseRequest.getAuthPassword ( )

inherited

                                      {
        return $this->authPassword;
    }

getAuthPassword() [2/2]

String org.xdi.oxauth.client.BaseRequest.getAuthPassword ( )

inlineinherited

                                    {
        return authPassword;
    }

getAuthUsername() [1/2]

org.xdi.oxauth.client.BaseRequest.getAuthUsername ( )

inherited

                                     {
        return $this->authUsername;
    }

getAuthUsername() [2/2]

String org.xdi.oxauth.client.BaseRequest.getAuthUsername ( )

inlineinherited

                                    {
        return authUsername;
    }

getContentType()

String org.xdi.oxauth.client.BaseRequest.getContentType ( )

inlineinherited

                                   {
        return contentType;
    }

getCredentials() [1/2]

org.xdi.oxauth.client.BaseRequest.getCredentials ( )

inherited

                                    {
        return $this->authUsername . ':' . $this->authPassword;
    }

getCredentials() [2/2]

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

inlineinherited

Returns the client credentials (URL encoded).

戻り値

The client credentials.

                                                                       {
        return URLEncoder.encode(authUsername, Util.UTF8_STRING_ENCODING)
                + ":"
                + URLEncoder.encode(authPassword, Util.UTF8_STRING_ENCODING);
    }

getCustomParameters() [1/2]

org.xdi.oxauth.client.BaseRequest.getCustomParameters ( )

inherited

                                         {
        return $this->customParameters;
    }

getCustomParameters() [2/2]

Map<String, String> org.xdi.oxauth.client.BaseRequest.getCustomParameters ( )

inlineinherited

                                                     {
        return customParameters;
    }

getEncodedCredentials() [1/2]

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

inherited

                                           {
        if($this->hasCredentials()){
            return base64_encode($this->getCredentials());
        }
        return NULL;
    }

getEncodedCredentials() [2/2]

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

inlineinherited

Returns the client credentials encoded using base64.

戻り値

The encoded client credentials.

                                          {
        try {
            if (hasCredentials()) {
                return Base64.encodeBase64String(Util.getBytes(getCredentials()));
            }
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }

        return null;
    }

getIdTokenHint()

String org.xdi.oxauth.client.EndSessionRequest.getIdTokenHint ( )

inline

Returns the issued ID Token.

戻り値

The issued ID Token.

                                   {
        return idTokenHint;
    }

getJSONParameters()

JSONObject org.xdi.oxauth.client.BaseRequest.getJSONParameters ( ) throws JSONException

inlineinherited

                                                               {
        return EMPTY_JSON_OBJECT;
    }

getMediaType()

String org.xdi.oxauth.client.BaseRequest.getMediaType ( )

inlineinherited

                                 {
        return mediaType;
    }

getParameters() [1/2]

org.xdi.oxauth.client.BaseRequest.getParameters ( )

inherited

                                   {
        return $this->EMPTY_MAP;
    }

getParameters() [2/2]

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

inlineinherited

                                               {
        return EMPTY_MAP;
    }

getPostLogoutRedirectUri()

String org.xdi.oxauth.client.EndSessionRequest.getPostLogoutRedirectUri ( )

inline

Returns the URL to which the RP is requesting that the End-User's User-Agent be redirected after a logout has been performed.

戻り値

The post logout redirection URI.

                                             {
        return postLogoutRedirectUri;
    }

getQueryString()

String org.xdi.oxauth.client.EndSessionRequest.getQueryString ( )

inline

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

戻り値

A query string of parameters.

                                   {
        StringBuilder queryStringBuilder = new StringBuilder();

        try {
            if (StringUtils.isNotBlank(idTokenHint)) {
                queryStringBuilder.append(EndSessionRequestParam.ID_TOKEN_HINT)
                        .append("=")
                        .append(idTokenHint);
            }
            if (StringUtils.isNotBlank(postLogoutRedirectUri)) {
                queryStringBuilder.append("&")
                        .append(EndSessionRequestParam.POST_LOGOUT_REDIRECT_URI)
                        .append("=")
                        .append(URLEncoder.encode(postLogoutRedirectUri, Util.UTF8_STRING_ENCODING));
            }
            if (StringUtils.isNotBlank(state)) {
                queryStringBuilder.append("&")
                        .append(EndSessionRequestParam.STATE)
                        .append("=")
                        .append(URLEncoder.encode(state, Util.UTF8_STRING_ENCODING));
            }

            if (StringUtils.isNotBlank(sessionId)) {
                queryStringBuilder.append("&")
                        .append(EndSessionRequestParam.SESSION_ID)
                        .append("=")
                        .append(URLEncoder.encode(sessionId, Util.UTF8_STRING_ENCODING));
            }
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }

        return queryStringBuilder.toString();
    }

getSessionId()

String org.xdi.oxauth.client.EndSessionRequest.getSessionId ( )

inline

Gets session id.

戻り値

session id.

                                 {
        return sessionId;
    }

getState()

String org.xdi.oxauth.client.EndSessionRequest.getState ( )

inline

Returns the state. The state is an opaque value used by the RP to maintain state between the logout request and the callback to the endpoint specified by the post_logout_redirect_uri parameter. If included in the logout request, the OP passes this value back to the RP using the state query parameter when redirecting the User Agent back to the RP.

戻り値

The state.

                             {
        return state;
    }

hasCredentials() [1/2]

org.xdi.oxauth.client.BaseRequest.hasCredentials ( )

inherited

                                    {
        return isset($this->authUsername, $this->authPassword) 
                && empty($this->authUsername) 
                && empty($this->authPassword);
    }

hasCredentials() [2/2]

boolean org.xdi.oxauth.client.BaseRequest.hasCredentials ( )

inlineinherited

                                    {
        return authUsername != null && authPassword != null
                && !authUsername.isEmpty()
                && !authPassword.isEmpty();
    }

queryString()

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

abstractinherited

setAccessToken()

void org.xdi.oxauth.client.EndSessionRequest.setAccessToken ( String  idTokenHint )

inline

Sets the issued ID Token.

引数

idTokenHint

The issued ID Token.

                                                   {
        this.idTokenHint = idTokenHint;
    }

setAuthenticationMethod()

void org.xdi.oxauth.client.BaseRequest.setAuthenticationMethod ( AuthenticationMethod  authenticationMethod )

inlineinherited

                                                                                   {
        this.authenticationMethod = authenticationMethod;
    }

setAuthorizationMethod()

void org.xdi.oxauth.client.BaseRequest.setAuthorizationMethod ( AuthorizationMethod  authorizationMethod )

inlineinherited

                                                                                {
        this.authorizationMethod = authorizationMethod;
    }

setAuthPassword() [1/2]

org.xdi.oxauth.client.BaseRequest.setAuthPassword (   $authPassword )

inherited

                                                   {
        $this->authPassword = $authPassword;
    }

setAuthPassword() [2/2]

void org.xdi.oxauth.client.BaseRequest.setAuthPassword ( String  authPassword )

inlineinherited

                                                     {
        this.authPassword = authPassword;
    }

setAuthUsername() [1/2]

org.xdi.oxauth.client.BaseRequest.setAuthUsername (   $authUsername )

inherited

                                                  {
        $this->authUsername = $authUsername;
    }

setAuthUsername() [2/2]

void org.xdi.oxauth.client.BaseRequest.setAuthUsername ( String  authUsername )

inlineinherited

                                                     {
        this.authUsername = authUsername;
    }

setContentType()

void org.xdi.oxauth.client.BaseRequest.setContentType ( String  contentType )

inlineinherited

                                                   {
        this.contentType = contentType;
    }

setMediaType()

void org.xdi.oxauth.client.BaseRequest.setMediaType ( String  mediaType )

inlineinherited

                                               {
        this.mediaType = mediaType;
    }

setPostLogoutRedirectUri()

void org.xdi.oxauth.client.EndSessionRequest.setPostLogoutRedirectUri ( String  postLogoutRedirectUri )

inline

Sets the URL to which the RP is requesting that the End-User's User-Agent be redirected after a logout has been performed.

引数

postLogoutRedirectUri

The post logout redirection URI.

                                                                       {
        this.postLogoutRedirectUri = postLogoutRedirectUri;
    }

setSessionId()

void org.xdi.oxauth.client.EndSessionRequest.setSessionId ( String  p_sessionId )

inline

Sets session id.

引数

p_sessionId

session id

                                                 {
        sessionId = p_sessionId;
    }

setState()

void org.xdi.oxauth.client.EndSessionRequest.setState ( String  state )

inline

Sets the state. The state is an opaque value used by the RP to maintain state between the logout request and the callback to the endpoint specified by the post_logout_redirect_uri parameter. If included in the logout request, the OP passes this value back to the RP using the state query parameter when redirecting the User Agent back to the RP.

引数

state

he state.

                                       {
        this.state = state;
    }

メンバ詳解

idTokenHint

String org.xdi.oxauth.client.EndSessionRequest.idTokenHint

private

postLogoutRedirectUri

String org.xdi.oxauth.client.EndSessionRequest.postLogoutRedirectUri

private

sessionId

String org.xdi.oxauth.client.EndSessionRequest.sessionId

private

state

String org.xdi.oxauth.client.EndSessionRequest.state

private

---

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

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