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

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

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

公開メンバ関数
	TokenResponse ()
	TokenResponse (ClientResponse< String > clientResponse)
TokenErrorResponseType	fromString (String p_str)
void	injectDataFromJson ()
void	injectDataFromJson (String p_json)
String	getAccessToken ()
void	setAccessToken (String accessToken)
TokenType	getTokenType ()
void	setTokenType (TokenType tokenType)
Integer	getExpiresIn ()
void	setExpiresIn (Integer expiresIn)
String	getRefreshToken ()
void	setRefreshToken (String refreshToken)
String	getScope ()
void	setScope (String scope)
String	getIdToken ()
void	setIdToken (String idToken)
String	getErrorDescription ()
void	setErrorDescription (String p_errorDescription)
T	getErrorType ()
void	setErrorType (T p_errorType)
String	getErrorUri ()
void	setErrorUri (String p_errorUri)
void	injectErrorIfExistSilently (JSONObject jsonObj) throws JSONException
void	injectErrorIfExistSilently (String p_entity)

非公開変数類
String	accessToken
TokenType	tokenType
Integer	expiresIn
String	refreshToken
String	scope
String	idToken

静的非公開変数類
static final Logger	LOG = Logger.getLogger(TokenResponse.class)

詳解

Represents a token response received from the authorization server.

著者

Javier Rojas Blum Date: 10.19.2011

構築子と解体子

TokenResponse() [1/2]

org.xdi.oxauth.client.TokenResponse.TokenResponse ( )

inline

                           {
    }

TokenResponse() [2/2]

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

inline

Constructs a token response.

引数

clientResponse

The response

                                                                {
        super(clientResponse);
    }

関数詳解

fromString()

TokenErrorResponseType org.xdi.oxauth.client.TokenResponse.fromString ( String  p_str )

inline

                                                           {
        return TokenErrorResponseType.fromString(p_str);
    }

getAccessToken()

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

inline

Returns the access token issued by the authorization server.

戻り値

The access token issued by the authorization server.

                                   {
        return accessToken;
    }

getErrorDescription()

String org.xdi.oxauth.client.BaseResponseWithErrors< T extends IErrorType >.getErrorDescription ( )

inlineinherited

                                        {
        return errorDescription;
    }

getErrorType()

T org.xdi.oxauth.client.BaseResponseWithErrors< T extends IErrorType >.getErrorType ( )

inlineinherited

                            {
        return errorType;
    }

getErrorUri()

String org.xdi.oxauth.client.BaseResponseWithErrors< T extends IErrorType >.getErrorUri ( )

inlineinherited

                                {
        return errorUri;
    }

getExpiresIn()

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

inline

Returns the lifetime in seconds of the access token.

戻り値

The lifetime in seconds of the access token.

                                  {
        return expiresIn;
    }

getIdToken()

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

inline

Gets the value of the id token.

戻り値

The id token.

                               {
        return idToken;
    }

getRefreshToken()

String org.xdi.oxauth.client.TokenResponse.getRefreshToken ( )

inline

Returns the refresh token which can be used to obtain new access tokens using the same authorization grant.

戻り値

The refresh token.

                                    {
        return refreshToken;
    }

getScope()

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

inline

Returns the scope of the access token.

戻り値

The scope of the access token.

                             {
        return scope;
    }

getTokenType()

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

inline

Returns the type of the token issued. Value is case insensitive.

戻り値

The type of the token issued.

                                    {
        return tokenType;
    }

injectDataFromJson() [1/2]

void org.xdi.oxauth.client.TokenResponse.injectDataFromJson ( )

inline

                                     {
        injectDataFromJson(entity);
    }

injectDataFromJson() [2/2]

void org.xdi.oxauth.client.TokenResponse.injectDataFromJson ( String  p_json )

inline

                                                  {
        if (StringUtils.isNotBlank(entity)) {
            try {
                JSONObject jsonObj = new JSONObject(entity);
                if (jsonObj.has("access_token")) {
                    setAccessToken(jsonObj.getString("access_token"));
                }
                if (jsonObj.has("token_type")) {
                    setTokenType(TokenType.fromString(jsonObj.getString("token_type")));
                }
                if (jsonObj.has("expires_in")) {
                    setExpiresIn(jsonObj.getInt("expires_in"));
                }
                if (jsonObj.has("refresh_token")) {
                    setRefreshToken(jsonObj.getString("refresh_token"));
                }
                if (jsonObj.has("scope")) {
                    setScope(jsonObj.getString("scope"));
                }
                if (jsonObj.has("id_token")) {
                    setIdToken(jsonObj.getString("id_token"));
                }
            } catch (JSONException e) {
                LOG.error(e.getMessage(), e);
            }
        }
    }

injectErrorIfExistSilently() [1/2]

void org.xdi.oxauth.client.BaseResponseWithErrors< T extends IErrorType >.injectErrorIfExistSilently ( JSONObject  jsonObj ) throws JSONException

inlineinherited

                                                                                    {
        if (jsonObj.has("error")) {
            errorType = fromString(jsonObj.getString("error"));
        }
        if (jsonObj.has("error_description")) {
            errorDescription = jsonObj.getString("error_description");
        }
        if (jsonObj.has("error_uri")) {
            errorUri = jsonObj.getString("error_uri");
        }
    }

injectErrorIfExistSilently() [2/2]

void org.xdi.oxauth.client.BaseResponseWithErrors< T extends IErrorType >.injectErrorIfExistSilently ( String  p_entity )

inlineinherited

                                                            {
        try {
            injectErrorIfExistSilently(new JSONObject(p_entity));
        } catch (JSONException e) {
            // ignore : it's ok to skip exception because entity string can be json array or just trash
        }
    }

setAccessToken()

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

inline

Sets the access token issued by the authorization server.

引数

accessToken

The access token issued by the authorization server.

                                                   {
        this.accessToken = accessToken;
    }

setErrorDescription()

void org.xdi.oxauth.client.BaseResponseWithErrors< T extends IErrorType >.setErrorDescription ( String  p_errorDescription )

inlineinherited

                                                               {
        errorDescription = p_errorDescription;
    }

setErrorType()

void org.xdi.oxauth.client.BaseResponseWithErrors< T extends IErrorType >.setErrorType ( T  p_errorType )

inlineinherited

                                            {
        errorType = p_errorType;
    }

setErrorUri()

void org.xdi.oxauth.client.BaseResponseWithErrors< T extends IErrorType >.setErrorUri ( String  p_errorUri )

inlineinherited

                                               {
        errorUri = p_errorUri;
    }

setExpiresIn()

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

inline

Sets the lifetime in seconds of the access token.

引数

expiresIn

The lifetime in seconds of the access token.

                                                {
        this.expiresIn = expiresIn;
    }

setIdToken()

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

inline

Sets the value of the id token.

引数

idToken

The id token.

                                           {
        this.idToken = idToken;
    }

setRefreshToken()

void org.xdi.oxauth.client.TokenResponse.setRefreshToken ( String  refreshToken )

inline

Sets the refresh token which can be used to obtain new access tokens using the same authorization grant.

引数

refreshToken

The refresh token.

                                                     {
        this.refreshToken = refreshToken;
    }

setScope()

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

inline

Sets the scope of the access token.

引数

scope

The scope of the access token.

                                       {
        this.scope = scope;
    }

setTokenType()

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

inline

Sets the type of the token issued. Value is case insensitive.

引数

tokenType

The type of the token issued.

                                                  {
        this.tokenType = tokenType;
    }

メンバ詳解

accessToken

String org.xdi.oxauth.client.TokenResponse.accessToken

private

expiresIn

Integer org.xdi.oxauth.client.TokenResponse.expiresIn

private

idToken

String org.xdi.oxauth.client.TokenResponse.idToken

private

LOG

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

staticprivate

refreshToken

String org.xdi.oxauth.client.TokenResponse.refreshToken

private

scope

String org.xdi.oxauth.client.TokenResponse.scope

private

tokenType

TokenType org.xdi.oxauth.client.TokenResponse.tokenType

private

---

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

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