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
|
/*
* 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.deployment;
import java.io.Reader;
import java.io.Writer;
import java.net.URI;
import java.net.URL;
import java.util.List;
import java.util.Map;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import org.apache.tuscany.sca.assembly.Composite;
import org.apache.tuscany.sca.assembly.builder.BuilderContext;
import org.apache.tuscany.sca.assembly.builder.CompositeBuilderException;
import org.apache.tuscany.sca.contribution.Artifact;
import org.apache.tuscany.sca.contribution.Contribution;
import org.apache.tuscany.sca.contribution.ContributionMetadata;
import org.apache.tuscany.sca.contribution.processor.ContributionReadException;
import org.apache.tuscany.sca.contribution.processor.ContributionResolveException;
import org.apache.tuscany.sca.contribution.processor.ContributionWriteException;
import org.apache.tuscany.sca.contribution.processor.ProcessorContext;
import org.apache.tuscany.sca.core.ExtensionPointRegistry;
import org.apache.tuscany.sca.core.LifeCycleListener;
import org.apache.tuscany.sca.definitions.Definitions;
import org.apache.tuscany.sca.monitor.Monitor;
import org.apache.tuscany.sca.monitor.ValidationException;
/**
* A utility that provides system functions to handle Tuscany SCA application deployment
*/
public interface Deployer extends LifeCycleListener {
/**
* Check if Schema Validation for XML Documents is enabled
* @return
*/
boolean isSchemaValidationEnabled();
/**
* Sets Schema Validation for XML Documents flag
* @param schemaValidationEnabled
*/
void setSchemaValidationEnabled(boolean schemaValidationEnabled);
/**
* Attach a deployment composite to the given contribution
* @param contribution The target contribution
* @param composite The deployment composite
* @param appending A flag to indicate if existing deployable composites in the contribution should be appended or replaced
* @return uri of attached composite
*/
String attachDeploymentComposite(Contribution contribution, Composite composite, boolean appending);
/**
* Configure a list of contributions to create a composite representing a view of the domain
* @param contributions
* @param allContributions
* @param bindingBaseURIs
* @param monitor
* @return
* @throws ContributionResolveException
* @throws CompositeBuilderException
*/
Composite build(List<Contribution> contributions, List<Contribution> allContributions, Map<QName, List<String>> bindingBaseURIs, Monitor monitor)
throws ContributionResolveException, CompositeBuilderException;
Composite build(List<Contribution> contributions, List<Contribution> allContributions, Contribution systemContribution, Map<QName, List<String>> bindingBaseURIs, Monitor monitor)
throws ContributionResolveException, CompositeBuilderException;
/**
* Load an artifact from the given location
* @param uri
* @param location
* @param monitor
* @return
* @throws ContributionReadException
*/
Artifact loadArtifact(URI uri, URL location, Monitor monitor) throws ContributionReadException;
/**
* Load a contribution from the given location
* @param uri
* @param location
* @param monitor
* @return
* @throws ContributionReadException
*/
Contribution loadContribution(URI uri, URL location, Monitor monitor) throws ContributionReadException;
/**
* @param <T>
* @param uri
* @param location
* @param monitor
* @return
* @throws ContributionReadException
*/
<T> T loadDocument(URI uri, URL location, Monitor monitor) throws ContributionReadException;
/**
* @param <T>
* @param reader
* @param monitor
* @return
* @throws XMLStreamException
* @throws ContributionReadException
*/
<T> T loadXMLDocument(Reader reader, Monitor monitor) throws XMLStreamException, ContributionReadException;
/**
* @param <T>
* @param reader
* @return
* @throws XMLStreamException
* @throws ContributionReadException
* @throws ValidationException
*/
<T> T loadXMLDocument(Reader reader) throws XMLStreamException, ContributionReadException, ValidationException;
/**
* @param <T>
* @param location
* @param monitor
* @return
* @throws XMLStreamException
* @throws ContributionReadException
*/
<T> T loadXMLDocument(URL location, Monitor monitor) throws XMLStreamException, ContributionReadException;
/**
* @param <T>
* @param reader
* @param monitor
* @return
* @throws ContributionReadException
* @throws XMLStreamException
*/
<T> T loadXMLElement(XMLStreamReader reader, Monitor monitor) throws ContributionReadException, XMLStreamException;
/**
* Save the model as XML
* @param model
* @param writer
* @param monitor
* @throws XMLStreamException
* @throws ContributionWriteException
*/
void saveXMLDocument(Object model, Writer writer, Monitor monitor) throws XMLStreamException,
ContributionWriteException;
/**
* Save the model as XML
* @param model
* @param writer
* @param monitor
* @throws XMLStreamException
* @throws ContributionWriteException
*/
void saveXMLElement(Object model, XMLStreamWriter writer, Monitor monitor) throws XMLStreamException,
ContributionWriteException;
/**
*
* @return
*/
Monitor createMonitor();
/**
* Create an instance of {@link BuilderContext}
* @return
*/
BuilderContext createBuilderContext();
/**
* Create an instance of {@link ProcessorContext}
* @return
*/
ProcessorContext createProcessorContext();
/**
* Get the {@link ExtensionPointRegistry}
* @return
*/
ExtensionPointRegistry getExtensionPointRegistry();
/**
* Get the system definitions
*/
Definitions getSystemDefinitions();
/**
* Resolve a contributions dependencies
*
* @param c
* @param allContributions
* @param monitor
* @throws ContributionResolveException
* @throws CompositeBuilderException
*/
void resolve(List<Contribution> contributionList, Contribution systemContribution, Monitor monitor) throws ContributionResolveException, CompositeBuilderException;
public Contribution cloneSystemContribution(Monitor monitor);
/**
* Get a contributions dependencies from meta data without having to load a Contribution
* @param possibles a Map with key contributionURI and value the contribution metaData
* @param targetURI the contributionURI to find the dependencies of
* @param monitor
* @return the list of contribution URIs
*/
public List<String> getDependencies(Map<String, ContributionMetadata> possibles, String targetURI, Monitor monitor);
}
|
