maci.idl

Go to the documentation of this file.

#ifndef maci_IDL
#define maci_IDL

#include <acscommon.idl>
#include <logging_idl.idl>
#include <ACSErrTypeCommon.idl>
#include <maciErrType.idl>

#pragma prefix "ijs.si"
module maci {

        typedef unsigned long AccessDescriptor;

        typedef sequence <string> stringSeq;

        typedef unsigned long Handle;

        typedef string CURL;

        typedef sequence<string> CURLSeq;

        typedef sequence<unsigned long> ulongSeq;

        typedef ulongSeq HandleSeq;

        typedef long long ExecutionId;

        interface LoggingConfigurable {

                /*
                 * Struct that represents log level thresholds used for filtering log records.
                 */
                struct LogLevels {
                        boolean useDefault;
                        AcsLogLevels::logLevelValue minLogLevel;
                        AcsLogLevels::logLevelValue minLogLevelLocal;
                };

                LogLevels get_default_logLevels();
       
                void set_default_logLevels(in LogLevels levels)
                        raises (ACSErrTypeCommon::IllegalArgumentEx);
       
                stringSeq get_logger_names();
       
                LogLevels get_logLevels(in string logger_name)
                        raises (maciErrType::LoggerDoesNotExistEx);
       
                void set_logLevels(in string logger_name, in LogLevels levels)
                        raises (maciErrType::LoggerDoesNotExistEx, ACSErrTypeCommon::IllegalArgumentEx);

                oneway void refresh_logging_config();
        };


        struct ComponentInfo {
            string type;
            
            string code;
            
            Object reference;
            
            string name;

            HandleSeq clients;
            
            Handle container;
            
            string container_name;
            
            Handle h;

            AccessDescriptor access;

            stringSeq interfaces;
        };

        typedef sequence<ComponentInfo> ComponentInfoSeq;

        enum ImplLangType { JAVA, CPP, PYTHON };
        enum ClientType { CLIENT_TYPE, ADMINISTRATOR_TYPE, CONTAINER_TYPE };
        struct AuthenticationData {
                string answer;                          
                ClientType client_type;         
                ImplLangType impl_lang;         
                boolean recover;                        
                ACS::Time timestamp;            

                ExecutionId execution_id;       


        };
        
        interface Client {
           const short MSG_ERROR = 0;

           const short MSG_INFORMATION = 20;
                
           const short MSGID_AUTOLOAD_START = 1;

           const short MSGID_AUTOLOAD_END = 2;

           readonly attribute string name;

           oneway void disconnect ();

           AuthenticationData authenticate (
               in ExecutionId execution_id, 
               in string question       
               );

           oneway void message (
               in short type,      
               in string message   
               );

           oneway void taggedmessage (
               in short type,      
               in short messageID, 
               in string message   
               );

           boolean ping ();

           oneway void components_available (
               in ComponentInfoSeq components   
               );

           oneway void components_unavailable (
               in stringSeq component_names     
               );
           
        }; /* end interface Client */

        struct ClientInfo {
                Handle h;
                Client reference;
                HandleSeq components;
                string name;
                AccessDescriptor access;
        }; /*   struct ClientInfo */

        interface CBComponentInfo : ACS::Callback {
                oneway void working (in ComponentInfo value,
                                        in ACSErr::Completion c,
                                        in ACS::CBDescOut desc);
                
                oneway void done (in ComponentInfo value,
                                        in ACSErr::Completion c,
                                        in ACS::CBDescOut desc);
        };
        
        typedef sequence <ClientInfo> ClientInfoSeq;

        interface Container : Client, LoggingConfigurable{

            ComponentInfo activate_component (
                in Handle h,    






                                
                in ExecutionId execution_id, 


                in string name, 


                in string exe,  












                in string type  







                )
                raises (maciErrType::CannotActivateComponentEx);


            void activate_component_async (
                in Handle h,    






                                
                in ExecutionId execution_id, 


                in string name, 


                in string exe,  












                in string type, 







                                
                in CBComponentInfo callback,
                in ACS::CBDescIn desc
                )
                ;

            void deactivate_component (
                in Handle h     


                )
                raises (maciErrType::CannotDeactivateComponentEx, maciErrType::ComponentDeactivationUncleanEx, maciErrType::ComponentDeactivationFailedEx);


            oneway void shutdown (
                in unsigned long action 














                );

            ComponentInfoSeq get_component_info (
                in HandleSeq h  


                );

            Object restart_component(
                in Handle h             
                )
                raises (maciErrType::CannotRestartComponentEx);
            
            void set_component_shutdown_order(
                in HandleSeq h  
                );

            const string ContainerStatusStartupBeginMsg = "ContainerStatusMsg: Startup begins";
            const string ContainerStatusStartupEndMsg = "ContainerStatusMsg: Startup ends";
            const string ContainerStatusORBInitBeginMsg = "ContainerStatusMsg: ORB initialization begins";
            const string ContainerStatusORBInitEndMsg = "ContainerStatusMsg: ORB initialization ends";
            const string ContainerStatusMgrInitBeginMsg = "ContainerStatusMsg: Manager access initialization begins";
            const string ContainerStatusMgrInitEndMsg = "ContainerStatusMsg: Manager access initialization ends";
            const string ContainerStatusCompAutoloadBeginMsg = "ContainerStatusMsg: Automatic component loading begins";
            const string ContainerStatusCompAutoloadEndMsg = "ContainerStatusMsg: Automatic component loading ends";
            const string ContainerStatusReadyMsg = "ContainerStatusMsg: Ready";

        }; /* end interface Container */

        struct ContainerInfo {
            string name;

            Handle h;

            Container reference;

            HandleSeq components;
        };

        typedef sequence<ContainerInfo> ContainerInfoSeq;

        interface Administrator : Client {

                oneway void client_logged_in (
                        in ClientInfo info,                     
                        in ACS::Time timestamp,         
                        in ExecutionId execution_id     
                        );

                oneway void client_logged_out (
                        in Handle h,                    
                        in ACS::Time timestamp  
                        );

                oneway void container_logged_in (
                        in ContainerInfo info,          
                        in ACS::Time timestamp,         
                        in ExecutionId execution_id     
                        );

                oneway void container_logged_out (
                        in Handle h,                    
                        in ACS::Time timestamp  
                        );

                oneway void components_requested (
                        in HandleSeq clients,           
                        in HandleSeq components,        
                        in ACS::Time timestamp          
                        );

                oneway void components_released (
                        in HandleSeq clients,           
                        in HandleSeq components,        
                        in ACS::Time timestamp          
                        );

                oneway void component_activated (
                        in ComponentInfo info,          
                        in ACS::Time timestamp,         
                        in ExecutionId execution_id     
                );
                
                oneway void component_deactivated (
                        in Handle h,                    
                        in ACS::Time timestamp  
                );
        };

        interface SynchronousAdministrator : Administrator {
        };

        typedef sequence<Object> ObjectSeq;

        const string COMPONENT_SPEC_ANY = "*";

        struct ComponentSpec
        {
                CURL component_name;    
                string component_type;  
                string component_code;  
                string container_name;  
        };

        typedef sequence<ComponentSpec> ComponentSpecSeq;

        interface Manager : LoggingConfigurable {
        
                readonly attribute string domain_name;

                boolean ping();

                ClientInfo login (
                        in Client reference     
                        )
                    raises (maciErrType::NoPermissionEx);


                void logout (
                        in Handle id    
                        )
                    raises (maciErrType::NoPermissionEx);


                Handle register_component (
                        in Handle id,   
                        in string component_url,        
                        in string type,
                        in Object c     
                        )
                    raises (maciErrType::NoPermissionEx,
                            maciErrType::CannotRegisterComponentEx);

                void unregister_component (
                        in Handle id,   
                        in Handle h     
                        )
                    raises (maciErrType::NoPermissionEx,
                            maciErrType::CannotUnregisterComponentEx);

                Object get_service (
                        in Handle id,
                        in CURL service_url,
                        in boolean activate
                        )
                    raises (maciErrType::NoPermissionEx, 
                            maciErrType::CannotGetComponentEx,
                            maciErrType::ComponentNotAlreadyActivatedEx,
                            maciErrType::ComponentConfigurationNotFoundEx);

                Object get_component (
                        in Handle id,
                        in CURL service_url,
                        in boolean activate
                        )
                    raises (maciErrType::NoPermissionEx, 
                            maciErrType::CannotGetComponentEx,
                            maciErrType::ComponentNotAlreadyActivatedEx,
                            maciErrType::ComponentConfigurationNotFoundEx);


                Object get_component_non_sticky (
                        in Handle id,
                        in CURL component_url
                        )
                    raises (maciErrType::NoPermissionEx, 
                            maciErrType::CannotGetComponentEx,
                            maciErrType::ComponentNotAlreadyActivatedEx);

                void make_component_immortal (
                        in Handle id,   
                        in CURL component_url,  
                        in boolean immortal_state       
                        )
                    raises (maciErrType::NoPermissionEx,
                            maciErrType::ComponentNotAlreadyActivatedEx);


                void release_component_async (
                        in Handle id,   
                        in CURL component_url,  
                        in ACS::CBlong callback,
                        in ACS::CBDescIn desc
                        )
                        raises (maciErrType::NoPermissionEx);

                long release_component (
                        in Handle id,   
                        in CURL component_url   
                        )
                    raises (maciErrType::NoPermissionEx, maciErrType::CannotDeactivateComponentEx,
                                maciErrType::ComponentDeactivationUncleanEx, maciErrType::ComponentDeactivationFailedEx);

                long force_release_component (
                        in Handle id,   
                        in CURL component_url   
                        )
                    raises (maciErrType::NoPermissionEx);

                oneway void shutdown (
                        in Handle id,   
                        in unsigned long containers     
                        );

                ContainerInfoSeq get_container_info (
                        in Handle id,   
                        in HandleSeq h, 
                        in string name_wc       
                        )
                    raises (maciErrType::NoPermissionEx);

                ClientInfoSeq get_client_info (
                        in Handle id,   
                        in HandleSeq h, 
                        in string name_wc       
                        )
                    raises (maciErrType::NoPermissionEx);

                ComponentInfoSeq get_component_info (
                        in Handle id,   
                        in HandleSeq h, 
                        in string name_wc,      
                        in string type_wc,      
                        in boolean active_only
                        )
                    raises (maciErrType::NoPermissionEx);

                Object restart_component(
                        in Handle client,       
                        in CURL component_url   
                        )
                    raises (maciErrType::NoPermissionEx, 
                            maciErrType::CannotGetComponentEx);

                ComponentInfo get_dynamic_component(
                        in Handle client,       
                        in ComponentSpec c,     
                        in boolean mark_as_default      
                        )
                        raises (maciErrType::NoPermissionEx, 
                                maciErrType::IncompleteComponentSpecEx, 
                                maciErrType::InvalidComponentSpecEx, 
                                maciErrType::ComponentSpecIncompatibleWithActiveComponentEx, 
                                maciErrType::CannotGetComponentEx);

                ComponentInfo get_collocated_component(
                        in Handle client,       
                        in ComponentSpec c,     
                        in boolean mark_as_default,     
                        in CURL target_component        
                        )
                        raises (maciErrType::NoPermissionEx, 
                                maciErrType::IncompleteComponentSpecEx, 
                                maciErrType::InvalidComponentSpecEx, 
                                maciErrType::ComponentSpecIncompatibleWithActiveComponentEx, 
                                maciErrType::CannotGetComponentEx);

                ComponentInfo get_default_component(
                        in Handle client,       
                        in string component_type        
                        )
                        raises (maciErrType::NoPermissionEx, 
                                maciErrType::NoDefaultComponentEx, 
                                maciErrType::CannotGetComponentEx);

                void shutdown_container(
                        in Handle id,   
                        in string container_name,       
                        in unsigned long action         
                        )
                    raises (maciErrType::NoPermissionEx);

        };

};

#pragma prefix "maci.ijs.si"

module AccessRights {

    const maci::AccessDescriptor INTROSPECT_MANAGER = 0x08000000;

    const maci::AccessDescriptor SHUTDOWN_SYSTEM = 0x04000000;

    const maci::AccessDescriptor REGISTER_COMPONENT = 0x02000000;
};


#endif /* maci_IDL */