summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/tags/java-stable-20060304/sca/core/src/main/java/org/apache/tuscany/core/context/InstanceContext.java
blob: 473762b6b08652976faf2136a79de0b1c33e7ba0 (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
/**
 *
 *  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.
 */
package org.apache.tuscany.core.context;

/**
 * Manages instances of a runtime artifact. An <code>InstanceContext</code> may contain child contexts which
 * themselves manage implementation instances or it may be a leaf context.
 * 
 * @see org.apache.tuscany.core.context.SimpleComponentContext
 * @see org.apache.tuscany.core.context.AggregateContext
 * @see org.apache.tuscany.core.context.EntryPointContext
 * @see org.apache.tuscany.core.context.ExternalServiceContext
 * 
 * @version $Rev$ $Date$
 */
public interface InstanceContext extends Context {

    /**
     * Returns the instance associated with the requested name, which may be in a simple or compound form. Simple (i.e.
     * leaf) contexts will return an instance associated with the service name part of the compound name, which may be
     * null.
     * <p>
     * Aggregate contexts will return an instance (likely a proxy) of a contained entry point context. In this case, the
     * port name on the qualified name will correspond to the aggregate context name and the part name will be used to
     * retrieve the contained entry point context. The latter may be null. If the contained context is not an entry
     * point context, an exception will be thrown.
     * 
     * @param qName a qualified name of the requested instance
     * @return the implementation instance or a proxy to it
     * @throws TargetException if an error occurs retrieving the instance or the requested component is not an entry
     *         point.
     * 
     * @see AggregateContext
     * @see org.apache.tuscany.model.assembly.EntryPoint
     */
    public Object getInstance(QualifiedName qName) throws TargetException;

    /**
     * Returns an instance associated with the requested name without notifying <code>ContextEventListener</code>s
     * that may be registered with this context on instance creation. Note that {@link #getInstance(QualifiedName)}
     * should generally be called and this method is only provided as an optimization for particular circumstances.
     * 
     * @param qName a qualified name of the requested instance
     * @param notify whether to notify <code>ContextEventListener</code>s
     * @return the instance or a proxy to it
     * @throws TargetException if an error occurs retrieving the instance or proxy
     * @see LifecycleEventListener
     */
    public Object getInstance(QualifiedName qName, boolean notify) throws TargetException;

    /**
     * Returns the implementation instance associated witht he component. An implementation instance does not
     * have a proxy invocation chainXXX
     * @return
     * @throws TargetException
     */
    public Object getImplementationInstance() throws TargetException;

    public Object getImplementationInstance(boolean notify) throws TargetException;

}