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

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

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

公開メンバ関数
String	getContentType ()
void	setContentType (String contentType)
String	getMediaType ()
void	setMediaType (String mediaType)
String	getAuthUsername ()
void	setAuthUsername (String authUsername)
String	getAuthPassword ()
void	setAuthPassword (String authPassword)
AuthenticationMethod	getAuthenticationMethod ()
void	setAuthenticationMethod (AuthenticationMethod authenticationMethod)
AuthorizationMethod	getAuthorizationMethod ()
void	setAuthorizationMethod (AuthorizationMethod authorizationMethod)
Map< String, String >	getCustomParameters ()
void	addCustomParameter (String paramName, String paramValue)
boolean	hasCredentials ()
String	getCredentials () throws UnsupportedEncodingException
String	getEncodedCredentials ()
Map< String, String >	getParameters ()
JSONObject	getJSONParameters () throws JSONException
abstract String	getQueryString ()
	getAuthUsername ()
	setAuthUsername ($authUsername)
	getAuthPassword ()
	setAuthPassword ($authPassword)
	getCustomParameters ()
	addCustomParameter ($paramName, $paramValue)
	hasCredentials ()
	getCredentials ()
	getEncodedCredentials ()
	getParameters ()
	queryString ()

限定公開メンバ関数
	BaseRequest ()
	__construct ()

非公開変数類
String	contentType
String	mediaType
String	authUsername
String	authPassword
AuthenticationMethod	authenticationMethod
AuthorizationMethod	authorizationMethod
Map< String, String >	customParameters
	$EMPTY_MAP = array()
	$authUsername
	$authPassword
	$customParameters

静的非公開変数類
static final Map< String, String >	EMPTY_MAP = new HashMap<String, String>()
static final JSONObject	EMPTY_JSON_OBJECT = new JSONObject()

詳解

著者

Javier Rojas Blum

バージョン

January 26. 2018

著者

Gabin Dongmo 29/03/2013

構築子と解体子

BaseRequest()

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

inlineprotected

                            {
        customParameters = new HashMap<String, String>();
    }

__construct()

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

protected

                                    {
        $this->customParameters = array();
    }

関数詳解

addCustomParameter() [1/2]

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

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

addCustomParameter() [2/2]

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

inline

                                                                        {
        customParameters.put(paramName, paramValue);
    }

getAuthenticationMethod()

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

inline

                                                          {
        return authenticationMethod;
    }

getAuthorizationMethod()

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

inline

                                                        {
        return authorizationMethod;
    }

getAuthPassword() [1/2]

org.xdi.oxauth.client.BaseRequest.getAuthPassword

(

)

                                      {
        return $this->authPassword;
    }

getAuthPassword() [2/2]

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

inline

                                    {
        return authPassword;
    }

getAuthUsername() [1/2]

org.xdi.oxauth.client.BaseRequest.getAuthUsername

(

)

                                     {
        return $this->authUsername;
    }

getAuthUsername() [2/2]

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

inline

                                    {
        return authUsername;
    }

getContentType()

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

inline

                                   {
        return contentType;
    }

getCredentials() [1/2]

org.xdi.oxauth.client.BaseRequest.getCredentials

(

)

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

getCredentials() [2/2]

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

inline

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

(

)

                                         {
        return $this->customParameters;
    }

getCustomParameters() [2/2]

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

inline

                                                     {
        return customParameters;
    }

getEncodedCredentials() [1/2]

org.xdi.oxauth.client.BaseRequest.getEncodedCredentials

(

)

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

getEncodedCredentials() [2/2]

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

inline

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

inline

                                                               {
        return EMPTY_JSON_OBJECT;
    }

getMediaType()

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

inline

                                 {
        return mediaType;
    }

getParameters() [1/2]

org.xdi.oxauth.client.BaseRequest.getParameters

(

)

                                   {
        return $this->EMPTY_MAP;
    }

getParameters() [2/2]

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

inline

                                               {
        return EMPTY_MAP;
    }

getQueryString()

abstract String org.xdi.oxauth.client.BaseRequest.getQueryString ( )

abstract

hasCredentials() [1/2]

org.xdi.oxauth.client.BaseRequest.hasCredentials

(

)

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

hasCredentials() [2/2]

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

inline

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

queryString()

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

abstract

setAuthenticationMethod()

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

inline

                                                                                   {
        this.authenticationMethod = authenticationMethod;
    }

setAuthorizationMethod()

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

inline

                                                                                {
        this.authorizationMethod = authorizationMethod;
    }

setAuthPassword() [1/2]

org.xdi.oxauth.client.BaseRequest.setAuthPassword

(

$authPassword

)

                                                   {
        $this->authPassword = $authPassword;
    }

setAuthPassword() [2/2]

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

inline

                                                     {
        this.authPassword = authPassword;
    }

setAuthUsername() [1/2]

org.xdi.oxauth.client.BaseRequest.setAuthUsername

(

$authUsername

)

                                                  {
        $this->authUsername = $authUsername;
    }

setAuthUsername() [2/2]

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

inline

                                                     {
        this.authUsername = authUsername;
    }

setContentType()

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

inline

                                                   {
        this.contentType = contentType;
    }

setMediaType()

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

inline

                                               {
        this.mediaType = mediaType;
    }

メンバ詳解

$authPassword

org.xdi.oxauth.client.BaseRequest.$authPassword

private

$authUsername

org.xdi.oxauth.client.BaseRequest.$authUsername

private

$customParameters

org.xdi.oxauth.client.BaseRequest.$customParameters

private

$EMPTY_MAP

org.xdi.oxauth.client.BaseRequest.$EMPTY_MAP = array()

private

authenticationMethod

AuthenticationMethod org.xdi.oxauth.client.BaseRequest.authenticationMethod

private

authorizationMethod

AuthorizationMethod org.xdi.oxauth.client.BaseRequest.authorizationMethod

private

authPassword

String org.xdi.oxauth.client.BaseRequest.authPassword

private

authUsername

String org.xdi.oxauth.client.BaseRequest.authUsername

private

contentType

String org.xdi.oxauth.client.BaseRequest.contentType

private

customParameters

Map<String, String> org.xdi.oxauth.client.BaseRequest.customParameters

private

EMPTY_JSON_OBJECT

final JSONObject org.xdi.oxauth.client.BaseRequest.EMPTY_JSON_OBJECT = new JSONObject()

staticprivate

EMPTY_MAP

final Map<String, String> org.xdi.oxauth.client.BaseRequest.EMPTY_MAP = new HashMap<String, String>()

staticprivate

mediaType

String org.xdi.oxauth.client.BaseRequest.mediaType

private

---

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

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