nablarch.fw.web.interceptor.OnError Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nablarch-fw-web Show documentation
There is a newer version: 2.2.0
package nablarch.fw.web.interceptor;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import nablarch.core.util.annotation.Published;
import nablarch.fw.ExecutionContext;
import nablarch.fw.Interceptor;
import nablarch.fw.web.HttpErrorResponse;
import nablarch.fw.web.HttpRequest;
import nablarch.fw.web.HttpResponse;

/**
 * リクエストハンドラが例外を送出した場合のレスポンスを指定する{@link Interceptor}。
 *  * 次の例では、"ApplicationException"が送出された場合の遷移先を
 * 入力画面(registerForm.jsp)に設定している。
 * 
 * {@code @OnError} (
 *      type = ApplicationException.class
 *    , path ="servlet://registerForm.jsp"
 *  )
 *  public HttpResponse handle(HttpRequest req, ExecutionContext ctx) {
 *      registerUser(req.getParamMap());
 *      return new HttpResponse(200, "servlet://registrationCompleted.jsp");
 *  }
 *  
 *  この処理は、以下のコードによる処理と本質的に同等である。
 *  
 *  public HttpResponse handle(HttpRequest req, ExecutionContext ctx) {
 *      try {
 *          registerUser(req.getParamMap());
 *          return new HttpResponse(200, "servlet://registrationCompleted.jsp");
 *      } catch(ApplicationException ae) {
 *          throw new HttpErrorResponse(400, "servlet://registerForm.jsp", ae);
 *      }
 *  }
 * 
 *
 * @author Iwauo Tajima 
 * @see OnError.Impl
 */
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Interceptor(OnError.Impl.class)
@Published
public @interface OnError {
    /**
     * このインターセプタがハンドリングする実行時例外。
     * (必須属性)
     */
    Class type();

    /**
     * リクエストハンドラから、{@link #type}
     * に合致する実行時例外が送出された場合に送信する画面のリソースパスを返す。
     * (必須属性)
     */
    String path();

    /**
     * リクエストハンドラから、{@link #type}
     * に合致する実行時例外が送出された場合のレスポンスステータスを返す。
     *      * デフォルトではステータスコード400(Bad Request)となる。
     * 
     */
    int statusCode() default 400;

    /**
     * {@link OnError}インターセプタの実装。
     *
     * @author Iwauo Tajima 
     * @see OnError
     */
    public static class Impl
    extends Interceptor.Impl {
        /**
         * {@inheritDoc}
         *          * このクラスの実装では、以下の処理を行う。
         *   1.  {@link OnError}アノテーションが付与されたhandleメソッドを実行する。
         *   2a. 1.の結果、{@link OnError#type}に指定された例外クラスが送出された場合は、
         *       statusCodeに指定されたステータスコード、pathに指定されたコンテンツパスの
         *       レスポンスエラー例外を送出する。
         *   2b. そうでない場合は、1.の結果をそのまま返却する。
         * 
         * {@link OnError}アノテーションの{@link OnError#type}に指定された実行時例外を捕捉し、
         * 同じく{@link OnError#path}に指定された画面へのレスポンスを作成して返す。
         * 
         */
        public HttpResponse handle(HttpRequest req, ExecutionContext ctx) {
            OnError onError = getInterceptor();
            Class errorType = onError.type();

            try {
                return getOriginalHandler().handle(req, ctx);

            } catch (RuntimeException e) {
                if (errorType.isAssignableFrom(e.getClass())) {
                    throw new HttpErrorResponse(
                        onError.statusCode(), onError.path(), e
                    );
                }
                throw e;
            }
        }
    }
}