blob: 10d334a9367770a85d5e9b58fd3bfe539b73437c (
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
|
/*
*
* Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
*
* Licensed 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: 2005/12/22 11:33:21 $ */
#ifndef osoa_sca_componentcontext_h
#define osoa_sca_componentcontext_h
#include "osoa/sca/export.h"
#include "osoa/sca/ServiceList.h"
#include "commonj/sdo/SDO.h"
namespace osoa
{
namespace sca
{
class ComponentContextImpl;
/**
* An SCA component implementation uses the ComponentContext class to
* retrieve information about the configured SCA component.
*/
class SCA_API ComponentContext
{
public:
/**
* Return a new ComponentContext for the current Component.
*/
static ComponentContext getCurrent();
/**
* Resolve a reference name into a single configured service.
* If the component's reference is wired to more than one service
* then theis method will return an exception.
* @param referenceName The reference to be resolved. This must match
* the name of a reference configured in the component type file for
* this component.
*/
void* getService(const char* referenceName);
/**
* Resolve a reference name into a list of configured services.
* @param referenceName The reference to be resolved. This must match
* the name of a reference configured in the component type file for
* this component.
*/
ServiceList getServices(const char* referenceName);
/**
* Get the configured properties for the component.
* @return A data object representing all the properties that
* are configured for this component.
*/
commonj::sdo::DataObjectPtr getProperties();
/**
* Get an SDO data factory which will allow the component to
* create data objects for all the types configured for this
* component.
* @return A data factory to be used by the component to create
* new data objects.
*/
commonj::sdo::DataFactoryPtr getDataFactory();
/**
* Destructor
*/
virtual ~ComponentContext();
ComponentContext(const ComponentContext&);
ComponentContext& operator=(const ComponentContext&);
private:
/**
* Constructor to create an interface class from the contained
* implementation.
* @param implementation the actual implementation class
*/
ComponentContext(ComponentContextImpl* implementation);
/**
* Pointer to the class which provides the actual implementation.
*/
ComponentContextImpl* impl;
};
} // End namespace sca
} // End namespace osoa
#endif // osoa_sca_componentcontext_h
|
