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
|
/*
* 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;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import org.apache.tuscany.sca.assembly.Composite;
import org.apache.tuscany.sca.contribution.Contribution;
import org.apache.tuscany.sca.contribution.resolver.ModelResolver;
/**
* Service interface that manages artifacts contributed to a Tuscany runtime.
*
* @version $Rev$ $Date$
*/
public interface ContributionService {
/**
* Contribute an artifact to the SCA Domain. The type of the contribution is
* determined by the Content-Type of the resource or, if that is undefined,
* by some implementation-specific means (such as mapping an extension in
* the URL's path).
*
* @param contributionURI The URI that is used as the contribution unique ID.
* @param sourceURL The location of the resource containing the artifact
* @param storeInRepository Flag that identifies if you want to copy the
* contribution to the repository
* @return The contribution model representing the contribution
* @throws ContributionException if there was a problem with the contribution
* @throws IOException if there was a problem reading the resource
*/
Contribution contribute(String contributionURI, URL sourceURL, boolean storeInRepository) throws ContributionException,
IOException;
/**
* Contribute an artifact to the SCA Domain. The type of the contribution is
* determined by the Content-Type of the resource or, if that is undefined,
* by some implementation-specific means (such as mapping an extension in
* the URL's path).
*
* @param contributionURI The URI that is used as the contribution unique ID.
* @param sourceURL The location of the resource containing the artifact
* @param modelResolver The model resolver to use to resolve models in the
* scope of this contribution
* @param storeInRepository Flag that identifies if you want to copy the
* contribution to the repository
* @return The contribution model representing the contribution
* @throws ContributionException if there was a problem with the contribution
* @throws IOException if there was a problem reading the resource
*/
Contribution contribute(String contributionURI, URL sourceURL, ModelResolver modelResolver, boolean storeInRepository) throws ContributionException,
IOException;
/**
* Contribute an artifact to the SCA Domain.
*
* @param contributionURI The URI that is used as the contribution unique ID.
* @param sourceURL The location of the resource containing the artifact.
* This is used to identify what name should be used when storing
* the contribution on the repository
* @param contributionContent A stream containing the resource being
* contributed; the stream will not be closed but the read
* position after the call is undefined
* @return The contribution model representing the contribution
* @throws ContributionException if there was a problem with the contribution
* @throws IOException if there was a problem reading the stream
*/
Contribution contribute(String contributionURI, URL sourceURL, InputStream contributionContent)
throws ContributionException, IOException;
/**
* Contribute an artifact to the SCA Domain.
*
* @param contributionURI The URI that is used as the contribution unique ID.
* @param sourceURL The location of the resource containing the artifact.
* This is used to identify what name should be used when storing
* the contribution on the repository
* @param modelResolver The model resolver to use to resolve models in the
* scope of this contribution
* @param contributionContent A stream containing the resource being
* contributed; the stream will not be closed but the read
* position after the call is undefined
* @return The contribution model representing the contribution
* @throws ContributionException if there was a problem with the contribution
* @throws IOException if there was a problem reading the stream
*/
Contribution contribute(String contributionURI, URL sourceURL, InputStream contributionContent, ModelResolver modelResolver)
throws ContributionException, IOException;
/**
* Get the model for an installed contribution
*
* @param contribution The URI of an installed contribution
* @return The model for the contribution or null if there is no such
* contribution
*/
Contribution getContribution(String contribution);
/**
* Adds or updates a deployment composite using a supplied composite
* ("composite by value" - a data structure, not an existing resource in the
* domain) to the contribution identified by a supplied contribution URI.
* The added or updated deployment composite is given a relative URI that
* matches the "name" attribute of the composite, with a ".composite"
* suffix.
*
* @param contribution The contribution to where
* @param composite
* @throws ContributionException
*/
void addDeploymentComposite(Contribution contribution, Composite composite) throws ContributionException;
/**
* Remove a contribution from the SCA domain
*
* @param contribution The URI of the contribution
* @throws DeploymentException
*/
void remove(String contribution) throws ContributionException;
}
|
