blob: 014913cfa8dceeb9d312e32e7379fbbae2c74023 (
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
* 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 java.io.Serializable;
import java.util.List;
import org.apache.tuscany.sca.interfacedef.InterfaceContract;
import org.apache.tuscany.sca.policy.PolicySubject;
/**
* Represents a service endpoint which is what results from having a configured
* binding applied to a component service. In a deployed application an endpoint
* will relate directly to a physical endpoint, for example, a HTTP URL or a
* JMS destination.
*
* @version $Rev$ $Date$
* @tuscany.spi.extension.asclient
*/
public interface Endpoint extends Base, PolicySubject, Cloneable, Serializable {
/**
* Get the structural URI of the service binding
* @return structural URI of the service/binding
*/
String getURI();
/**
* Set the structural URI of the service binding
* @param uri <componentURI>#service-binding(serviceName/bindingName)
* or <componentURI>#service(serviceName)
*/
void setURI(String uri);
/**
* Get the deployed URI
* @return The deployed URI
*/
String getDeployedURI();
/**
* Set the deployed URI
* @param deployedURI
*/
void setDeployedURI(String deployedURI);
/**
* Get the component model object
*
* @return component
*/
Component getComponent();
/**
* Set the component model object
*
* @param component
*/
void setComponent(Component component);
/**
* Get the service model object
*
* @return service
*/
ComponentService getService();
/**
* Set the service model object
*
* @param service
*/
void setService(ComponentService service);
/**
* Get the resolved target binding
*
* @return target binding
*/
Binding getBinding();
/**
* Set the binding
*
* @param binding
*/
void setBinding(Binding binding);
/**
* Returns the interface contract defining the interface
*
* @return the interface contract
*/
InterfaceContract getComponentServiceInterfaceContract();
/**
* Get the service's callback endpoint references that
* represent endpoint references from which callbacks
* originate
*
* @return callbackEndpoint the reference callback endpoint
*/
List<EndpointReference> getCallbackEndpointReferences();
/**
* Returns true if this endpoint represents a serivce that is not
* running in this JVM
*
* @return true if the endpoint is remote
*/
boolean isRemote();
/**
* Set true if this endpoint represents a serivce that is not
* running in this JVM
*
* @param remote set to true if the endpoint is remote
*/
void setRemote(boolean remote);
/**
* Supports endpoint cloning
*
* @return endpoint
* @throws CloneNotSupportedException
*/
Object clone() throws CloneNotSupportedException;
/**
* Tests if the URI of this endpoint matches the service URI
* @param serviceName the service URI to test
* @return true if the endpoint URI matches the service URI
*/
boolean matches(String serviceURI);
/**
* When true this endpoint is able to process the invocation
* asynchronously. The forward call is effectively one-way
* and the response will arrive asynchronously
*
* @return true if the service is asynchronous
*/
boolean isAsyncInvocation();
/**
* Get the spec version for this endpoint. This is intended to help
* interop scenarios where having an OASIS endpoint talk to an
* OSOA endpoint implies some restrictions.
*
* @return the spec version, namespace for either SCA-1.0 or SCA-1.1
*/
String getSpecVersion();
/**
* Set the spec version for this endpoint. This is intended to help
* interop scenarios where having an OASIS endpoint talk to an
* OSOA endpoint implies some restrictions. If unset it defaults
* to the namespace for SCA-1.1
*
* @param specVersion the spec version, namspace for either SCA-1.0 or SCA-1.1
*/
void setSpecVersion(String specVersion);
}
|
