/*
 * 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.core;

import java.util.Set;
import java.net.URL;

/**
 * {@link DefaultServiceLoaderService}のMBeanインタフェース<p>
 * 
 * @author M.Takata
 * @see DefaultServiceLoaderService
 */
public interface DefaultServiceLoaderServiceMBean extends ServiceBaseMBean{
    
    /**
     * サービス定義XMLファイルをスキーマ定義で検証するかどうかを指定する。<p>
     * デフォルトでは、検証しない。<br>
     *
     * @param validate 検証する場合true。
     */
    public void setValidate(boolean validate);
    
    /**
     * サービス定義XMLファイルをスキーマ定義で検証するかどうかを調べる。<p>
     *
     * @return 検証する場合true。
     */
    public boolean isValidate();
    
    /**
     * ここまでにロードしたサービスが全て正常に開始できているかをチェックするかどうかを設定する。<p>
     * この属性をtrueにしておくと、このServiceLoaderの起動完了時に、{@link ServiceManagerFactory#checkLoadManagerCompleted()}を呼び出す。
     *
     * @param isCheck チェックする場合true
     */
    public void setCheckLoadManagerCompleted(boolean isCheck);
    
    /**
     * ここまでにロードしたサービスが全て正常に開始できているかをチェックするかどうかを調べる。<p>
     *
     * @return チェックする場合true
     */
    public boolean isCheckLoadManagerCompleted();
    
    /**
     * 指定したマネージャのサービスが全て正常に開始できているかをチェックするかどうかを設定する。<p>
     * この属性を指定すると、このServiceLoaderの起動完了時に、{@link ServiceManagerFactory#checkLoadManagerCompletedBy(Set)}を呼び出す。
     *
     * @param managerNames チェックするマネージャ名の集合
     */
    public void setCheckLoadManagerCompletedBy(String[] managerNames);
    
    /**
     * サービスが全て正常に開始できているかをチェックするマネージャ名の集合を取得する。<p>
     *
     * @return チェックするマネージャ名の集合
     */
    public String[] getCheckLoadManagerCompletedBy();
    
    /**
     * &lt;manager&gt;要素を表す{@link ServiceManager}インタフェースの実装クラス名を設定する。<p>
     * クラス名は、完全修飾名で設定する。<br>
     * また、設定しない場合は、デフォルトの実装クラスが使用される。デフォルトは、jp.ossc.nimbus.core.ServiceManagerImplである。<br>
     *
     * @param className ServiceManagerインタフェースの実装クラス名
     * @exception ClassNotFoundException 指定したクラス名のクラスが見つからない場合
     * @exception IllegalArgumentException 指定したクラス名のクラスがServiceManagerインタフェースを実装していない場合
     * @see #getServiceManagerClassName()
     * @see ServiceManager
     */
    public void setServiceManagerClassName(String className)
     throws ClassNotFoundException, IllegalArgumentException;
    
    /**
     * &lt;manager&gt;要素を表す{@link ServiceManager}インタフェースの実装クラス名を取得する。<p>
     *
     * @return ServiceManagerインタフェースの実装クラス名
     * @see #setServiceManagerClassName(String)
     * @see ServiceManager
     */
    public String getServiceManagerClassName();
    
    /**
     * サービス定義ファイルのURLを設定する。<p>
     *
     * @param url サービス定義ファイルのURL
     * @exception IllegalArgumentException 指定されたURLが有効なURLでない場合
     * @see #getServiceURL()
     */
    public void setServiceURL(URL url) throws IllegalArgumentException;
    
    /**
     * サービス定義ファイルのURLを取得する。<p>
     *
     * @return サービス定義ファイルのURL
     * @see #setServiceURL(URL)
     */
    public URL getServiceURL();
    
    /**
     * サービス定義ファイルのパスを設定する。<p>
     * ここで指定されたパスは、以下の手順でURLに変更されて、{@link #setServiceURL(URL)}される。<br>
     * パス→URL変換は、以下の順序で行われる。<br>
     * <ol>
     *   <li>指定されたパスがnull、または空文字の場合、デフォルトURL（後述）</li>
     *   <li>指定されたパスがローカルファイルとして存在する場合、ローカルパスをURLに変換したURL</li>
     *   <li>指定されたパスがこのクラスをロードしたクラスローダのリソースとして存在する場合、そのURL</li>
     *   <li>上記全てに当てはまらない場合、例外をthrowする。</li>
     * </ol>
     * デフォルトURLの決定は、以下の順序で行われる。<br>
     * <ol>
     *   <li>システムプロパティjp.ossc.nimbus.service.urlで指定された値を、上記のパス→URL変換でURLに変換した値</li>
     *   <li>このクラスのクラスファイルがロードされたクラスパス上から、nimbus-service.xmlを{@link ClassLoader#getResource(String)}でリソースとして取得したURL。このクラスのクラスファイルがJarファイルに格納されている場合は、そのJarファイルと同じパス上のnimbus-service.xmlのURL</li>
     * </ol>
     *
     * @param path サービス定義ファイルのパス
     * @exception IllegalArgumentException 指定されたパスが有効なパスでない場合
     * @see #setServiceURL(URL)
     */
    public void setServicePath(String path) throws IllegalArgumentException;
    
    public void setDocumentBuilderFactoryClassName(String name);
    public String getDocumentBuilderFactoryClassName();
}