summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/branches/sca-java-integration/spec/sca-api-r1.0/src/main/java/org/osoa/sca/CompositeContext.java
blob: fcca132e0edbf9d7b4961849d3dbbae6a9e4d17b (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
/*
 * 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.    
 */
package org.osoa.sca;


/**
 * @deprecated
 * 
 * Interface used by SCA Components to access their context
 *
 * @version $Rev$ $Date$
 */
public interface CompositeContext {

    /**
     * Returns the name of the parent composite.
     *
     * @return the name of the module
     */
    String getName();

    /**
     * Returns the absolute URI of the composite component.
     *
     * @return the absolute URI of the module component
     */
    String getURI();

    /**
     * Returns the request context that corresponds to the last remotable service invocation. If this is
     * invoked from outside an SCA component then <tt>null</tt> is returned.
     *
     * @return the current request context
     */
    RequestContext getRequestContext();

    /**
     * Returns an object implementing the interface defined for the named service.
     *
     * @param serviceName the name of another service in the current module
     * @return an object that implements the service's interface
     */
    <T> T locateService(Class<T> serviceType, String serviceName);

    /**
     * Create a reference to the supplied component. The component must define only one service.
     *
     * @param self the component to be referenced
     * @return a reference to the component
     */
    ServiceReference createServiceReferenceForSession(Object self);

    /**
     * Create a reference to the named service implemented by the supplied component.
     *
     * @param self        the component to be referenced
     * @param serviceName the service to be referenced
     * @return a reference to the service
     */
    ServiceReference createServiceReferenceForSession(Object self, String serviceName);

    /**
     * Create a new session for stateful interaction with the named service.
     *
     * @param serviceName the name of the service to interact with
     * @return a reference to the service
     */
    ServiceReference newSession(String serviceName);

    /**
     * Create a new session for stateful interaction with the named service using an application-supplied
     * session identifier.
     *
     * @param serviceName the name of the service to interact with
     * @param sessionId   a token that identifies this session
     * @return a reference to the service
     */
    ServiceReference newSession(String serviceName, Object sessionId);
}