/*
 * Copyright (c) 2011 NTT DATA Corporation
 *
 * 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 jp.terasoluna.fw.batch.exception.handler;

import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import jp.terasoluna.fw.batch.constants.LogId;
import jp.terasoluna.fw.logger.TLogger;

/**
 * 例外ハンドラのデフォルト実装.
 *
 * <p>
 * Bean定義に、例外クラスと返却するステータス値のマッピング設定に従って、返却するステータス値を切り替える。<br>
 * マッピング設定を省略した場合は、すべての例外に対してステータス値255を返却する。<br>
 * </p>
 * <p>
 * 本クラスは記述順の上から順に評価することに注意してマッピングの定義を行うこと。<br>
 * たとえば、バッチ例外{@code BatchException}は、{@code java.lang.Exception}の子クラスであるため、
 * 例外ハンドラマップにおいてバッチ例外よりも上に{@code java.lang.Exception}を記述すると、
 * バッチ例外が発生した場合であっても{@code java.lang.Exception}に対するステータスが返却される。
 * </p>
 * <p>
 * <fieldset style="border:1pt solid black;padding:10px;width:100%;"><br>
 * <legend>Bean定義記述例</legend>
 *
 * <pre>
 * <bean id="defaultExceptionHandler" class="jp.terasoluna.fw.batch.exception.handler.DefaultExceptionHandler">
 *   <property name="exceptionToStatusMap">
 *     <map>
 *       <entry key="jp.terasoluna.fw.batch.exception.BatchException" value="123"/>
 *       <entry key="java.lang.Exception" value="100"/>
 *     </map>
 *   </property>
 * </bean>
 * </pre>
 *
 * </fieldset>
 * </p>
 */
public class DefaultExceptionHandler implements ExceptionHandler {
    /**
     * ロガー。
     */
    private static final TLogger LOGGER = TLogger
            .getLogger(DefaultExceptionHandler.class);

    /**
     * デフォルト例外ハンドラのリターンコード.
     */
    protected static final int DEFAULT_EXCEPTION_HANDLER_STATUS = 255;

    /**
     * ハンドリング対象となる例外クラスと返却されるステータス値のマップ
     */
    protected Map<Class<? extends Throwable>, Integer> exceptionToStatusMap = null;

    /**
     * 例外クラスと返却するステータス値のマップを設定する。
     * @param exceptionToStatusMap Map<Class<? extends Throwable>, Integer>
     */
    public void setExceptionToStatusMap(
            Map<Class<? extends Throwable>, Integer> exceptionToStatusMap) {
        this.exceptionToStatusMap = exceptionToStatusMap;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int handleThrowableException(Throwable e) {
        // ERRORログを出力する
        LOGGER.error(LogId.EAL025053, e);

        // 例外クラスと返却するステータス値のマップが設定されていた場合はそれに従う
        if (this.exceptionToStatusMap != null && e != null) {
            Class<? extends Throwable> exClass = e.getClass();

            Set<Entry<Class<? extends Throwable>, Integer>> es = this.exceptionToStatusMap
                    .entrySet();

            for (Entry<Class<? extends Throwable>, Integer> ent : es) {
                if (ent != null && ent.getKey() != null
                        && ent.getValue() != null) {
                    Class<? extends Throwable> entClass = ent.getKey();

                    if (entClass.isAssignableFrom(exClass)) {
                        if(LOGGER.isDebugEnabled()){
                            LOGGER.debug(LogId.DAL025017, exClass.getName(),entClass.getName(),ent.getValue());
                        }

                        return ent.getValue().intValue();
                    }
                }
            }
        }

        // デフォルトのステータス値を返す。
        return DEFAULT_EXCEPTION_HANDLER_STATUS;
    }
}