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

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

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

公開メンバ関数
	ErrorResponseFactory ()
	ErrorResponseFactory (ErrorMessages messages)
ErrorMessages	getMessages ()
void	setMessages (ErrorMessages p_messages)
String	getErrorAsJson (IErrorType p_type)
String	errorAsJson (IErrorType p_type, String reason)
void	throwUnauthorizedException (IErrorType type) throws WebApplicationException
void	throwBadRequestException (IErrorType type) throws WebApplicationException
void	throwWebApplicationException (Response.Status status, IErrorType type) throws WebApplicationException
void	throwUmaNotFoundException () throws WebApplicationException
void	throwUmaInternalErrorException () throws WebApplicationException
String	getErrorAsJson (IErrorType p_type, String p_state)
String	getErrorAsQueryString (IErrorType p_type, String p_state)
DefaultErrorResponse	getErrorResponse (IErrorType type, String p_state)
DefaultErrorResponse	getErrorResponse (IErrorType type)
UmaErrorResponse	getUmaErrorResponse (IErrorType type)
String	getUmaJsonErrorResponse (IErrorType type)
String	getJsonErrorResponse (IErrorType type)

関数
public< T > T	throwUmaWebApplicationException (Response.Status status, IErrorType type) throws WebApplicationException

非公開メンバ関数
ErrorMessage	getError (List< ErrorMessage > p_list, IErrorType type)

非公開変数類
ErrorMessages	messages

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

詳解

Provides an easy way to get Error responses based in an error response type

著者

Yuriy Zabrovarnyy

Javier Rojas Blum

Yuriy Movchan

バージョン

April 26, 2017

構築子と解体子

ErrorResponseFactory() [1/2]

org.xdi.oxauth.model.error.ErrorResponseFactory.ErrorResponseFactory ( )

inline

                                  {
    }

ErrorResponseFactory() [2/2]

org.xdi.oxauth.model.error.ErrorResponseFactory.ErrorResponseFactory ( ErrorMessages  messages )

inline

                                                        {
        this.messages = messages;
    }

関数詳解

errorAsJson()

String org.xdi.oxauth.model.error.ErrorResponseFactory.errorAsJson ( IErrorType  p_type, String  reason  )

inline

                                                                {
        final DefaultErrorResponse error = getErrorResponse(p_type);
        error.setReason(reason);
        return error.toJSonString();
    }

getError()

ErrorMessage org.xdi.oxauth.model.error.ErrorResponseFactory.getError ( List< ErrorMessage >  p_list, IErrorType  type  )

inlineprivate

Looks for an error message.

引数

p_list	error list
type	The type of the error.

戻り値

Error message or null if not found.

                                                                              {
        log.debug("Looking for the error with id: {}", type);

        if (p_list != null) {
            for (ErrorMessage error : p_list) {
                if (error.getId().equals(type.getParameter())) {
                    log.debug("Found error, id: {}", type);
                    return error;
                }
            }
        }

        log.debug("Error not found, id: {}", type);
        return null;
    }

getErrorAsJson() [1/2]

String org.xdi.oxauth.model.error.ErrorResponseFactory.getErrorAsJson ( IErrorType  p_type )

inline

                                                    {
        return getErrorResponse(p_type).toJSonString();
    }

getErrorAsJson() [2/2]

String org.xdi.oxauth.model.error.ErrorResponseFactory.getErrorAsJson ( IErrorType  p_type, String  p_state  )

inline

                                                                    {
        return getErrorResponse(p_type, p_state).toJSonString();
    }

getErrorAsQueryString()

String org.xdi.oxauth.model.error.ErrorResponseFactory.getErrorAsQueryString ( IErrorType  p_type, String  p_state  )

inline

                                                                           {
        return getErrorResponse(p_type, p_state).toQueryString();
    }

getErrorResponse() [1/2]

DefaultErrorResponse org.xdi.oxauth.model.error.ErrorResponseFactory.getErrorResponse ( IErrorType  type, String  p_state  )

inline

                                                                                  {
        final DefaultErrorResponse response = getErrorResponse(type);
        response.setState(p_state);
        return response;
    }

getErrorResponse() [2/2]

DefaultErrorResponse org.xdi.oxauth.model.error.ErrorResponseFactory.getErrorResponse ( IErrorType  type )

inline

                                                                  {
        final DefaultErrorResponse response = new DefaultErrorResponse();
        response.setType(type);

        if (type != null && messages != null) {
            List<ErrorMessage> list = null;
            if (type instanceof AuthorizeErrorResponseType) {
                list = messages.getAuthorize();
            } else if (type instanceof ClientInfoErrorResponseType) {
                list = messages.getClientInfo();
            } else if (type instanceof EndSessionErrorResponseType) {
                list = messages.getEndSession();
            } else if (type instanceof RegisterErrorResponseType) {
                list = messages.getRegister();
            } else if (type instanceof TokenErrorResponseType) {
                list = messages.getToken();
            } else if (type instanceof UmaErrorResponseType) {
                list = messages.getUma();
            } else if (type instanceof UserInfoErrorResponseType) {
                list = messages.getUserInfo();
            } else if (type instanceof U2fErrorResponseType) {
                list = messages.getFido();
            }

            if (list != null) {
                final ErrorMessage m = getError(list, type);
                response.setErrorDescription(m.getDescription());
                response.setErrorUri(m.getUri());
            }
        }

        return response;
    }

getJsonErrorResponse()

String org.xdi.oxauth.model.error.ErrorResponseFactory.getJsonErrorResponse ( IErrorType  type )

inline

                                                        {
        final DefaultErrorResponse response = getErrorResponse(type);

        JsonErrorResponse jsonErrorResponse = new JsonErrorResponse(response);

        try {
            return ServerUtil.asJson(jsonErrorResponse);
        } catch (IOException ex) {
            log.error("Failed to generate error response", ex);
            return null;
        }
    }

getMessages()

ErrorMessages org.xdi.oxauth.model.error.ErrorResponseFactory.getMessages ( )

inline

                                       {
        return messages;
    }

getUmaErrorResponse()

UmaErrorResponse org.xdi.oxauth.model.error.ErrorResponseFactory.getUmaErrorResponse ( IErrorType  type )

inline

                                                                 {
        final UmaErrorResponse response = new UmaErrorResponse();

        final ErrorMessage errorMessage = getError(messages.getUma(), type);
        response.setError(errorMessage.getId());
        response.setErrorDescription(errorMessage.getDescription());
        response.setErrorUri(errorMessage.getUri());

        return response;
    }

getUmaJsonErrorResponse()

String org.xdi.oxauth.model.error.ErrorResponseFactory.getUmaJsonErrorResponse ( IErrorType  type )

inline

                                                           {
        final UmaErrorResponse response = getUmaErrorResponse(type);

        JSONObject jsonObj = new JSONObject();

        try {
            jsonObj.put("error", response.getError());

            if (StringHelper.isNotEmpty(response.getStatus())) {
                jsonObj.put("status", response.getStatus());
            }

            if (StringHelper.isNotEmpty(response.getErrorDescription())) {
                jsonObj.put("error_description", response.getErrorDescription());
            }


            if (StringHelper.isNotEmpty(response.getErrorUri())) {
                jsonObj.put("error_uri", response.getErrorUri());
            }
        } catch (JSONException ex) {
            log.error("Failed to generate error response", ex);
            return null;
        }

        return jsonObj.toString();
    }

setMessages()

void org.xdi.oxauth.model.error.ErrorResponseFactory.setMessages ( ErrorMessages  p_messages )

inline

                                                      {
        messages = p_messages;
    }

throwBadRequestException()

void org.xdi.oxauth.model.error.ErrorResponseFactory.throwBadRequestException ( IErrorType  type ) throws WebApplicationException

inline

                                                                                         {
        throwWebApplicationException(Response.Status.BAD_REQUEST, type);
    }

throwUmaInternalErrorException()

void org.xdi.oxauth.model.error.ErrorResponseFactory.throwUmaInternalErrorException ( ) throws WebApplicationException

inline

                                                                                {
        throwUmaWebApplicationException(Response.Status.INTERNAL_SERVER_ERROR, UmaErrorResponseType.SERVER_ERROR);
    }

throwUmaNotFoundException()

void org.xdi.oxauth.model.error.ErrorResponseFactory.throwUmaNotFoundException ( ) throws WebApplicationException

inline

                                                                           {
        throwUmaWebApplicationException(Response.Status.NOT_FOUND, UmaErrorResponseType.NOT_FOUND);
    }

throwUmaWebApplicationException()

public<T> T org.xdi.oxauth.model.error.ErrorResponseFactory.throwUmaWebApplicationException ( Response.Status  status, IErrorType  type  ) throws WebApplicationException

inlinepackage

                                                                                                                         {
        final Response response = Response.status(status).entity(getUmaJsonErrorResponse(type)).build();
        throw new WebApplicationException(response);
    }

throwUnauthorizedException()

void org.xdi.oxauth.model.error.ErrorResponseFactory.throwUnauthorizedException ( IErrorType  type ) throws WebApplicationException

inline

                                                                                           {
        throwWebApplicationException(Response.Status.UNAUTHORIZED, type);
    }

throwWebApplicationException()

void org.xdi.oxauth.model.error.ErrorResponseFactory.throwWebApplicationException ( Response.Status  status, IErrorType  type  ) throws WebApplicationException

inline

                                                                                                                     {
        final Response response = Response.status(status).entity(getErrorAsJson(type)).build();
        throw new WebApplicationException(response);
    }

メンバ詳解

log

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

staticprivate

messages

ErrorMessages org.xdi.oxauth.model.error.ErrorResponseFactory.messages

private

---

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

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