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

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

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

公開メンバ関数
	AuthorizationResponse (ClientResponse< String > clientResponse)
	AuthorizationResponse (String location)
String	getCode ()
void	setCode (String code)
String	getAccessToken ()
void	setAccessToken (String accessToken)
String	getSessionId ()
void	setSessionId (String p_sessionId)
Map< String, String >	getCustomParams ()
void	setCustomParams (Map< String, String > customParams)
ResponseMode	getResponseMode ()
void	setResponseMode (ResponseMode responseMode)
TokenType	getTokenType ()
void	setTokenType (TokenType tokenType)
Integer	getExpiresIn ()
void	setExpiresIn (Integer expiresIn)
String	getScope ()
void	setScope (String scope)
String	getIdToken ()
void	setIdToken (String idToken)
String	getState ()
void	setState (String state)
AuthorizeErrorResponseType	getErrorType ()
void	setErrorType (AuthorizeErrorResponseType errorType)
String	getErrorDescription ()
void	setErrorDescription (String errorDescription)
String	getErrorUri ()
void	setErrorUri (String errorUri)
int	getStatus ()
String	getLocation ()
void	setLocation (String location)
void	setStatus (int status)
String	getEntity ()
void	setEntity (String entity)
MultivaluedMap< String, Object >	getHeaders ()
void	setHeaders (MultivaluedMap< String, Object > headers)

限定公開変数類
int	status
String	location
String	entity
MultivaluedMap< String, Object >	headers

非公開メンバ関数
void	processLocation ()

非公開変数類
String	code
String	accessToken
TokenType	tokenType
Integer	expiresIn
String	scope
String	idToken
String	state
String	sessionId
Map< String, String >	customParams
ResponseMode	responseMode
AuthorizeErrorResponseType	errorType
String	errorDescription
String	errorUri

詳解

Represents an authorization response received from the authorization server.

著者

Javier Rojas Blum

バージョン

August 9, 2017

構築子と解体子

AuthorizationResponse() [1/2]

org.xdi.oxauth.client.AuthorizationResponse.AuthorizationResponse ( ClientResponse< String >  clientResponse )

inline

Constructs an authorization response.

                                                                        {
        super(clientResponse);
        customParams = new HashMap<String, String>();

        if (StringUtils.isNotBlank(entity)) {
            try {
                JSONObject jsonObj = new JSONObject(entity);
                if (jsonObj.has("error")) {
                    errorType = AuthorizeErrorResponseType.fromString(jsonObj.getString("error"));
                }
                if (jsonObj.has("error_description")) {
                    errorDescription = jsonObj.getString("error_description");
                }
                if (jsonObj.has("error_uri")) {
                    errorUri = jsonObj.getString("error_uri");
                }
                if (jsonObj.has("state")) {
                    state = jsonObj.getString("state");
                }
                if (jsonObj.has("redirect")) {
                    location = jsonObj.getString("redirect");
                }
            } catch (JSONException e) {
                e.printStackTrace();
            }
        }
        processLocation();
    }

AuthorizationResponse() [2/2]

org.xdi.oxauth.client.AuthorizationResponse.AuthorizationResponse ( String  location )

inline

                                                  {
        this.location = location;
        customParams = new HashMap<String, String>();

        processLocation();
    }

関数詳解

getAccessToken()

String org.xdi.oxauth.client.AuthorizationResponse.getAccessToken ( )

inline

Returns the access token issued by the authorization server.

戻り値

The access token.

                                   {
        return accessToken;
    }

getCode()

String org.xdi.oxauth.client.AuthorizationResponse.getCode ( )

inline

Returns the authorization code generated by the authorization server.

戻り値

The authorization code.

                            {
        return code;
    }

getCustomParams()

Map<String, String> org.xdi.oxauth.client.AuthorizationResponse.getCustomParams ( )

inline

                                                 {
        return customParams;
    }

getEntity()

String org.xdi.oxauth.client.BaseResponse.getEntity ( )

inlineinherited

Returns the entity or body content of the response.

戻り値

The entity or body content of the response.

                              {
        return entity;
    }

getErrorDescription()

String org.xdi.oxauth.client.AuthorizationResponse.getErrorDescription ( )

inline

Returns a human-readable UTF-8 encoded text providing additional information, used to assist the client developer in understanding the error that occurred.

戻り値

The error description.

                                        {
        return errorDescription;
    }

getErrorType()

AuthorizeErrorResponseType org.xdi.oxauth.client.AuthorizationResponse.getErrorType ( )

inline

Returns the error code when the request fails, otherwise will return null.

戻り値

The error code when the request fails.

                                                     {
        return errorType;
    }

getErrorUri()

String org.xdi.oxauth.client.AuthorizationResponse.getErrorUri ( )

inline

Returns a URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.

戻り値

A URI with information about the error.

                                {
        return errorUri;
    }

getExpiresIn()

Integer org.xdi.oxauth.client.AuthorizationResponse.getExpiresIn ( )

inline

Returns the lifetime in seconds of the access token. For example, the value 3600 denotes that the access token will expire in one hour from the time the response was generated.

戻り値

The lifetime in seconds of the access token.

                                  {
        return expiresIn;
    }

getHeaders()

MultivaluedMap<String, Object> org.xdi.oxauth.client.BaseResponse.getHeaders ( )

inlineinherited

                                                       {
        return headers;
    }

getIdToken()

String org.xdi.oxauth.client.AuthorizationResponse.getIdToken ( )

inline

Returns the ID Token of the for the authentication session.

戻り値

The ID Token.

                               {
        return idToken;
    }

getLocation()

String org.xdi.oxauth.client.BaseResponse.getLocation ( )

inlineinherited

Returns the location of the response in the header.

戻り値

The location of the response.

                                {
        return location;
    }

getResponseMode()

ResponseMode org.xdi.oxauth.client.AuthorizationResponse.getResponseMode ( )

inline

                                          {
        return responseMode;
    }

getScope()

String org.xdi.oxauth.client.AuthorizationResponse.getScope ( )

inline

Returns the scope of the access token.

戻り値

The scope of the access token.

                             {
        return scope;
    }

getSessionId()

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

inline

Gets session id.

戻り値

session id.

                                 {
        return sessionId;
    }

getState()

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

inline

Returns the state. If the state parameter was present in the client authorization request, the exact value received from the client.

戻り値

The state.

                             {
        return state;
    }

getStatus()

int org.xdi.oxauth.client.BaseResponse.getStatus ( )

inlineinherited

Returns the HTTP status code of the response.

戻り値

The HTTP status code.

                           {
        return status;
    }

getTokenType()

TokenType org.xdi.oxauth.client.AuthorizationResponse.getTokenType ( )

inline

Returns the type of the token issued (value is case insensitive).

戻り値

The type of the token.

                                    {
        return tokenType;
    }

processLocation()

void org.xdi.oxauth.client.AuthorizationResponse.processLocation ( )

inlineprivate

                                   {
        try {
            if (StringUtils.isNotBlank(location)) {
                Map<String, String> params = null;
                int fragmentIndex = location.indexOf("#");
                if (fragmentIndex != -1) {
                    responseMode = ResponseMode.FRAGMENT;
                    String fragment = location.substring(fragmentIndex + 1);
                    params = QueryStringDecoder.decode(fragment);
                } else {
                    int queryStringIndex = location.indexOf("?");
                    if (queryStringIndex != -1) {
                        responseMode = ResponseMode.QUERY;
                        String queryString = location.substring(queryStringIndex + 1);
                        params = QueryStringDecoder.decode(queryString);
                    }
                }

                if (params != null) {
                    if (params.containsKey(CODE)) {
                        code = params.get(CODE);
                        params.remove(CODE);
                    }
                    if (params.containsKey(SESSION_ID)) {
                        sessionId = params.get(SESSION_ID);
                        params.remove(SESSION_ID);
                    }
                    if (params.containsKey(ACCESS_TOKEN)) {
                        accessToken = params.get(ACCESS_TOKEN);
                        params.remove(ACCESS_TOKEN);
                    }
                    if (params.containsKey(TOKEN_TYPE)) {
                        tokenType = TokenType.fromString(params.get(TOKEN_TYPE));
                        params.remove(TOKEN_TYPE);
                    }
                    if (params.containsKey(EXPIRES_IN)) {
                        expiresIn = Integer.parseInt(params.get(EXPIRES_IN));
                        params.remove(EXPIRES_IN);
                    }
                    if (params.containsKey(SCOPE)) {
                        scope = URLDecoder.decode(params.get(SCOPE), Util.UTF8_STRING_ENCODING);
                        params.remove(SCOPE);
                    }
                    if (params.containsKey(ID_TOKEN)) {
                        idToken = params.get(ID_TOKEN);
                        params.remove(ID_TOKEN);
                    }
                    if (params.containsKey(STATE)) {
                        state = params.get(STATE);
                        params.remove(STATE);
                    }
                    if (params.containsKey("error")) {
                        errorType = AuthorizeErrorResponseType.fromString(params.get("error"));
                        params.remove("error");
                    }
                    if (params.containsKey("error_description")) {
                        errorDescription = URLDecoder.decode(params.get("error_description"), Util.UTF8_STRING_ENCODING);
                        params.remove("error_description");
                    }
                    if (params.containsKey("error_uri")) {
                        errorUri = URLDecoder.decode(params.get("error_uri"), Util.UTF8_STRING_ENCODING);
                        params.remove("error_uri");
                    }

                    for (Iterator<String> it = params.keySet().iterator(); it.hasNext(); ) {
                        String key = it.next();
                        getCustomParams().put(key, params.get(key));
                    }
                }
            }
        } catch (UnsupportedEncodingException e) {
        }
    }

setAccessToken()

void org.xdi.oxauth.client.AuthorizationResponse.setAccessToken ( String  accessToken )

inline

Sets the access token issued by the authorization server.

引数

accessToken

The access token.

                                                   {
        this.accessToken = accessToken;
    }

setCode()

void org.xdi.oxauth.client.AuthorizationResponse.setCode ( String  code )

inline

Sets the authorization code generated by the authorization server.

引数

code	The authorization code.

                                     {
        this.code = code;
    }

setCustomParams()

void org.xdi.oxauth.client.AuthorizationResponse.setCustomParams ( Map< String, String >  customParams )

inline

                                                                  {
        this.customParams = customParams;
    }

setEntity()

void org.xdi.oxauth.client.BaseResponse.setEntity ( String  entity )

inlineinherited

Sets the entity or body content of the response.

引数

entity

The entity or body content of the response.

                                         {
        this.entity = entity;
    }

setErrorDescription()

void org.xdi.oxauth.client.AuthorizationResponse.setErrorDescription ( String  errorDescription )

inline

Sets a human-readable UTF-8 encoded text providing additional information, used to assist the client developer in understanding the error that occurred.

引数

errorDescription

The error description.

                                                             {
        this.errorDescription = errorDescription;
    }

setErrorType()

void org.xdi.oxauth.client.AuthorizationResponse.setErrorType ( AuthorizeErrorResponseType  errorType )

inline

Sets the error code when the request fails, otherwise will return null.

引数

errorType

The error code when the request fails.

                                                                   {
        this.errorType = errorType;
    }

setErrorUri()

void org.xdi.oxauth.client.AuthorizationResponse.setErrorUri ( String  errorUri )

inline

Sets a URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.

引数

errorUri

A URI with information about the error.

                                             {
        this.errorUri = errorUri;
    }

setExpiresIn()

void org.xdi.oxauth.client.AuthorizationResponse.setExpiresIn ( Integer  expiresIn )

inline

Sets the lifetime in seconds of the access token. For example, the value 3600 denotes that the access token will expire in one hour from the time the response was generated.

引数

expiresIn

The lifetime in seconds of the access token.

                                                {
        this.expiresIn = expiresIn;
    }

setHeaders()

void org.xdi.oxauth.client.BaseResponse.setHeaders ( MultivaluedMap< String, Object >  headers )

inlineinherited

                                                                   {
        this.headers = headers;
    }

setIdToken()

void org.xdi.oxauth.client.AuthorizationResponse.setIdToken ( String  idToken )

inline

Sets the ID Token of the for the authentication session.

引数

idToken

The ID Token.

                                           {
        this.idToken = idToken;
    }

setLocation()

void org.xdi.oxauth.client.BaseResponse.setLocation ( String  location )

inlineinherited

Sets the location of the response in the header.

引数

location

The location of the response.

                                             {
        this.location = location;
    }

setResponseMode()

void org.xdi.oxauth.client.AuthorizationResponse.setResponseMode ( ResponseMode  responseMode )

inline

                                                           {
        this.responseMode = responseMode;
    }

setScope()

void org.xdi.oxauth.client.AuthorizationResponse.setScope ( String  scope )

inline

Sets the scope of the access token.

引数

scope

The scope of the access token.

                                       {
        this.scope = scope;
    }

setSessionId()

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

inline

Sets session id.

引数

p_sessionId

session id.

                                                 {
        sessionId = p_sessionId;
    }

setState()

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

inline

Sets the state. If the state parameter was present in the client authorization request, the exact value received from the client.

引数

state

The state.

                                       {
        this.state = state;
    }

setStatus()

void org.xdi.oxauth.client.BaseResponse.setStatus ( int  status )

inlineinherited

Sets the HTTP status code of the response.

引数

status

The HTTP status code.

                                      {
        this.status = status;
    }

setTokenType()

void org.xdi.oxauth.client.AuthorizationResponse.setTokenType ( TokenType  tokenType )

inline

Sets the type of the token issued (value is case insensitive).

引数

tokenType

The type of the token.

                                                  {
        this.tokenType = tokenType;
    }

メンバ詳解

accessToken

String org.xdi.oxauth.client.AuthorizationResponse.accessToken

private

code

String org.xdi.oxauth.client.AuthorizationResponse.code

private

customParams

Map<String, String> org.xdi.oxauth.client.AuthorizationResponse.customParams

private

entity

String org.xdi.oxauth.client.BaseResponse.entity

protectedinherited

errorDescription

String org.xdi.oxauth.client.AuthorizationResponse.errorDescription

private

errorType

AuthorizeErrorResponseType org.xdi.oxauth.client.AuthorizationResponse.errorType

private

errorUri

String org.xdi.oxauth.client.AuthorizationResponse.errorUri

private

expiresIn

Integer org.xdi.oxauth.client.AuthorizationResponse.expiresIn

private

headers

MultivaluedMap<String, Object> org.xdi.oxauth.client.BaseResponse.headers

protectedinherited

idToken

String org.xdi.oxauth.client.AuthorizationResponse.idToken

private

location

String org.xdi.oxauth.client.BaseResponse.location

protectedinherited

responseMode

ResponseMode org.xdi.oxauth.client.AuthorizationResponse.responseMode

private

scope

String org.xdi.oxauth.client.AuthorizationResponse.scope

private

sessionId

String org.xdi.oxauth.client.AuthorizationResponse.sessionId

private

state

String org.xdi.oxauth.client.AuthorizationResponse.state

private

status

int org.xdi.oxauth.client.BaseResponse.status

protectedinherited

tokenType

TokenType org.xdi.oxauth.client.AuthorizationResponse.tokenType

private

---

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

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