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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
/*
* 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.builder.impl;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import javax.xml.namespace.QName;
import org.apache.tuscany.sca.assembly.Base;
import org.apache.tuscany.sca.assembly.Component;
import org.apache.tuscany.sca.assembly.ComponentReference;
import org.apache.tuscany.sca.assembly.ComponentService;
import org.apache.tuscany.sca.assembly.Composite;
import org.apache.tuscany.sca.assembly.Endpoint;
import org.apache.tuscany.sca.assembly.EndpointReference;
import org.apache.tuscany.sca.assembly.Implementation;
import org.apache.tuscany.sca.assembly.builder.BuilderContext;
import org.apache.tuscany.sca.assembly.builder.CompositeBuilder;
import org.apache.tuscany.sca.assembly.builder.CompositeBuilderException;
import org.apache.tuscany.sca.assembly.builder.PolicyBuilder;
import org.apache.tuscany.sca.core.ExtensionPointRegistry;
import org.apache.tuscany.sca.monitor.Monitor;
import org.apache.tuscany.sca.policy.Intent;
import org.apache.tuscany.sca.policy.PolicySet;
import org.apache.tuscany.sca.policy.PolicySubject;
import org.apache.tuscany.sca.policy.util.PolicyHelper;
/**
* A composite builder that computes policy sets based on attached intents and policy sets.
* Useful if you want to build the model without making any runtime decisions such as
* reference/services matching
*
* @version $Rev$ $Date$
*/
public class CompositePolicyBuilderImpl extends ComponentPolicyBuilderImpl implements CompositeBuilder {
private final static QName NOLISTENER_INTENT = new QName(Base.SCA11_NS, "noListener");
private CompositeBuilder policyAppliesToBuilder = null;
public CompositePolicyBuilderImpl(ExtensionPointRegistry registry) {
super(registry);
policyAppliesToBuilder = new PolicyAppliesToBuilderImpl(registry);
}
public String getID() {
return "org.apache.tuscany.sca.assembly.builder.CompositePolicyBuilder";
}
public Composite build(Composite composite, BuilderContext context) throws CompositeBuilderException {
computePolicies(composite, context);
checkPolicies(composite, context);
buildPolicies(composite, context);
return composite;
}
protected void computePolicies(Composite composite, BuilderContext context) {
Monitor monitor = context.getMonitor();
monitor.pushContext("Composite: " + composite.getName().toString());
try {
resolveAndCheck(composite, context);
// compute policies recursively
for (Component component : composite.getComponents()) {
monitor.pushContext("Component: " + component.getName());
//resolve component level
resolveAndCheck(component, context);
try {
Implementation implementation = component.getImplementation();
for (ComponentService componentService : component.getServices()) {
monitor.pushContext("Service: " + componentService.getName());
try {
resolveAndCheck(componentService, context);
if (componentService.getInterfaceContract() != null) {
resolveAndCheck(componentService.getInterfaceContract().getInterface(), context);
resolveAndCheck(componentService.getInterfaceContract().getCallbackInterface(), context);
}
for (Endpoint ep : componentService.getEndpoints()) {
if (componentService.getInterfaceContract() != null) {
// Inherit from the component.service.interface
inherit(ep, Intent.Type.interaction, true, componentService.getInterfaceContract().getInterface());
}
// Inherit from composite/component/service
inherit(ep, Intent.Type.interaction, true, composite, ep.getComponent(), ep.getService());
// Inherit from binding
inherit(ep, Intent.Type.interaction, true, ep.getBinding());
// Replace profile intents with their required intents
// Replace unqualified intents if there is a qualified intent in the list
// Replace qualifiable intents with the default qualied intent
resolveAndNormalize(ep, context);
// Replace qualifiable intents with their default qualifier
expandDefaultIntents(ep, context);
// Remove the intents whose @contraints do not include the current element
removeConstrainedIntents(ep, context);
// Remove any direct policy sets if an external one has been applied
removeDirectPolicySetsIfExternalExists(ep, context);
// Validate that noListener is not specified on a service endpoint
checkForNoListenerIntent(ep, context);
// check that all intents are resolved
checkIntentsResolved(ep, context);
// check that the resulting endpoint has no mutually exclusive intents
checkMutualExclusion(ep, context);
}
} finally {
monitor.popContext();
}
}
for (ComponentReference componentReference : component.getReferences()) {
monitor.pushContext("Reference: " + componentReference.getName().toString());
try {
if (componentReference.getInterfaceContract() != null) {
resolveAndCheck(componentReference.getInterfaceContract().getInterface(), context);
resolveAndCheck(componentReference.getInterfaceContract().getCallbackInterface(),
context);
}
for (EndpointReference epr : componentReference.getEndpointReferences()) {
// Inherit from the component.reference.interface
if (componentReference.getInterfaceContract() != null) {
inherit(epr, Intent.Type.interaction, true, componentReference.getInterfaceContract().getInterface());
}
// Inherit from composite/component/reference
inherit(epr, Intent.Type.interaction, true, composite, epr.getComponent(), epr.getReference());
// Inherit from binding
inherit(epr, Intent.Type.interaction, true, epr.getBinding());
// Replace profile intents with their required intents
// Replace unqualified intents if there is a qualified intent in the list
// Replace qualifiable intents with the default qualified intent
resolveAndNormalize(epr, context);
// Replace qualifiable intents with their default qualifier
expandDefaultIntents(epr, context);
// Remove the intents whose @contraints do not include the current element
removeConstrainedIntents(epr, context);
removeDirectPolicySetsIfExternalExists(epr, context);
// check that all intents are resolved
checkIntentsResolved(epr, context);
// check that the resulting endpoint reference has no mutually exclusive intents
checkMutualExclusion(epr, context);
}
} finally {
monitor.popContext();
}
}
if (implementation instanceof Composite) {
inherit(implementation, Intent.Type.implementation, true, component, composite);
computePolicies((Composite)implementation, context);
expandDefaultIntents(implementation,context);
checkIntentsResolved(implementation,context);
} else {
resolveAndCheck(implementation, context);
if (implementation != null) {
inherit(implementation, Intent.Type.implementation, true, component, composite);
// Remove the intents whose @contraints do not include the current element
removeConstrainedIntents(implementation, context);
removeDirectPolicySetsIfExternalExists(implementation, context);
// Replace qualifiable intents with their default qualifier
expandDefaultIntents(implementation, context);
// check that all intents are resolved
checkIntentsResolved(implementation, context);
}
}
} finally {
monitor.popContext();
}
}
} finally {
monitor.popContext();
}
}
private void checkForNoListenerIntent(Endpoint ep, BuilderContext context) {
PolicyHelper helper = new PolicyHelper();
if ( helper.getIntent(ep, NOLISTENER_INTENT) != null ) {
error(context.getMonitor(),
"NoListenerIntentSpecifiedOnService",
this,
ep.toString());
}
}
private void removeDirectPolicySetsIfExternalExists(PolicySubject subject,
BuilderContext context) {
boolean foundExternalPolicySet = false;
for (PolicySet ps : subject.getPolicySets() ) {
if ( ps.getAttachTo() != null )
foundExternalPolicySet = true;
}
if ( foundExternalPolicySet ) {
List<PolicySet> copy = new ArrayList<PolicySet>(subject.getPolicySets());
for ( PolicySet ps : copy ) {
if ( ps.getAttachTo() == null ) {
subject.getPolicySets().remove(ps);
}
}
}
}
/**
* This is mainly about removing policies that don't "applyTo" the element where
* they have ended up after all the attachment and inheritance processing
*
* @param composite
* @param context
*/
protected void checkPolicies(Composite composite, BuilderContext context) throws CompositeBuilderException{
policyAppliesToBuilder.build(composite, context);
}
protected void buildPolicies(Composite composite, BuilderContext context) {
// build policies recursively
for (Component component : composite.getComponents()) {
Implementation implementation = component.getImplementation();
if (implementation instanceof Composite) {
buildPolicies((Composite)implementation, context);
}
}
for (Component component : composite.getComponents()) {
for (ComponentService componentService : component.getServices()) {
for (Endpoint ep : componentService.getEndpoints()) {
Set<QName> policyNames = getPolicyNames(ep);
// check that only one policy language is present in the endpoint's policy sets
if (policyNames.size() > 1){
error(context.getMonitor(),
"MultiplePolicyLanguagesInEP",
this,
ep.toString(),
policyNames.toString());
} else {
for (QName policyType : policyNames) {
PolicyBuilder builder = builders.getPolicyBuilder(policyType);
if (builder != null) {
builder.build(ep, context);
}
}
}
}
}
for (ComponentReference componentReference : component.getReferences()) {
for (EndpointReference epr : componentReference.getEndpointReferences()) {
Set<QName> policyNames = getPolicyNames(epr);
// check that only one policy language is present in the endpoint references's policy sets
if (policyNames.size() > 1){
error(context.getMonitor(),
"MultiplePolicyLanguagesInEPR",
this,
epr.toString(),
policyNames.toString());
} else {
for (QName policyType : policyNames) {
PolicyBuilder builder = builders.getPolicyBuilder(policyType);
if (builder != null) {
builder.build(epr, context);
}
}
}
}
}
Implementation implementation = component.getImplementation();
if (implementation != null) {
Set<QName> policyNames = getPolicyNames(implementation);
// check that only one policy language is present in the implementations's policy sets
if (policyNames.size() > 1){
error(context.getMonitor(),
"MultiplePolicyLanguagesInImplementation",
this,
component.toString(),
policyNames.toString());
} else {
for (QName policyType : policyNames) {
PolicyBuilder builder = builders.getPolicyBuilder(policyType);
if (builder != null) {
builder.build(component, implementation, context);
}
}
}
}
}
}
}
|
