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

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

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

公開メンバ関数
	UserInfoRequest (String accessToken)
String	getAccessToken ()
void	setAccessToken (String accessToken)
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 ()

非公開変数類
String	accessToken

詳解

Represents a User Info request to send to the authorization server.

著者

Javier Rojas Blum Date: 11.28.2011

構築子と解体子

UserInfoRequest()

org.xdi.oxauth.client.UserInfoRequest.UserInfoRequest ( String  accessToken )

inline

Constructs a User Info Request.

引数

accessToken

The access token obtained from the oxAuth authorization request.

                                               {
        this.accessToken = accessToken;
        setAuthorizationMethod(AuthorizationMethod.AUTHORIZATION_REQUEST_HEADER_FIELD);
    }

関数詳解

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

getAccessToken()

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

inline

Returns the access token obtained from oxAuth authorization request.

戻り値

The access token obtained from oxAuth authorization request.

                                   {
        return accessToken;
    }

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

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()

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

inline

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

戻り値

A collection of parameters.

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

        if (accessToken != null && !accessToken.isEmpty()) {
            if (getAuthorizationMethod() == AuthorizationMethod.FORM_ENCODED_BODY_PARAMETER
                    || getAuthorizationMethod() == AuthorizationMethod.URL_QUERY_PARAMETER) {
                parameters.put("access_token", accessToken);
            }
        }

        return parameters;
    }

getQueryString()

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

inline

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

戻り値

A query string of parameters.

                                   {
        StringBuilder queryStringBuilder = new StringBuilder();

        if (StringUtils.isNotBlank(accessToken)) {
            if (getAuthorizationMethod() == AuthorizationMethod.FORM_ENCODED_BODY_PARAMETER
                    || getAuthorizationMethod() == AuthorizationMethod.URL_QUERY_PARAMETER) {
                queryStringBuilder.append("access_token=").append(accessToken);
            }
        }

        return queryStringBuilder.toString();
    }

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.UserInfoRequest.setAccessToken ( String  accessToken )

inline

Sets the access token obtained from oxAuth authorization request.

引数

accessToken

The access token obtained from oxAuth authorization request.

                                                   {
        this.accessToken = accessToken;
    }

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

メンバ詳解

accessToken

String org.xdi.oxauth.client.UserInfoRequest.accessToken

private

---

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

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