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

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

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

クラス
class	Builder

公開メンバ関数
	TokenRequest (GrantType grantType)
GrantType	getGrantType ()
void	setGrantType (GrantType grantType)
String	getCode ()
void	setCode (String code)
String	getCodeVerifier ()
void	setCodeVerifier (String codeVerifier)
String	getRedirectUri ()
void	setRedirectUri (String redirectUri)
String	getUsername ()
void	setUsername (String username)
String	getPassword ()
void	setPassword (String password)
String	getScope ()
void	setScope (String scope)
String	getAssertion ()
void	setAssertion (String assertion)
String	getRefreshToken ()
void	setRefreshToken (String refreshToken)
void	setAudience (String audience)
void	setAlgorithm (SignatureAlgorithm algorithm)
void	setSharedKey (String sharedKey)
void	setRsaPrivateKey (RSAPrivateKey rsaPrivateKey)
void	setEcPrivateKey (ECDSAPrivateKey ecPrivateKey)
void	setCryptoProvider (AbstractCryptoProvider cryptoProvider)
String	getKeyId ()
void	setKeyId (String keyId)
String	getClientAssertion ()
String	getQueryString ()
Map< String, String >	getParameters ()
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 ()
JSONObject	getJSONParameters () throws JSONException
	queryString ()

静的公開メンバ関数
static Builder	builder ()
static Builder	umaBuilder ()

非公開変数類
GrantType	grantType
String	code
String	redirectUri
String	username
String	password
String	scope
String	assertion
String	refreshToken
String	audience
String	codeVerifier
SignatureAlgorithm	algorithm
String	sharedKey
RSAPrivateKey	rsaPrivateKey
ECDSAPrivateKey	ecPrivateKey
AbstractCryptoProvider	cryptoProvider
String	keyId

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

詳解

Represents a token request to send to the authorization server.

著者

Javier Rojas Blum

バージョン

June 28, 2017

構築子と解体子

TokenRequest()

org.xdi.oxauth.client.TokenRequest.TokenRequest ( GrantType  grantType )

inline

Constructs a token request.

引数

grantType

The grant type is mandatory and could be: authorization_code, password, client_credentials, refresh_token.

                                             {
        super();
        this.grantType = grantType;

        setContentType(MediaType.APPLICATION_FORM_URLENCODED);
        setAuthenticationMethod(AuthenticationMethod.CLIENT_SECRET_BASIC);
    }

関数詳解

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

builder()

static Builder org.xdi.oxauth.client.TokenRequest.builder ( )

inlinestatic

                                    {
        return new Builder();
    }

getAssertion()

String org.xdi.oxauth.client.TokenRequest.getAssertion ( )

inline

Returns the assertion.

戻り値

The assertion.

                                 {
        return assertion;
    }

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

getClientAssertion()

String org.xdi.oxauth.client.TokenRequest.getClientAssertion ( )

inline

                                       {
        Jwt clientAssertion = new Jwt();

        if (algorithm == null) {
            algorithm = SignatureAlgorithm.HS256;
        }
        GregorianCalendar calendar = new GregorianCalendar(TimeZone.getTimeZone("UTC"));
        Date issuedAt = calendar.getTime();
        calendar.add(Calendar.MINUTE, 5);
        Date expirationTime = calendar.getTime();

        // Header
        clientAssertion.getHeader().setType(JwtType.JWT);
        clientAssertion.getHeader().setAlgorithm(algorithm);
        if (StringUtils.isNotBlank(keyId)) {
            clientAssertion.getHeader().setKeyId(keyId);
        }

        // Claims
        clientAssertion.getClaims().setIssuer(getAuthUsername());
        clientAssertion.getClaims().setSubjectIdentifier(getAuthUsername());
        clientAssertion.getClaims().setAudience(audience);
        clientAssertion.getClaims().setJwtId(UUID.randomUUID());
        clientAssertion.getClaims().setExpirationTime(expirationTime);
        clientAssertion.getClaims().setIssuedAt(issuedAt);

        // Signature
        try {
            if (sharedKey == null) {
                sharedKey = getAuthPassword();
            }
            String signature = cryptoProvider.sign(clientAssertion.getSigningInput(), keyId, sharedKey, algorithm);
            clientAssertion.setEncodedSignature(signature);
        } catch (InvalidJwtException e) {
            LOG.error(e.getMessage(), e);
        } catch (Exception e) {
            LOG.error(e.getMessage(), e);
        }

        return clientAssertion.toString();
    }

getCode()

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

inline

Returns the authorization code.

戻り値

The authorization code.

                            {
        return code;
    }

getCodeVerifier()

String org.xdi.oxauth.client.TokenRequest.getCodeVerifier ( )

inline

Gets PKCE code verifier.

戻り値

code verifier

                                    {
        return codeVerifier;
    }

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

getGrantType()

GrantType org.xdi.oxauth.client.TokenRequest.getGrantType ( )

inline

Returns the grant type.

戻り値

The grant type.

                                    {
        return grantType;
    }

getJSONParameters()

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

inlineinherited

                                                               {
        return EMPTY_JSON_OBJECT;
    }

getKeyId()

String org.xdi.oxauth.client.TokenRequest.getKeyId ( )

inline

                             {
        return keyId;
    }

getMediaType()

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

inlineinherited

                                 {
        return mediaType;
    }

getParameters()

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

inline

Returns a collection of parameters of the token request. Any null or empty parameter will be omitted.

戻り値

A collection of parameters.

                                               {
        Map<String, String> parameters = new HashMap<String, String>();

        if (grantType != null) {
            parameters.put("grant_type", grantType.toString());
        }
        if (code != null && !code.isEmpty()) {
            parameters.put("code", code);
        }
        if (redirectUri != null && !redirectUri.isEmpty()) {
            parameters.put("redirect_uri", redirectUri);
        }
        if (username != null && !username.isEmpty()) {
            parameters.put("username", username);
        }
        if (password != null && !password.isEmpty()) {
            parameters.put("password", password);
        }
        if (scope != null && !scope.isEmpty()) {
            parameters.put("scope", scope);
        }
        if (assertion != null && !assertion.isEmpty()) {
            parameters.put("assertion", assertion);
        }
        if (refreshToken != null && !refreshToken.isEmpty()) {
            parameters.put("refresh_token", refreshToken);
        }
        if (getAuthenticationMethod() == AuthenticationMethod.CLIENT_SECRET_POST) {
            if (getAuthUsername() != null && !getAuthUsername().isEmpty()) {
                parameters.put("client_id", getAuthUsername());
            }
            if (getAuthPassword() != null && !getAuthPassword().isEmpty()) {
                parameters.put("client_secret", getAuthPassword());
            }
        } else if (getAuthenticationMethod() == AuthenticationMethod.CLIENT_SECRET_JWT ||
                getAuthenticationMethod() == AuthenticationMethod.PRIVATE_KEY_JWT) {
            parameters.put("client_assertion_type", ClientAssertionType.JWT_BEARER.toString());
            parameters.put("client_assertion", getClientAssertion());
        }
        for (String key : getCustomParameters().keySet()) {
            parameters.put(key, getCustomParameters().get(key));
        }

        return parameters;
    }

getPassword()

String org.xdi.oxauth.client.TokenRequest.getPassword ( )

inline

Returns the password.

戻り値

The password.

                                {
        return password;
    }

getQueryString()

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

inline

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

戻り値

A query string of parameters.

                                   {
        StringBuilder queryStringBuilder = new StringBuilder();

        try {
            if (grantType != null) {
                queryStringBuilder.append("grant_type=").append(grantType.toString());
            }
            if (code != null && !code.isEmpty()) {
                queryStringBuilder.append("&");
                queryStringBuilder.append("code=").append(code);
            }
            if (redirectUri != null && !redirectUri.isEmpty()) {
                queryStringBuilder.append("&");
                queryStringBuilder.append("redirect_uri=").append(
                        URLEncoder.encode(redirectUri, "UTF-8"));
            }
            if (scope != null && !scope.isEmpty()) {
                queryStringBuilder.append("&");
                queryStringBuilder.append("scope=").append(
                        URLEncoder.encode(scope, "UTF-8"));
            }
            if (username != null && !username.isEmpty()) {
                queryStringBuilder.append("&");
                queryStringBuilder.append("username=").append(username);
            }
            if (password != null && !password.isEmpty()) {
                queryStringBuilder.append("&");
                queryStringBuilder.append("password=").append(password);
            }
            if (assertion != null && !assertion.isEmpty()) {
                queryStringBuilder.append("&");
                queryStringBuilder.append("assertion=").append(assertion);
            }
            if (refreshToken != null && !refreshToken.isEmpty()) {
                queryStringBuilder.append("&");
                queryStringBuilder.append("refresh_token=").append(refreshToken);
            }
            if (getAuthenticationMethod() == AuthenticationMethod.CLIENT_SECRET_POST) {
                if (getAuthUsername() != null && !getAuthUsername().isEmpty()) {
                    queryStringBuilder.append("&");
                    queryStringBuilder.append("client_id=").append(
                            URLEncoder.encode(getAuthUsername(), "UTF-8"));
                }
                if (getAuthPassword() != null && !getAuthPassword().isEmpty()) {
                    queryStringBuilder.append("&");
                    queryStringBuilder.append("client_secret=").append(
                            URLEncoder.encode(getAuthPassword(), "UTF-8"));
                }
            } else if (getAuthenticationMethod() == AuthenticationMethod.CLIENT_SECRET_JWT ||
                    getAuthenticationMethod() == AuthenticationMethod.PRIVATE_KEY_JWT) {
                queryStringBuilder.append("&client_assertion_type=").append(
                        URLEncoder.encode(ClientAssertionType.JWT_BEARER.toString(), "UTF-8"));
                queryStringBuilder.append("&");
                queryStringBuilder.append("client_assertion=").append(getClientAssertion());
            }
            for (String key : getCustomParameters().keySet()) {
                queryStringBuilder.append("&");
                queryStringBuilder.append(key).append("=").append(getCustomParameters().get(key));
            }
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }

        return queryStringBuilder.toString();
    }

getRedirectUri()

String org.xdi.oxauth.client.TokenRequest.getRedirectUri ( )

inline

Returns the redirect URI.

戻り値

The redirect URI.

                                   {
        return redirectUri;
    }

getRefreshToken()

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

inline

Returns the refresh token.

戻り値

The refresh token.

                                    {
        return refreshToken;
    }

getScope()

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

inline

Returns the scope.

戻り値

The scope.

                             {
        return scope;
    }

getUsername()

String org.xdi.oxauth.client.TokenRequest.getUsername ( )

inline

Returns the username.

戻り値

The username.

                                {
        return username;
    }

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

setAlgorithm()

void org.xdi.oxauth.client.TokenRequest.setAlgorithm ( SignatureAlgorithm  algorithm )

inline

                                                           {
        this.algorithm = algorithm;
    }

setAssertion()

void org.xdi.oxauth.client.TokenRequest.setAssertion ( String  assertion )

inline

Sets the assertion.

引数

assertion

The assertion.

                                               {
        this.assertion = assertion;
    }

setAudience()

void org.xdi.oxauth.client.TokenRequest.setAudience ( String  audience )

inline

                                             {
        this.audience = audience;
    }

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

setCode()

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

inline

Sets the authorization code.

引数

code	The authorization code.

                                     {
        this.code = code;
    }

setCodeVerifier()

void org.xdi.oxauth.client.TokenRequest.setCodeVerifier ( String  codeVerifier )

inline

Sets PKCE code verifier.

引数

codeVerifier

code verifier

                                                     {
        this.codeVerifier = codeVerifier;
    }

setContentType()

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

inlineinherited

                                                   {
        this.contentType = contentType;
    }

setCryptoProvider()

void org.xdi.oxauth.client.TokenRequest.setCryptoProvider ( AbstractCryptoProvider  cryptoProvider )

inline

                                                                         {
        this.cryptoProvider = cryptoProvider;
    }

setEcPrivateKey()

void org.xdi.oxauth.client.TokenRequest.setEcPrivateKey ( ECDSAPrivateKey  ecPrivateKey )

inline

                                                              {
        this.ecPrivateKey = ecPrivateKey;
    }

setGrantType()

void org.xdi.oxauth.client.TokenRequest.setGrantType ( GrantType  grantType )

inline

Sets the grant type.

引数

grantType

The grant type.

                                                  {
        this.grantType = grantType;
    }

setKeyId()

void org.xdi.oxauth.client.TokenRequest.setKeyId ( String  keyId )

inline

                                       {
        this.keyId = keyId;
    }

setMediaType()

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

inlineinherited

                                               {
        this.mediaType = mediaType;
    }

setPassword()

void org.xdi.oxauth.client.TokenRequest.setPassword ( String  password )

inline

Sets the password.

引数

password

The password.

                                             {
        this.password = password;
    }

setRedirectUri()

void org.xdi.oxauth.client.TokenRequest.setRedirectUri ( String  redirectUri )

inline

Sets the redirect URI.

引数

redirectUri

The redirect URI.

                                                   {
        this.redirectUri = redirectUri;
    }

setRefreshToken()

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

inline

Sets the refresh token.

引数

refreshToken

The refresh token.

                                                     {
        this.refreshToken = refreshToken;
    }

setRsaPrivateKey()

void org.xdi.oxauth.client.TokenRequest.setRsaPrivateKey ( RSAPrivateKey  rsaPrivateKey )

inline

                                                              {
        this.rsaPrivateKey = rsaPrivateKey;
    }

setScope()

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

inline

Sets the scope.

引数

scope

The scope.

                                       {
        this.scope = scope;
    }

setSharedKey()

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

inline

                                               {
        this.sharedKey = sharedKey;
    }

setUsername()

void org.xdi.oxauth.client.TokenRequest.setUsername ( String  username )

inline

Sets the username.

引数

username

The username.

                                             {
        this.username = username;
    }

umaBuilder()

static Builder org.xdi.oxauth.client.TokenRequest.umaBuilder ( )

inlinestatic

                                       {
        return new Builder().grantType(GrantType.CLIENT_CREDENTIALS);
    }

メンバ詳解

algorithm

SignatureAlgorithm org.xdi.oxauth.client.TokenRequest.algorithm

private

assertion

String org.xdi.oxauth.client.TokenRequest.assertion

private

audience

String org.xdi.oxauth.client.TokenRequest.audience

private

code

String org.xdi.oxauth.client.TokenRequest.code

private

codeVerifier

String org.xdi.oxauth.client.TokenRequest.codeVerifier

private

cryptoProvider

AbstractCryptoProvider org.xdi.oxauth.client.TokenRequest.cryptoProvider

private

ecPrivateKey

ECDSAPrivateKey org.xdi.oxauth.client.TokenRequest.ecPrivateKey

private

grantType

GrantType org.xdi.oxauth.client.TokenRequest.grantType

private

keyId

String org.xdi.oxauth.client.TokenRequest.keyId

private

LOG

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

staticprivate

password

String org.xdi.oxauth.client.TokenRequest.password

private

redirectUri

String org.xdi.oxauth.client.TokenRequest.redirectUri

private

refreshToken

String org.xdi.oxauth.client.TokenRequest.refreshToken

private

rsaPrivateKey

RSAPrivateKey org.xdi.oxauth.client.TokenRequest.rsaPrivateKey

private

scope

String org.xdi.oxauth.client.TokenRequest.scope

private

sharedKey

String org.xdi.oxauth.client.TokenRequest.sharedKey

private

username

String org.xdi.oxauth.client.TokenRequest.username

private

---

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

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