org.xdi.oxauth.model.error.ErrorResponse クラス

org.xdi.oxauth.model.error.ErrorResponse の継承関係図

org.xdi.oxauth.model.error.ErrorResponse 連携図

公開メンバ関数
abstract String	getErrorCode ()
abstract String	getState ()
String	getErrorDescription ()
void	setErrorDescription (String errorDescription)
String	getErrorUri ()
void	setErrorUri (String errorUri)
String	getReason ()
void	setReason (String reason)
String	toQueryString ()
String	toJSonString ()

非公開変数類
String	errorDescription
String	errorUri
String	reason

静的非公開変数類
static final Logger	log = LoggerFactory.getLogger(ErrorResponse.class)

詳解

Base class for error responses.

著者

Javier Rojas Date: 09.22.2011

関数詳解

getErrorCode()

abstract String org.xdi.oxauth.model.error.ErrorResponse.getErrorCode ( )

abstract

Returns the error code of the response.

戻り値

The error code.

getErrorDescription()

String org.xdi.oxauth.model.error.ErrorResponse.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.

戻り値

Description about the error.

                                            {
                return errorDescription;
        }

getErrorUri()

String org.xdi.oxauth.model.error.ErrorResponse.getErrorUri ( )

inline

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

戻り値

URI with more information about the error.

                                    {
                return errorUri;
        }

getReason()

String org.xdi.oxauth.model.error.ErrorResponse.getReason ( )

inline

                              {
        return reason;
    }

getState()

abstract String org.xdi.oxauth.model.error.ErrorResponse.getState ( )

abstract

If a valid state parameter was present in the request, it returns the exact value received from the client.

戻り値

The state value of the request.

setErrorDescription()

void org.xdi.oxauth.model.error.ErrorResponse.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

Description about the error.

                                                                 {
                this.errorDescription = errorDescription;
        }

setErrorUri()

void org.xdi.oxauth.model.error.ErrorResponse.setErrorUri ( String  errorUri )

inline

Sets an 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

URI with more information about the error.

                                                 {
                this.errorUri = errorUri;
        }

setReason()

void org.xdi.oxauth.model.error.ErrorResponse.setReason ( String  reason )

inline

                                         {
        this.reason = reason;
    }

toJSonString()

String org.xdi.oxauth.model.error.ErrorResponse.toJSonString ( )

inline

Return a JSon string representation of the object.

戻り値

The object represented in a JSon string.

                                     {
                JSONObject jsonObj = new JSONObject();

                try {
                        jsonObj.put("error", getErrorCode());

                        if (errorDescription != null && !errorDescription.isEmpty()) {
                                jsonObj.put("error_description", errorDescription);
                        }

                        if (errorUri != null && !errorUri.isEmpty()) {
                                jsonObj.put("error_uri", errorUri);
                        }

                        if (StringUtils.isNotBlank(reason)) {
                            jsonObj.put("reason", reason);
            }

                        if (getState() != null && !getState().isEmpty()) {
                                jsonObj.put("state", getState());
                        }

                } catch (JSONException e) {
                        log.error(e.getMessage(), e);
                        return null;
                }

                return jsonObj.toString();
        }

toQueryString()

String org.xdi.oxauth.model.error.ErrorResponse.toQueryString ( )

inline

Returns a query string representation of the object.

戻り値

The object represented in a query string.

                                      {
                StringBuilder queryStringBuilder = new StringBuilder();

                try {
                        queryStringBuilder.append("error=").append(getErrorCode());

                        if (errorDescription != null && !errorDescription.isEmpty()) {
                                queryStringBuilder.append("&error_description=").append(
                                                URLEncoder.encode(errorDescription, "UTF-8"));
                        }

                        if (errorUri != null && !errorUri.isEmpty()) {
                                queryStringBuilder.append("&error_uri=").append(
                                                URLEncoder.encode(errorUri, "UTF-8"));
                        }

            if (StringUtils.isNotBlank(reason)) {
                queryStringBuilder.append("&reason=").append(URLEncoder.encode(reason, "UTF-8"));
            }

                        if (getState() != null && !getState().isEmpty()) {
                                queryStringBuilder.append("&state=").append(getState());
                        }
                } catch (UnsupportedEncodingException e) {
                        log.error(e.getMessage(), e);
                        return null;
                }

                return queryStringBuilder.toString();
        }

メンバ詳解

errorDescription

String org.xdi.oxauth.model.error.ErrorResponse.errorDescription

private

errorUri

String org.xdi.oxauth.model.error.ErrorResponse.errorUri

private

log

final Logger org.xdi.oxauth.model.error.ErrorResponse.log = LoggerFactory.getLogger(ErrorResponse.class)

staticprivate

reason

String org.xdi.oxauth.model.error.ErrorResponse.reason

private

---

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

• D:/AppData/OpenId/gluu/src/oxAuth/Server/src/main/java/org/xdi/oxauth/model/error/ErrorResponse.java