summaryrefslogtreecommitdiffstats
path: root/tags/java/sca/2.0-M2/modules/assembly/src/main/java/org/apache/tuscany/sca/assembly/EndpointReference2.java
blob: a207f8172716c3043b33b9f2233748602dc23c31 (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
/*
 * 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.apache.tuscany.sca.assembly;

import org.apache.tuscany.sca.interfacedef.InterfaceContract;
import org.apache.tuscany.sca.policy.PolicySubject;

/**
 * Represents an endpoint reference. An SCA reference can reference service endpoints in a 
 * number of ways. Target names, autowire, configured bindings. The endpoint reference
 * captures the result of specifying one of these things. 
 * 
 * @version $Rev$ $Date$
 */
public interface EndpointReference2 extends Base, PolicySubject, Cloneable {  
    
    /**
     * Supports endpoint reference cloning
     * 
     * @return endpointReference
     * @throws CloneNotSupportedException
     */
    Object clone() throws CloneNotSupportedException;
    
    /**
     * Get the component model object
     * 
     * @return component
     */
    Component getComponent();
    
    /**
     * Set the  component model object
     * 
     * @param component the component for the endpoint
     */
    void setComponent(Component component);
    
    /**
     * Get the source component reference model object
     * 
     * @return reference the source component reference  for the endpoint
     */
    ComponentReference getReference();
    
    /**
     * Set the source component reference model object
     * 
     * @param reference
     */
    void setReference(ComponentReference reference);   
    
    /**
     * Get the resolved reference binding 
     * 
     * @return binding the resolved reference binding
     */
    Binding getBinding();
    
    /**
     * Set the resolved reference binding 
     * 
     * @param binding the resolved reference binding
     */
    void setBinding(Binding binding); 
    
    /**
     * Get the target endpoint
     * 
     * @return endpoint the target endpoint
     */
    Endpoint2 getTargetEndpoint();
    
    /**
     * Set the target endpoint model object
     * 
     * @param endpoint the target endpoint
     */
    void setTargetEndpoint(Endpoint2 targetEndpoint);
    
    /**
     * Returns the interface contract defining the interface 
     * 
     * @return the interface contract
     */
    InterfaceContract getInterfaceContract();
    
    /**
     * Sets the interface contract defining the interface 
     * 
     * @param interfaceContract the interface contract
     */
    void setInterfaceContract(InterfaceContract interfaceContract);
    
    /**
     * Get the reference callback endpoint that 
     * represents that target endpoint to which callback 
     * messages will be directed 
     * 
     * @return callbackEndpoint the reference callback endpoint
     */
    Endpoint2 getCallbackEndpoint();
    
    /**
     * Set the reference callback endpoint 
     * 
     * @param callbackEndpoint the reference callback endpoint
     */
    void setCallbackEndpoint(Endpoint2 callbackEndpoint);
}