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

import java.util.Map;
import java.util.Properties;

import jp.ossc.nimbus.core.*;

/**
 * {@link DefaultCodeMasterFinderService}のMBeanインタフェース。<p>
 *
 * @author S.Yoshihara
 */
public interface DefaultCodeMasterFinderServiceMBean
 extends ServiceBaseMBean, CodeMasterFinder{
    
    /**
     * マスタ名配列を設定する。<p>
     *
     * @param names マスタ名の配列
     */
    public void setMasterNames(String[] names);
    
    /**
     * マスタ名配列を取得する。<p>
     *
     * @return マスタ名の配列
     */
    public String[] getMasterNames();
    
    /**
     * マスタ取得のために{@link jp.ossc.nimbus.service.beancontrol.interfaces.BeanFlow BeanFlow}呼び出しを行うための{@link jp.ossc.nimbus.service.beancontrol.interfaces.BeanFlowFactory BeanFlowFactory}サービスのサービス名を設定する。<p>
     * この属性か{@link #setFacadeCallerServiceName(ServiceName)}のどちらか一方は、必ず設定しなければならない。<br>
     * 
     * @param name BeanFlowFactoryサービスのサービス名
     */
    public void setBeanFlowFactoryServiceName(ServiceName name);
    
    /**
     * マスタ取得のために{@link jp.ossc.nimbus.service.beancontrol.interfaces.BeanFlow BeanFlow}呼び出しを行うための{@link jp.ossc.nimbus.service.beancontrol.interfaces.BeanFlowFactory BeanFlowFactory}サービスのサービス名を取得する。<p>
     * 
     * @return BeanFlowFactoryサービスのサービス名
     */
    public ServiceName getBeanFlowFactoryServiceName();
    
    /**
     * JMSトピックを受信するjavax.jms.TopicSubscriberを生成する{@link jp.ossc.nimbus.service.jms.JMSMessageConsumerFactory}サービスのサービス名を設定する。<p>
     * JMSトピックでのマスタ更新を行う場合に使用する。JMSトピックでのマスタ更新を行わない場合は、設定する必要はない。<br>
     *
     * @param name JMSMessageConsumerFactoryサービスのサービス名
     */
    public void setJMSTopicSubscriberFactoryServiceName(ServiceName name);
    
    /**
     * JMSトピックを受信するjavax.jms.TopicSubscriberを生成する{@link jp.ossc.nimbus.service.jms.JMSMessageConsumerFactory}サービスのサービス名を取得する。<p>
     *
     * @return JMSMessageConsumerFactoryサービスのサービス名
     */
    public ServiceName getJMSTopicSubscriberFactoryServiceName();
    
    /**
     * JMSトピックを受信するjavax.jms.TopicSubscriberを生成する{@link jp.ossc.nimbus.service.jms.JMSMessageConsumerFactory}サービスのサービス名を設定する。<p>
     * JMSトピックでのマスタ更新を行う場合に使用する。JMSトピックでのマスタ更新を行わない場合は、設定する必要はない。<br>
     *
     * @param names JMSMessageConsumerFactoryサービスのサービス名配列
     */
    public void setJMSTopicSubscriberFactoryServiceNames(ServiceName[] names);
    
    /**
     * JMSトピックを受信するjavax.jms.TopicSubscriberを生成する{@link jp.ossc.nimbus.service.jms.JMSMessageConsumerFactory}サービスのサービス名を取得する。<p>
     *
     * @return JMSMessageConsumerFactoryサービスのサービス名配列
     */
    public ServiceName[] getJMSTopicSubscriberFactoryServiceNames();
    
    /**
     * {@link jp.ossc.nimbus.service.publish.MessageReceiver MessageReceiver}サービスから{@link jp.ossc.nimbus.service.publish.Message Message}を受信する際のサブジェクト名を設定する。<p>
     *
     * @param subject サブジェクト名
     */
    public void setSubjects(String[] subject);
    
    /**
     * {@link jp.ossc.nimbus.service.publish.MessageReceiver MessageReceiver}サービスから{@link jp.ossc.nimbus.service.publish.Message Message}を受信する際のサブジェクト名を取得する。<p>
     *
     * @return サブジェクト名
     */
    public String[] getSubjects();
    
    /**
     * {@link jp.ossc.nimbus.service.publish.Message Message}を受信する{@link jp.ossc.nimbus.service.publish.MessageReceiver MessageReceiver}サービスのサービス名を設定する。<p>
     * Messageでのマスタ更新を行う場合に使用する。Messageでのマスタ更新を行わない場合は、設定する必要はない。<br>
     *
     * @param name MessageReceiverサービスのサービス名
     */
    public void setMessageReceiverServiceName(ServiceName name);
    
    /**
     * {@link jp.ossc.nimbus.service.publish.Message Message}を受信する{@link jp.ossc.nimbus.service.publish.MessageReceiver MessageReceiver}サービスのサービス名を取得する。<p>
     *
     * @return MessageReceiverサービスのサービス名
     */
    public ServiceName getMessageReceiverServiceName();
    
    /**
     * JMSトピックでマスタ更新を行う場合のマスタ名と通知マスタ名のマッピングを設定する。<p>
     * マスタ名と通知マスタ名が同じ場合は、設定する必要はない。<br>
     *
     * @param mapping マスタ名と通知マスタ名のマッピング。通知マスタ名=マスタ名1,マスタ名2,...
     */
    public void setNotifyMasterNameMapping(Properties mapping);
    
    /**
     * JMSトピックでマスタ更新を行う場合のマスタ名と通知マスタ名のマッピングを取得する。<p>
     *
     * @return マスタ名と通知マスタ名のマッピング。通知マスタ名=マスタ名1,マスタ名2,...
     */
    public Properties getNotifyMasterNameMapping();
    
    /**
     * サービスの開始時に取得するマスタのマスタ名配列を設定する。<p>
     * 指定しない場合は、全てのマスタがサービスの開始時に取得される。<br>
     *
     * @param names マスタ名配列
     */
    public void setStartMasterNames(String[] names);
    
    /**
     * サービスの開始時に取得するマスタのマスタ名配列を取得する。<p>
     *
     * @return マスタ名配列
     */
    public String[] getStartMasterNames();
    
    /**
     * サービスの開始時に取得しないマスタのマスタ名配列を設定する。<p>
     * 指定しない場合は、全てのマスタがサービスの開始時に取得される。<br>
     *
     * @param names マスタ名配列
     */
    public void setNotStartMasterNames(String[] names);
    
    /**
     * サービスの開始時に取得しないマスタのマスタ名配列を取得する。<p>
     *
     * @return マスタ名配列
     */
    public String[] getNotStartMasterNames();
    
    /**
     * サービスの開始時に取得するマスタのマスタ名と入力オブジェクトのマッピングを設定する。<p>
     * 入力が必要ないマスタの場合は、マッピングを設定する必要はない。<br>
     *
     * @param map マスタ名と入力オブジェクトのマップ
     */
    public void setStartMasterInputMap(Map<String, Object> map);
    
    /**
     * サービスの開始時に取得するマスタのマスタ名と入力オブジェクトのマッピングを取得する。<p>
     *
     * @return マスタ名と入力オブジェクトのマップ
     */
    public Map<String, Object> getStartMasterInputMap();
}
