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

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

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

公開メンバ関数
IErrorType	getType ()
void	setType (IErrorType type)
String	getState ()
void	setState (String p_state)
String	getErrorCode ()
String	getErrorDescription ()
void	setErrorDescription (String errorDescription)
String	getErrorUri ()
void	setErrorUri (String errorUri)
String	getReason ()
void	setReason (String reason)
String	toQueryString ()
String	toJSonString ()

非公開変数類
IErrorType	type
String	state

詳解

著者

Yuriy Zabrovarnyy

バージョン

0.9, 19/09/2012

関数詳解

getErrorCode()

String org.xdi.oxauth.model.error.DefaultErrorResponse.getErrorCode ( )

inline

                                 {
        if (type != null)
            return type.toString();
        return null;
    }

getErrorDescription()

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

inlineinherited

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

inlineinherited

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

inlineinherited

                              {
        return reason;
    }

getState()

String org.xdi.oxauth.model.error.DefaultErrorResponse.getState ( )

inline

                             {
        return state;
    }

getType()

IErrorType org.xdi.oxauth.model.error.DefaultErrorResponse.getType ( )

inline

Returns the error response type.

戻り値

The error response type.

                                {
        return type;
    }

setErrorDescription()

void org.xdi.oxauth.model.error.ErrorResponse.setErrorDescription ( String  errorDescription )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

                                         {
        this.reason = reason;
    }

setState()

void org.xdi.oxauth.model.error.DefaultErrorResponse.setState ( String  p_state )

inline

                                         {
        state = p_state;
    }

setType()

void org.xdi.oxauth.model.error.DefaultErrorResponse.setType ( IErrorType  type )

inline

Sets the IErrorType that represents the code of the error that occurred.

引数

type	The error response type.

                                         {
        this.type = type;
    }

toJSonString()

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

inlineinherited

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

inlineinherited

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

メンバ詳解

state

String org.xdi.oxauth.model.error.DefaultErrorResponse.state

private

type

IErrorType org.xdi.oxauth.model.error.DefaultErrorResponse.type

private

---

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

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