acsdaemon.idl

Go to the documentation of this file.

#ifndef _ACSDAEMON_IDL_
#define _ACSDAEMON_IDL_

/*******************************************************************************
*    ALMA - Atacama Large Millimiter Array
*
*    (c) European Southern Observatory, 2002
*    Copyright by ESO (in the framework of the ALMA collaboration)
*    and Cosylab 2002, All rights reserved
*
*    This library is free software; you can redistribute it and/or
*    modify it under the terms of the GNU Lesser General Public
*    License as published by the Free Software Foundation; either
*    version 2.1 of the License, or (at your option) any later version.
*
*    This library is distributed in the hope that it will be useful,
*    but WITHOUT ANY WARRANTY; without even the implied warranty of
*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
*    Lesser General Public License for more details.
*
*    You should have received a copy of the GNU Lesser General Public
*    License along with this library; if not, write to the Free Software
*    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*
* "@(#) $Id: acsdaemon.idl,v 1.25 2012/11/22 08:20:21 hsommer Exp $"
*
* who       when      what
* --------  --------  ----------------------------------------------
* msekoran 2006-06-21 created
*
* This file comes from module ACS/LGPL/CommonSoftware/acsdaemonidl
*/

#include <acscommon.idl>
#include <acscomponent.idl>
#include <ACSErrTypeCommon.idl>
#include <maciErrType.idl>
#include <acsdaemonErrType.idl>

#pragma prefix "alma"

module acsdaemon 
{

        interface DaemonCallback : ACS::OffShoot
        {
                void done(in ACSErr::Completion comp);

                void working(in ACSErr::Completion comp);
        };


        const string containerDaemonServiceName = "ACSContainerDaemon";


        interface ContainerDaemon
        {
        void start_container(
                        in string container_type, 
                        in string container_name, 
                        in short instance_number,
                        in ACS::stringSeq type_modifiers,
                        in string flags)
                                raises (acsdaemonErrType::FailedToStartContainerEx, ACSErrTypeCommon::BadParameterEx);
                                
        void start_container_sync(
                        in string container_type, 
                        in string container_name, 
                        in short instance_number,
                        in ACS::stringSeq type_modifiers,
                        in string flags)
                                raises (acsdaemonErrType::FailedToStartContainerEx, ACSErrTypeCommon::BadParameterEx);
                                
        void stop_container(in string container_name, 
                        in short instance_number, 
                        in string flags) 
                                raises (acsdaemonErrType::FailedToStopContainerEx, ACSErrTypeCommon::BadParameterEx);

        void stop_container_sync(in string container_name, 
                        in short instance_number, 
                        in string flags) 
                                raises (acsdaemonErrType::FailedToStopContainerEx, ACSErrTypeCommon::BadParameterEx);
                                
                                
                                
        void shutdown() raises (maciErrType::NoPermissionEx);
        };



        const string servicesDaemonServiceName = "ACSServicesDaemon";

        const string systemNotificationServiceDefault = "NotifyEventChannelFactory";

        const string systemNotificationServiceLogging = "LoggingNotifyEventChannelFactory";

        const string systemNotificationServiceAlarms = "AlarmNotifyEventChannelFactory";

        const string systemNotificationServiceMonitorarchive = "ArchiveNotifyEventChannelFactory";
        
        typedef string services_definition_xml;
        

        interface DaemonSequenceCallback : ACS::OffShoot
        {
                void done(in ACSErr::Completion comp);

                void working(in string service, in string host, in short instance_number, in ACSErr::Completion comp);
        };


        interface ServiceDefinitionBuilder : ACS::OffShoot
        {
                readonly attribute short acs_instance_number;
                
                void add_naming_service(in string host) raises (ACSErrTypeCommon::BadParameterEx);

                void add_notification_service(in string name, in string host) raises (ACSErrTypeCommon::BadParameterEx);

                void add_xml_cdb(in string host, in boolean recovery, in string xml_cdb_dir) raises (ACSErrTypeCommon::BadParameterEx);

                void add_rdb_cdb(in string host, in boolean recovery, in string config_name) raises (ACSErrTypeCommon::BadParameterEx);

                void add_manager(in string host, in string domain, in boolean recovery) raises (ACSErrTypeCommon::BadParameterEx);

                void add_acs_log(in string host) raises (ACSErrTypeCommon::BadParameterEx);

                void add_logging_service(in string host, in string name) raises (ACSErrTypeCommon::BadParameterEx);

                void add_interface_repository(in string host, in boolean load, in boolean wait_load) raises (ACSErrTypeCommon::BadParameterEx);

                void add_services_definition(in services_definition_xml definition) raises (ACSErrTypeCommon::BadParameterEx);
                
                boolean is_valid(out string error_description);

                services_definition_xml get_services_definition();
                
                void add_alarm_service(in string host) raises (ACSErrTypeCommon::BadParameterEx);

                void close();
                
        };

        
        enum ServiceState { NOT_EXISTING, DEFUNCT, DEGRADED, RUNNING };
        
        struct ServiceInfo {
                string service_type; 
                string service_name; 
                string service_reference; 
        };
        
        typedef sequence<ServiceInfo> ServiceInfoSeq;

        interface ImpBase
        {
                void set_configuration_reference(in short instance_number, in ServiceInfoSeq services_info);
                
                boolean ping();

                oneway void shutdown();
        };



        interface NamingServiceSpell
        {
                void start_naming_service(in DaemonCallback callback, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceAlreadyRunningEx);

                void stop_naming_service(in DaemonCallback callback, in short instance_number) 
                                raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceNotRunningEx);
        };

        interface NamingServiceImp : ImpBase, NamingServiceSpell
        {
                ServiceState get_service_status(in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx);
        };


        interface NotificationServiceSpell
        {
                void start_notification_service(in string name, in DaemonCallback callback, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceAlreadyRunningEx);

                void stop_notification_service(in string name, in DaemonCallback callback, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceNotRunningEx);

        };


        interface NotificationServiceImp : ImpBase, NotificationServiceSpell
        {
                ServiceState get_service_status(in string name, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx);
        };

        interface CDBSpell
        {

                void start_xml_cdb(in DaemonCallback callback, in short instance_number, in boolean recovery, in string xml_cdb_dir) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceAlreadyRunningEx);

                void start_rdb_cdb(in DaemonCallback callback, in short instance_number, in boolean recovery, in string config_name) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceAlreadyRunningEx);

                void stop_cdb(in DaemonCallback callback, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceNotRunningEx);

        };

        interface CDBImp : ImpBase, CDBSpell
        {
                ServiceState get_service_status(in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx);
        };

        interface ManagerSpell
        {
                void start_manager(in string domain, in DaemonCallback callback, in short instance_number, in boolean recovery)
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceAlreadyRunningEx);

                void stop_manager(in string domain, in DaemonCallback callback, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceNotRunningEx);

        };

        interface ManagerImp : ImpBase, ManagerSpell
        {
                ServiceState get_service_status(in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx);
        };


        interface ACSLogSpell
        {
                void start_acs_log(in DaemonCallback callback, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceAlreadyRunningEx);

                void stop_acs_log(in DaemonCallback callback, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceNotRunningEx);

        };

        interface ACSLogImp : ImpBase, ACSLogSpell
        {
                ServiceState get_service_status(in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx);
        };


        interface LoggingServiceSpell
        {
                void start_logging_service(in string name, in DaemonCallback callback, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceAlreadyRunningEx);

                void stop_logging_service(in string name, in DaemonCallback callback, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceNotRunningEx);

        };

        interface LoggingServiceImp : ImpBase, LoggingServiceSpell
        {
                ServiceState get_service_status(in string name, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx);
        };

        interface InterfaceRepositorySpell
        {
                void start_interface_repository(in boolean load, in boolean wait_load, in DaemonCallback callback, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceAlreadyRunningEx);

                void stop_interface_repository(in DaemonCallback callback, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceNotRunningEx);

        };

        interface InterfaceRepositoryImp : ImpBase, InterfaceRepositorySpell
        {
                ServiceState get_service_status(in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx);
        };

        interface AlarmServiceSpell
        {
                void start_alarm_service(in DaemonCallback callback, in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceAlreadyRunningEx);

                void stop_alarm_service(in DaemonCallback callback, in short instance_number) 
                                raises (ACSErrTypeCommon::BadParameterEx, acsdaemonErrType::ServiceNotRunningEx);
        };

        interface AlarmServiceImp : ImpBase, AlarmServiceSpell
        {
                ServiceState get_service_status(in short instance_number) 
                        raises (ACSErrTypeCommon::BadParameterEx);
        };

        interface ServicesDaemon :
                NamingServiceSpell, NotificationServiceSpell, CDBSpell,
                ManagerSpell, ACSLogSpell, LoggingServiceSpell, InterfaceRepositorySpell, AlarmServiceSpell
        {
                ServiceDefinitionBuilder create_service_definition_builder(in short instance_number)
                        raises (ACSErrTypeCommon::BadParameterEx, ACSErrTypeCommon::NoResourcesEx);
                        
                void start_services(in services_definition_xml definition, in boolean reuse_services, in DaemonSequenceCallback callback) 
                        raises (ACSErrTypeCommon::BadParameterEx);

                void stop_services(in services_definition_xml definition, in DaemonSequenceCallback callback) 
                        raises (ACSErrTypeCommon::BadParameterEx);

                void start_acs( 
                                in DaemonSequenceCallback callback,
                                in short instance_number, 
                                in string flags)
                        raises (ACSErrTypeCommon::BadParameterEx);

                void stop_acs(
                                in DaemonSequenceCallback callback,
                                in short instance_number, 
                                in string flags)
                        raises (ACSErrTypeCommon::BadParameterEx);

                string status_acs(in short instance_number)
                        raises (acsdaemonErrType::FailedToGetAcsStatusEx);

                void shutdown() raises (maciErrType::NoPermissionEx);

                void set_configuration_reference(in short instance_number, in ServiceInfoSeq services_info);
        };

};

#endif