/*
 * This software is distributed under following license based on modified BSD
 * style license.
 * ----------------------------------------------------------------------
 * 
 * Copyright 2009 The Nimbus2 Project. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE NIMBUS PROJECT ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
 * NO EVENT SHALL THE NIMBUS PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of the Nimbus2 Project.
 */
package jp.ossc.nimbus.service.aop;

import java.util.Map;

import jp.ossc.nimbus.core.*;

/**
 * {@link DefaultInterceptorChainFactoryService}のMBeanインタフェース<p>
 * 
 * @author M.Takata
 * @see DefaultInterceptorChainFactoryService
 */
public interface DefaultInterceptorChainFactoryServiceMBean
 extends ServiceBaseMBean{
    
    /**
     * {@link InterceptorChainFactory#getInterceptorChain(Object)}の引数で指定するキー文字列として正規表現を有効にするかどうかを設定する。<p>
     * デフォルトでは、false。<br>
     *
     * @param isEnable 正規表現を有効にする場合true
     */
    public void setRegexEnabled(boolean isEnable);
    
    /**
     * {@link InterceptorChainFactory#getInterceptorChain(Object)}の引数で指定するキー文字列として正規表現を有効にするかどうかを判定する。<p>
     *
     * @return trueの場合、正規表現を有効にする
     */
    public boolean isRegexEnabled();
    
    /**
     * 正規表現比較を行う場合に使用するマッチフラグを設定する。<p>
     * 但し、{@link #isRegexEnabled()}がtrueの場合のみ有効である。<br>
     * デフォルトは、0。<br>
     *
     * @param flag マッチフラグ
     * @see java.util.regex.Pattern#CANON_EQ
     * @see java.util.regex.Pattern#CASE_INSENSITIVE
     * @see java.util.regex.Pattern#DOTALL
     * @see java.util.regex.Pattern#MULTILINE
     * @see java.util.regex.Pattern#UNICODE_CASE
     * @see java.util.regex.Pattern#UNIX_LINES
     */
    public void setRegexMatchFlag(int flag);
    
    /**
     * 正規表現比較を行う場合に使用するマッチフラグを取得する。<p>
     *
     * @return マッチフラグ
     */
    public int getRegexMatchFlag();
    
    /**
     * キーに該当する{@link InterceptorChainList}サービス名を設定する。<p>
     *
     * @param mapping キー文字列とInterceptorChainListサービス名のマッピング。キー文字列=InterceptorChainListサービス名で複数指定する
     */
    public void setInterceptorChainListMapping(Map<String, String> mapping);
    
    /**
     * キーに該当する{@link InterceptorChainList}サービス名を取得する。<p>
     *
     * @return キー文字列とInterceptorChainListサービス名のマッピング
     */
    public Map<String, String> getInterceptorChainListMapping();
    
    /**
     * キーに該当する{@link Interceptor}サービス名を設定する。<p>
     * 同じキーに該当する{@link #setInterceptorChainListMapping(Map)}の設定がある場合は、そちらが優先される。<br>
     *
     * @param mapping キー文字列とInterceptorサービス名のマッピング。キー文字列=Interceptorサービス名で複数指定する
     */
    public void setInterceptorMapping(Map<String, String> mapping);
    
    /**
     * キーに該当する{@link Interceptor}サービス名を取得する。<p>
     *
     * @return キー文字列とInterceptorサービス名のマッピング
     */
    public Map<String, String> getInterceptorMapping();
    
    /**
     * {@link #getInterceptorChainListMapping()}に該当する{@link InterceptorChainList}サービスのマッピングが存在しない場合に使用するInterceptorChainListサービスのサービス名を設定する。<p>
     *
     * @param name InterceptorChainListサービスのサービス名
     */
    public void setDefaultInterceptorChainListServiceName(ServiceName name);
    
    /**
     * {@link #getInterceptorChainListMapping()}に該当する{@link InterceptorChainList}サービスのマッピングが存在しない場合に使用するInterceptorChainListサービスのサービス名を取得する。<p>
     *
     * @return InterceptorChainListサービスのサービス名
     */
    public ServiceName getDefaultInterceptorChainListServiceName();
    
    /**
     * キーに該当する{@link Invoker}サービス名を設定する。<p>
     *
     * @param mapping キー文字列とInvokerサービス名のマッピング。キー文字列=Invokerサービス名で複数指定する
     */
    public void setInvokerMapping(Map<String, String> mapping);
    
    /**
     * キーに該当する{@link Invoker}サービス名を取得する。<p>
     *
     * @return キー文字列とInvokerサービス名のマッピング
     */
    public Map<String, String> getInvokerMapping();
    
    /**
     * {@link #getInvokerMapping()}に該当する{@link Invoker}サービスのマッピングが存在しない場合に使用するInvokerサービスのサービス名を設定する。<p>
     * 指定しない場合は、{@link jp.ossc.nimbus.service.aop.invoker.MethodReflectionCallInvokerService MethodReflectionCallInvokerService}が使用される。<br>
     *
     * @param name Invokerサービスのサービス名
     */
    public void setDefaultInvokerServiceName(ServiceName name);
    
    /**
     * {@link #getInvokerMapping()}に該当する{@link Invoker}サービスのマッピングが存在しない場合に使用するInvokerサービスのサービス名を取得する。<p>
     *
     * @return Invokerサービスのサービス名
     */
    public ServiceName getDefaultInvokerServiceName();
    
    /**
     * {@link InterceptorChainFactory#getInterceptorChain(Object)}の戻り値をキャッシュする{@link jp.ossc.nimbus.service.cache.CacheMap CacheMap}サービスのサービス名を設定する。<p>
     * {@link DefaultInterceptorChainFactoryService}が生成する{@link InterceptorChain}は、{@link DefaultThreadLocalInterceptorChain}なので、スレッド単位での再利用が可能である。<br>
     * この属性を指定しない場合は、キャッシュせずに毎回生成する。<br>
     *
     * @param name CacheMapサービスのサービス名
     */
    public void setInterceptorChainCacheMapServiceName(ServiceName name);
    
    /**
     * {@link InterceptorChainFactory#getInterceptorChain(Object)}の戻り値をキャッシュする{@link jp.ossc.nimbus.service.cache.CacheMap CacheMap}サービスのサービス名を取得する。<p>
     *
     * @return CacheMapサービスのサービス名
     */
    public ServiceName getInterceptorChainCacheMapServiceName();
    
    /**
     * {@link InterceptorChain}の実装クラスとして、{@link DefaultThreadLocalInterceptorChain}を使用するかどうかを設定する。<p>
     * falseの場合は、{@link DefaultInterceptorChain}を使用する。
     *
     * @param isUse 使用する場合true
     */
    public void setUseThreadLocalInterceptorChain(boolean isUse);
    
    /**
     * {@link InterceptorChain}の実装クラスとして、{@link DefaultThreadLocalInterceptorChain}を使用するかどうかを判定する。<p>
     *
     * @return trueの場合、使用する
     */
    public boolean isUseThreadLocalInterceptorChain();
}