summaryrefslogtreecommitdiffstats
path: root/tags/java-M1-20060518/java/sca/core/src/main/java/org/apache/tuscany/core/context/EntryPointContext.java
blob: 63feabc43cf902460c36233ebe1ddf1fe80cc8db (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
/**
 *
 *  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;

import org.apache.tuscany.core.wire.SourceWireFactory;

/**
 * The runtime artifact representing an entry point, <code>EntryPointContext</code> manages wire handler
 * instances that expose service operations offered by a component in the parent composite. The wire handler
 * instance is responsible for dispatching the request down an wire chain to the target instance. The wire
 * chain may contain {@link org.apache.tuscany.core.wire.Interceptor}s and
 * {@link org.apache.tuscany.core.wire.MessageHandler}s that implement policies or perform mediations on the
 * wire.
 * <p>
 * Entry point contexts are used by transport binding artifacts to invoke an operation on a service. The transport
 * binding uses an {@link java.lang.reflect.InvocationHandler} instance obtained from the <code>EntryPointContext</code>
 * to perform the wire as in:
 * 
 * <pre>
 *              CompositeContext compositeContext = ...
 *              EntryPointContext ctx = (EntryPointContext) compositeContext.getContext(&quot;source&quot;);
 *              Assert.assertNotNull(ctx);
 *              InvocationHandler handler = (InvocationHandler) ctx.getHandler();
 *              Object response = handler.invoke(null, operation, new Object[] { param });
 * </pre>
 * 
 * The <code>Proxy</code> instance passed to <code>InvocationHandler</code> may be null as the client is invoking
 * directly on the handler.
 * <p>
 * Alternatively, the following will return a proxy implementing the service interface exposed by the entry point:
 * 
 * <pre>
 *              CompositeContext compositeContext = ...
 *              EntryPointContext ctx = (EntryPointContext) compositeContext.getContext(&quot;source&quot;);
 *              Assert.assertNotNull(ctx);
 *              HelloWorld proxy = (Helloworld) ctx.getInstance(null); // service name not necessary
 * </pre>
 * 
 * The proxy returned will be backed by the entry point wire chain.
 * 
 * @version $Rev$ $Date$
 */
public interface EntryPointContext extends Context {

    /**
     * Returns the handler responsible for flowing a request through the entry point
     * @throws TargetException
     */
    public Object getHandler() throws TargetException;

    /**
     * Returns the service interface configured for the entry poitn
     */
    public Class getServiceInterface();
}