org.dbflute.remoteapi.exception.translation.ClientErrorTranslatingResource Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.dbflute.remoteapi.exception.translation;

import java.lang.reflect.Type;
import java.util.function.BiFunction;

import org.dbflute.optional.OptionalThing;
import org.dbflute.remoteapi.exception.RemoteApiHttpClientErrorException;

/**
 * @author jflute
 * @since 0.3.3 (2017/09/21 Thursday)
 */
public class ClientErrorTranslatingResource {

    // ===================================================================================
    //                                                                           Attribute
    //                                                                           =========
    protected final Type returnType; // not null
    protected final String url; // not null
    protected final RemoteApiHttpClientErrorException clientError; // not null
    protected final BiFunction validationErrorProvider; // null allowed

    // ===================================================================================
    //                                                                         Constructor
    //                                                                         ===========
    public ClientErrorTranslatingResource(Type returnType, String url, RemoteApiHttpClientErrorException clientError,
            BiFunction validationErrorProvider) {
        this.returnType = returnType;
        this.url = url;
        this.clientError = clientError;
        this.validationErrorProvider = validationErrorProvider;
    }

    // ===================================================================================
    //                                                                              Facade
    //                                                                              ======
    /**
     * Create validation error for action response.
     *      * e.g. unified failure and server-managed message
     *  rule.translateClientError(resource -> {
     *      RemoteApiHttpClientErrorException clientError = resource.getClientError();
     *      if (clientError.getHttpStatus() == 400) { // controlled client error
     *          RemoteHbUnifiedFailureResult result = (RemoteHbUnifiedFailureResult) clientError.getFailureResponse().get();
     *          if (RemoteUnifiedFailureType.VALIDATION_ERROR.equals(result.cause)) {
     *              UserMessages messages = new UserMessages();
     *              result.errors.forEach(error -> {
     *                  error.messages.forEach(message -> {
     *                      messages.add(error.field, UserMessage.asDirectMessage(message));
     *                  });
     *              });
     *              return resource.asActionValidationError(messages);
     *          }
     *      }
     *      return null; // no translation
     *  });
     * 
     * e.g. unified failure and client-managed message
     *  rule.translateClientError(resource -> {
     *      RemoteApiHttpClientErrorException clientError = resource.getClientError();
     *      if (clientError.getHttpStatus() == 400) { // controlled client error
     *          FaicliUnifiedFailureResult result = (FaicliUnifiedFailureResult) clientError.getFailureResponse().get();
     *          if (FaicliUnifiedFailureType.VALIDATION_ERROR.equals(result.cause)) {
     *              UserMessages messages = new UserMessages();
     *              result.errors.forEach(error -> {
     *                  messages.add(error.field, toUserMessage(error));
     *              });
     *              return resource.asActionValidationError(messages);
     *          }
     *      }
     *      return null; // no translation
     * });
     * 
     * @param messages The messages from error response. (NotNull)
     * @return The exception of validation error for action response. (NotNull)
     */
    public RuntimeException asActionValidationError(Object messages) {
        if (messages == null) {
            throw new IllegalArgumentException("The argument 'messages' should not be null.");
        }
        assertValidationErrorPrepared(messages);
        return validationErrorProvider.apply(clientError, messages); // errorHook is HtmlResponse or ApiFailureHook
    }

    /**
     * @param messages The messages from error response. (NotNull)
     * @return The exception of validation error for HTML response. (NotNull)
     * @deprecated use asActionValidationError(), already not only for HTML but also AJAX
     */
    public RuntimeException asHtmlValidationError(Object messages) {
        return asActionValidationError(messages);
    }

    protected void assertValidationErrorPrepared(Object messages) {
        if (validationErrorProvider == null) {
            String msg = "Not found the validation error provider, unsupported?: messages=" + messages;
            throw new IllegalStateException(msg);
        }
    }

    // ===================================================================================
    //                                                                            Accessor
    //                                                                            ========
    public Type getReturnType() {
        return returnType;
    }

    public String getUrl() {
        return url;
    }

    @Deprecated
    public RemoteApiHttpClientErrorException getCause() { // use getClientError()
        return clientError;
    }

    public RemoteApiHttpClientErrorException getClientError() {
        return clientError;
    }

    public OptionalThing> getValidationErrorHook() {
        return OptionalThing.ofNullable(validationErrorProvider, () -> {
            throw new IllegalStateException("Not found the validation error provider: url=" + url);
        });
    }
}