summaryrefslogtreecommitdiff
path: root/DAnCE/dance/DAnCE_DeploymentInterceptors.idl
blob: 1f61ce5703247696184b517079b1589ee94d06bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
#ifndef DANCE_DEPLOYMENTINTERCEPTOR_IDL
#define DANCE_DEPLOYMENTINTERCEPTOR_IDL

#include "Deployment/Deployment_DeploymentPlan.idl"
#include "Deployment/Deployment_PlanError.idl"
#include "Deployment/Deployment_InvalidProperty.idl"
#include "Deployment/Deployment_InvalidNodeExecParameter.idl"
#include "Deployment/Deployment_InvalidComponentExecParameter.idl"
#include "Deployment/Deployment_InvalidConnection.idl"
#include "Deployment/Deployment_StartError.idl"
#include "Deployment/Deployment_StopError.idl"

module DAnCE
{
  local interface DeploymentInterceptor
  {
    /// Invoked when the interceptor is loaded, before any other
    /// event.
    void configure (in ::Deployment::Properties config);


    void preprocess_plan (inout ::Deployment::DeploymentPlan plan)
      raises (::Deployment::PlanError);

    void pre_install (inout ::Deployment::DeploymentPlan plan,
                      in unsigned long instanceRef)
      raises (::Deployment::PlanError,
              ::Deployment::InvalidProperty,
              ::Deployment::InvalidNodeExecParameter,
              ::Deployment::InvalidComponentExecParameter);

    void post_install (in ::Deployment::DeploymentPlan plan,
                       in unsigned long instance_index,
                       in any instance_reference,
                       in any exception_thrown)
      raises (::Deployment::PlanError,
              ::Deployment::InvalidProperty,
              ::Deployment::InvalidNodeExecParameter,
              ::Deployment::InvalidComponentExecParameter);

    void post_endpoint_reference (in ::Deployment::DeploymentPlan plan,
                                  in unsigned long connectionRef,
                                  in any endpoint_reference,
                                  in any exception_thrown)
      raises (::Deployment::InvalidConnection);

    void pre_connect (inout ::Deployment::DeploymentPlan plan,
                      in unsigned long connection_index,
                      inout any provided_reference)
      raises (::Deployment::InvalidConnection);

    void post_connect (in Deployment::DeploymentPlan plan,
                       in unsigned long connectionRef,
                       in any exceptionThrown)
      raises (::Deployment::InvalidConnection);

    void pre_disconnect (inout ::Deployment::DeploymentPlan plan,
                         in unsigned long connection_index)
      raises (::Deployment::InvalidConnection);

    void post_disconnect (in Deployment::DeploymentPlan plan,
                          in unsigned long connectionRef,
                          in any exceptionThrown)
      raises (::Deployment::InvalidConnection);

    void post_configured (in ::Deployment::DeploymentPlan plan,
                          in unsigned long instanceRef,
                          in any exception_thrown)
      raises (::Deployment::StartError);

    void post_activate (in ::Deployment::DeploymentPlan plan,
                        in unsigned long instanceRef,
                        in any exception_thrown)
      raises (::Deployment::StartError);

    void post_passivate (in ::Deployment::DeploymentPlan plan,
                         in unsigned long instanceRef,
                         in any exception_thrown)
      raises (::Deployment::StopError);
    void post_remove (in ::Deployment::DeploymentPlan plan,
                      in unsigned long instanceRef,
                      in any exception_thrown)
      raises (::Deployment::StopError);

    /**
     * @brief Invoked on an unexpected event, not usually during normal deployment activity.
     * @param plan The deployment plan which the instance is a part of.
     * @param instanceRef The instance on which this unexpected event took place.
     * @param exception_thrown An exception that was thrown, if any, which should not be re-thrown.
     * @param error A human-readable error message, if appropriate
     */
    void unexpected_event (in ::Deployment::DeploymentPlan plan,
                           in unsigned long instanceRef,
                           in any exception_thrown,
                           in string error);
  };
};

#endif