summaryrefslogtreecommitdiffstats
path: root/tags/cpp-1.0-incubating-M2-RC3/sca/runtime/extensions/cpp/src/tuscany/sca/cpp/CPPServiceWrapper.h
blob: eeeb9cdb82913a0ac16acbe129e54cbde317a2f4 (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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 *   
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/* $Rev$ $Date$ */

#ifndef tuscany_sca_cpp_cppservicewrapper_h
#define tuscany_sca_cpp_cppservicewrapper_h

#include "osoa/sca/export.h"
#include "tuscany/sca/core/ServiceWrapper.h"
#include "tuscany/sca/core/Operation.h"
#include "tuscany/sca/model/Component.h"
#include "tuscany/sca/model/Interface.h"
#include "tuscany/sca/cpp/model/CPPImplementation.h"
#include "tuscany/sca/util/Library.h"

using namespace tuscany::sca::model;


namespace tuscany
{
    namespace sca
    {
        namespace cpp
        {
            
            /**
             * Wraps the service on a component implementation.
             * This abstract class is extended by generated code which provides 
             * the implementation of some of the methods. 
             * An instance of this class wraps the actual component implementation which 
             * has been written by a developer of an SCA application.
             */
            class SCA_CPP_API CPPServiceWrapper : public ServiceWrapper
            {
            public:
                /**
                 * Factory method to create a new CPPServiceWrapper for a given target
                 * service. This method will provide all the loading of dlls required to 
                 * create the target component.
                 * @param target The service on the component for which this wrapper is to be
                 * created.
                 * @return A wrapper that references the given target.
                 */
                static CPPServiceWrapper* getServiceWrapper(Service* service);
    
                /**
                 * Constructor.
                 * @param target The component service to which this wrapper refers.
                 */
                CPPServiceWrapper(Service* service);
    
                /**
                 * Destructor.
                 */ 
                virtual    ~CPPServiceWrapper();
    
                /**
                 * All business method calls to the target component go through the invoke method.
                 * @param operation The details of the method, paramaters and return value for the
                 * business method to be called on the target component.
                 */
                virtual void invoke(Operation& operation);
    
                /**
                 * Return the loaded shared library for the target component.
                 */
                Library* getLibrary() const { return wrapperLibrary; }
                
            protected:
                
                /**
                 * Delegated method to invoke the correct method on the target component. 
                 * Implemented by the subtype.
                 */
                virtual void invokeService(Operation& operation) = 0;
    
                /**
                 * Delegated method to create a new component implementation.
                 * Implemented by the subtype.
                 * @return A pointer to an instance of the component implementation class.
                 */
                virtual void* newImplementation() = 0;
    
                /**
                 * Delegated method to delete the current instance of the component
                 * implementation.
                 * Implemented by the subtype.
                 */
                virtual void deleteImplementation() = 0;
    
                /**
                 * Return the current instance of the component implementation.
                 * @return A pointer to an instance of the component implementation class.
                 */
                virtual void* getImplementation();
    
                /**
                 * Indicates that the current instance of the component implementation
                 * has been finished with. 
                 * Will call CPPServiceWrapper#deleteImplementation if the
                 * implementation is stateless (so that a new instance is returned
                 * for each call).
                 */
                virtual void releaseImplementation();
    
            private:
                /**
                 * Holds an implementation instance if the scope is set to composite.
                 */
                static void* staticImpl;
    
                /**
                 * The component to which this wrapper refers.
                 */
                Component* component;
    
                /**
                 * A pointer to the interface which the service exposes.
                 */
                Interface* interf;
    
                /**
                 * The component implementation
                 */
                 CPPImplementation* implementation;
                
                /**
                 * Pointer to the loaded library which contains the component
                 * implementation.
                 */
                Library* wrapperLibrary;
    
                /**
                 * Set the loaded library which contains the component 
                 * implementation.
                 * @param lib The library.
                 */
                void setLibrary(Library* lib);
            };
            
        } // End namespace cpp
    } // End namespace sca
} // End namespace tuscany

#endif // tuscany_sca_cpp_cppservicewrapper_h