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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
|
/*
* 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.contribution.service.impl;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;
import java.net.URLClassLoader;
import java.net.URLConnection;
import java.util.ArrayList;
import java.util.List;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException;
import org.apache.tuscany.sca.assembly.AssemblyFactory;
import org.apache.tuscany.sca.assembly.Composite;
import org.apache.tuscany.sca.contribution.Artifact;
import org.apache.tuscany.sca.contribution.Contribution;
import org.apache.tuscany.sca.contribution.ContributionFactory;
import org.apache.tuscany.sca.contribution.ModelFactoryExtensionPoint;
import org.apache.tuscany.sca.contribution.processor.PackageProcessor;
import org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor;
import org.apache.tuscany.sca.contribution.processor.URLArtifactProcessor;
import org.apache.tuscany.sca.contribution.resolver.ExtensibleModelResolver;
import org.apache.tuscany.sca.contribution.resolver.ModelResolver;
import org.apache.tuscany.sca.contribution.resolver.ModelResolverExtensionPoint;
import org.apache.tuscany.sca.contribution.service.ContributionException;
import org.apache.tuscany.sca.contribution.service.ContributionRepository;
import org.apache.tuscany.sca.contribution.service.ContributionService;
import org.apache.tuscany.sca.contribution.service.ExtensibleContributionListener;
import org.apache.tuscany.sca.contribution.service.util.IOHelper;
import org.apache.tuscany.sca.contribution.xml.ContributionMetadataDocumentProcessor;
/**
* Service interface that manages artifacts contributed to a Tuscany runtime.
*
* @version $Rev$ $Date$
*/
/**
*
*/
public class ContributionServiceImpl implements ContributionService {
/**
* Repository where contributions are stored. Usually set by injection.
*/
private ContributionRepository contributionRepository;
/**
* Registry of available package processors.
*/
private PackageProcessor packageProcessor;
/**
* Registry of available artifact processors
*/
private URLArtifactProcessor artifactProcessor;
/**
* Registry of available stax processors,
* used for loading contribution metadata in a extensible way
*/
private StAXArtifactProcessor staxProcessor;
/**
* Event listener for contribution operations
*/
private ExtensibleContributionListener contributionListener;
/**
* Registry of available model resolvers
*/
private ModelResolverExtensionPoint modelResolvers;
/**
* Model factory extension point
*/
private ModelFactoryExtensionPoint modelFactories;
/**
* xml factory used to create reader instance to load contribution metadata
*/
private XMLInputFactory xmlFactory;
/**
* Assembly factory
*/
private AssemblyFactory assemblyFactory;
/**
* Contribution model factory
*/
private ContributionFactory contributionFactory;
private ModelResolver domainResolver;
private List scaDefinitionsSink = null;
private String COMPOSITE_FILE_EXTN = ".composite";
public ContributionServiceImpl(ContributionRepository repository,
PackageProcessor packageProcessor,
URLArtifactProcessor documentProcessor,
StAXArtifactProcessor staxProcessor,
ExtensibleContributionListener contributionListener,
ModelResolver domainResolver,
ModelResolverExtensionPoint modelResolvers,
ModelFactoryExtensionPoint modelFactories,
AssemblyFactory assemblyFactory,
ContributionFactory contributionFactory,
XMLInputFactory xmlFactory,
List scaDefnSink) {
super();
this.contributionRepository = repository;
this.packageProcessor = packageProcessor;
this.artifactProcessor = documentProcessor;
this.staxProcessor = staxProcessor;
this.contributionListener = contributionListener;
this.modelResolvers = modelResolvers;
this.modelFactories = modelFactories;
this.xmlFactory = xmlFactory;
this.assemblyFactory = assemblyFactory;
this.contributionFactory = contributionFactory;
this.domainResolver = domainResolver;
this.scaDefinitionsSink = scaDefnSink;
}
public Contribution contribute(String contributionURI, URL sourceURL, boolean storeInRepository)
throws ContributionException, IOException {
if (contributionURI == null) {
throw new IllegalArgumentException("URI for the contribution is null");
}
if (sourceURL == null) {
throw new IllegalArgumentException("Source URL for the contribution is null");
}
return addContribution(contributionURI, sourceURL, null, null, storeInRepository);
}
public Contribution contribute(String contributionURI,
URL sourceURL,
ModelResolver modelResolver,
boolean storeInRepository) throws ContributionException, IOException {
if (contributionURI == null) {
throw new IllegalArgumentException("URI for the contribution is null");
}
if (sourceURL == null) {
throw new IllegalArgumentException("Source URL for the contribution is null");
}
return addContribution(contributionURI, sourceURL, null, modelResolver, storeInRepository);
}
public Contribution contribute(String contributionURI, URL sourceURL, InputStream input)
throws ContributionException, IOException {
return addContribution(contributionURI, sourceURL, input, null, true);
}
public Contribution contribute(String contributionURI, URL sourceURL, InputStream input, ModelResolver modelResolver)
throws ContributionException, IOException {
return addContribution(contributionURI, sourceURL, input, modelResolver, true);
}
public Contribution getContribution(String uri) {
return this.contributionRepository.getContribution(uri);
}
/**
* Remove a contribution and notify listener that contribution was removed
*/
public void remove(String uri) throws ContributionException {
Contribution contribution = contributionRepository.getContribution(uri);
this.contributionRepository.removeContribution(contribution);
this.contributionListener.contributionRemoved(this.contributionRepository, contribution);
}
/**
* Add a composite model to the contribution
*/
public void addDeploymentComposite(Contribution contribution, Composite composite) throws ContributionException {
Artifact artifact = this.contributionFactory.createArtifact();
artifact.setURI(composite.getURI());
artifact.setModel(composite);
contribution.getArtifacts().add(artifact);
contribution.getDeployables().add(composite);
}
/**
* Utility/Helper methods for contribution service
*/
/**
* Perform read of the contribution metada loader (sca-contribution.xml and sca-contribution-generated.xml)
* When the two metadata files are available, the information provided are merged, and the sca-contribution has priorities
*
* @param sourceURL
* @return Contribution
* @throws ContributionException
*/
private Contribution readContributionMetadata(URL sourceURL) throws ContributionException {
Contribution contributionMetadata = contributionFactory.createContribution();
ContributionMetadataDocumentProcessor metadataDocumentProcessor =
new ContributionMetadataDocumentProcessor(staxProcessor, xmlFactory);
URL[] urls = {sourceURL};
URLClassLoader cl = new URLClassLoader(urls, null);
for (String path: new String[]{
Contribution.SCA_CONTRIBUTION_GENERATED_META,
Contribution.SCA_CONTRIBUTION_META}) {
URL url = cl.getResource(path);
if (url != null) {
Contribution contribution = metadataDocumentProcessor.read(sourceURL, URI.create(path), url);
contributionMetadata.getImports().addAll(contribution.getImports());
contributionMetadata.getExports().addAll(contribution.getExports());
contributionMetadata.getDeployables().addAll(contribution.getDeployables());
}
}
// For debugging purposes, write it back to XML
// if (contributionMetadata != null) {
// try {
// ByteArrayOutputStream bos = new ByteArrayOutputStream();
// XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
// outputFactory.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.TRUE);
// staxProcessor.write(contributionMetadata, outputFactory.createXMLStreamWriter(bos));
// Document document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(new ByteArrayInputStream(bos.toByteArray()));
// OutputFormat format = new OutputFormat();
// format.setIndenting(true);
// format.setIndent(2);
// XMLSerializer serializer = new XMLSerializer(System.out, format);
// serializer.serialize(document);
// } catch (Exception e) {
// e.printStackTrace();
// }
// }
return contributionMetadata;
}
/**
* Note:
*
* @param contributionURI ContributionID
* @param sourceURL contribution location
* @param contributionStream contribution content
* @param storeInRepository flag if we store the contribution into the
* repository or not
* @return the contribution model representing the contribution
* @throws IOException
* @throws DeploymentException
*/
private Contribution addContribution(String contributionURI,
URL sourceURL,
InputStream contributionStream,
ModelResolver modelResolver,
boolean storeInRepository) throws IOException, ContributionException {
if (contributionStream == null && sourceURL == null) {
throw new IllegalArgumentException("The content of the contribution is null.");
}
// store the contribution in the contribution repository
URL locationURL = sourceURL;
if (contributionRepository != null && storeInRepository) {
if (contributionStream == null) {
locationURL = contributionRepository.store(contributionURI, sourceURL);
} else {
locationURL = contributionRepository.store(contributionURI, sourceURL, contributionStream);
}
}
//initialize contribution based on it's metadata if available
Contribution contribution = readContributionMetadata(locationURL);
// Create contribution model resolver
if (modelResolver == null) {
//FIXME Remove this domain resolver, visibility of policy declarations should be handled by
// the contribution import/export mechanism instead of this domainResolver hack.
modelResolver = new ExtensibleModelResolver(contribution, modelResolvers, modelFactories, domainResolver);
}
//set contribution initial information
contribution.setURI(contributionURI.toString());
contribution.setLocation(locationURL.toString());
contribution.setModelResolver(modelResolver);
List<URI> contributionArtifacts = null;
//NOTE: if a contribution is stored on the repository
//the stream would be consumed at this point
if (storeInRepository || contributionStream == null) {
URLConnection connection = sourceURL.openConnection();
connection.setUseCaches(false);
contributionStream = connection.getInputStream();
try {
// process the contribution
contributionArtifacts = this.packageProcessor.getArtifacts(locationURL, contributionStream);
} finally {
IOHelper.closeQuietly(contributionStream);
contributionStream = null;
}
} else {
// process the contribution
contributionArtifacts = this.packageProcessor.getArtifacts(locationURL, contributionStream);
}
// Read all artifacts in the contribution
try {
processReadPhase(contribution, contributionArtifacts);
} catch ( Exception e ) {
throw new ContributionException(e);
}
//
this.contributionListener.contributionAdded(this.contributionRepository, contribution);
// Resolve them
processResolvePhase(contribution);
// Add all composites under META-INF/sca-deployables to the
// list of deployables
String prefix = Contribution.SCA_CONTRIBUTION_DEPLOYABLES;
for (Artifact artifact : contribution.getArtifacts()) {
if (artifact.getModel() instanceof Composite) {
if (artifact.getURI().startsWith(prefix)) {
Composite composite = (Composite)artifact.getModel();
if (!contribution.getDeployables().contains(composite)) {
contribution.getDeployables().add(composite);
}
}
}
}
// store the contribution on the registry
this.contributionRepository.addContribution(contribution);
return contribution;
}
/**
* This utility method process each artifact and delegates to proper
* artifactProcessor to read the model and generate the in-memory representation
*
* @param contribution
* @param artifacts
* @throws ContributionException
* @throws MalformedURLException
*/
private void processReadPhase(Contribution contribution, List<URI> artifacts) throws ContributionException,
MalformedURLException, XMLStreamException {
ModelResolver modelResolver = contribution.getModelResolver();
URL contributionURL = new URL(contribution.getLocation());
List<URI> compositeUris = new ArrayList<URI>();
Object model = null;
for (URI anArtifactUri : artifacts) {
if ( anArtifactUri.toString().endsWith(COMPOSITE_FILE_EXTN)) {
compositeUris.add(anArtifactUri);
} else {
URL artifactURL = packageProcessor.getArtifactURL(new URL(contribution.getLocation()), anArtifactUri);
// Add the deployed artifact model to the resolver
Artifact artifact = this.contributionFactory.createArtifact();
artifact.setURI(anArtifactUri.toString());
artifact.setLocation(artifactURL.toString());
contribution.getArtifacts().add(artifact);
modelResolver.addModel(artifact);
model = this.artifactProcessor.read(contributionURL, anArtifactUri, artifactURL);
if (model != null) {
artifact.setModel(model);
// Add the loaded model to the model resolver
modelResolver.addModel(model);
if ( isSCADefnsFile(anArtifactUri) ) {
scaDefinitionsSink.add(model);
}
}
}
}
for (URI anArtifactUri : compositeUris) {
URL artifactURL = packageProcessor.getArtifactURL(new URL(contribution.getLocation()), anArtifactUri);
// Add the deployed artifact model to the resolver
Artifact artifact = this.contributionFactory.createArtifact();
artifact.setURI(anArtifactUri.toString());
artifact.setLocation(artifactURL.toString());
contribution.getArtifacts().add(artifact);
modelResolver.addModel(artifact);
model = this.artifactProcessor.read(contributionURL, anArtifactUri, artifactURL);
if (model != null) {
artifact.setModel(model);
// Add the loaded model to the model resolver
modelResolver.addModel(model);
}
}
}
/**
* This utility method process each artifact and delegates to proper
* artifactProcessor to resolve the model references
*
* @param contribution
* @throws ContributionException
*/
@SuppressWarnings("unchecked")
private void processResolvePhase(Contribution contribution) throws ContributionException {
List<Artifact> composites = new ArrayList<Artifact>();
// for each artifact that was processed on the contribution
for (Artifact artifact : contribution.getArtifacts()) {
//leave the composites to be resolved at the end
if (artifact.getURI().endsWith(".composite")) {
composites.add(artifact);
} else {
// resolve the model object
if (artifact.getModel() != null) {
this.artifactProcessor.resolve(artifact.getModel(), contribution.getModelResolver());
}
}
}
//process each composite file
for (Artifact artifact : composites) {
// resolve the model object
if (artifact.getModel() != null) {
// System.out.println("Processing Resolve Phase : " + artifact.getURI());
this.artifactProcessor.resolve(artifact.getModel(), contribution.getModelResolver());
}
}
//resolve deployables from contribution metadata
List<Composite> resolvedDeployables = new ArrayList<Composite>();
for (Composite deployableComposite : contribution.getDeployables()) {
Composite resolvedDeployable =
contribution.getModelResolver().resolveModel(Composite.class, deployableComposite);
resolvedDeployables.add(resolvedDeployable);
}
contribution.getDeployables().clear();
contribution.getDeployables().addAll(resolvedDeployables);
}
private boolean isSCADefnsFile(URI uri) {
int index = uri.toString().lastIndexOf("/");
index = (index != -1) ? index + 1 : 0;
return uri.toString().substring(index).equals("definitions.xml");
}
}
|