From aaf0d41afc7a24999f3c7d81f800bed37817c853 Mon Sep 17 00:00:00 2001 From: antelder Date: Wed, 27 May 2009 08:42:58 +0000 Subject: Move workspace to contrib as its not used by 2.x trunk code now git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@779058 13f79535-47bb-0310-9956-ffa450edef68 --- .../sca/workspace/DefaultWorkspaceFactory.java | 32 ++++ .../apache/tuscany/sca/workspace/Workspace.java | 39 +++++ .../tuscany/sca/workspace/WorkspaceFactory.java | 36 +++++ .../sca/workspace/builder/ContributionBuilder.java | 49 ++++++ .../builder/ContributionBuilderException.java | 45 ++++++ .../builder/ContributionBuilderExtensionPoint.java | 51 +++++++ .../DefaultContributionBuilderExtensionPoint.java | 138 +++++++++++++++++ .../sca/workspace/impl/WorkspaceFactoryImpl.java | 40 +++++ .../tuscany/sca/workspace/impl/WorkspaceImpl.java | 155 +++++++++++++++++++ .../workspace/xml/WorkspaceDocumentProcessor.java | 130 ++++++++++++++++ .../sca/workspace/xml/WorkspaceProcessor.java | 167 +++++++++++++++++++++ ...ca.contribution.processor.StAXArtifactProcessor | 19 +++ ...g.apache.tuscany.sca.workspace.WorkspaceFactory | 18 +++ ...space.builder.ContributionBuilderExtensionPoint | 18 +++ .../workspace-xml-validation-messages.properties | 22 +++ .../ContributionWorkspaceProcessorTestCase.java | 95 ++++++++++++ 16 files changed, 1054 insertions(+) create mode 100644 java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/DefaultWorkspaceFactory.java create mode 100644 java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/Workspace.java create mode 100644 java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/WorkspaceFactory.java create mode 100644 java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/ContributionBuilder.java create mode 100644 java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/ContributionBuilderException.java create mode 100644 java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/ContributionBuilderExtensionPoint.java create mode 100644 java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/DefaultContributionBuilderExtensionPoint.java create mode 100644 java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/impl/WorkspaceFactoryImpl.java create mode 100644 java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/impl/WorkspaceImpl.java create mode 100644 java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/xml/WorkspaceDocumentProcessor.java create mode 100644 java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/xml/WorkspaceProcessor.java create mode 100644 java/sca-contrib/modules/workspace/src/main/resources/META-INF/services/org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor create mode 100644 java/sca-contrib/modules/workspace/src/main/resources/META-INF/services/org.apache.tuscany.sca.workspace.WorkspaceFactory create mode 100644 java/sca-contrib/modules/workspace/src/main/resources/META-INF/services/org.apache.tuscany.sca.workspace.builder.ContributionBuilderExtensionPoint create mode 100644 java/sca-contrib/modules/workspace/src/main/resources/workspace-xml-validation-messages.properties create mode 100644 java/sca-contrib/modules/workspace/src/test/java/org/apache/tuscany/sca/workspace/xml/ContributionWorkspaceProcessorTestCase.java (limited to 'java/sca-contrib/modules/workspace/src') diff --git a/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/DefaultWorkspaceFactory.java b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/DefaultWorkspaceFactory.java new file mode 100644 index 0000000000..e895669d23 --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/DefaultWorkspaceFactory.java @@ -0,0 +1,32 @@ +/* + * 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.workspace; + +import org.apache.tuscany.sca.workspace.impl.WorkspaceFactoryImpl; + + +/** + * Default implementation of a contribution workspace model factory. + * + * @version $Rev$ $Date$ + */ +public class DefaultWorkspaceFactory extends WorkspaceFactoryImpl { + +} diff --git a/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/Workspace.java b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/Workspace.java new file mode 100644 index 0000000000..66f38afec7 --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/Workspace.java @@ -0,0 +1,39 @@ +/* + * 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.workspace; + +import java.util.List; + +import org.apache.tuscany.sca.contribution.Contribution; + +/** + * A workspace containing contributions. + * + * @version $Rev$ $Date$ + */ +public interface Workspace extends Contribution { + + /** + * Returns the list of contributions in the workspace. + * @return the list of contributions + */ + List getContributions(); + +} diff --git a/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/WorkspaceFactory.java b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/WorkspaceFactory.java new file mode 100644 index 0000000000..2656068bea --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/WorkspaceFactory.java @@ -0,0 +1,36 @@ +/* + * 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.workspace; + + + +/** + * A factory for the contribution workspace model. + * + * @version $Rev$ $Date$ + */ +public interface WorkspaceFactory { + + /** + * Create a new contribution workspace model object. + * @return + */ + Workspace createWorkspace(); +} \ No newline at end of file diff --git a/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/ContributionBuilder.java b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/ContributionBuilder.java new file mode 100644 index 0000000000..b7c11f769b --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/ContributionBuilder.java @@ -0,0 +1,49 @@ +/* + * 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.workspace.builder; + +import org.apache.tuscany.sca.contribution.Contribution; +import org.apache.tuscany.sca.monitor.Monitor; +import org.apache.tuscany.sca.workspace.Workspace; + +/** + * A contribution builder. + * + * @version $Rev$ $Date$ + */ +public interface ContributionBuilder { + + /** + * Returns the ID of the builder. + * + * @return + */ + String getID(); + + /** + * Build a contribution. + * + * @param contribution + * @param workspace + * @param monitor + */ + void build(Contribution contribution, Workspace workspace, Monitor monitor) throws ContributionBuilderException; + +} diff --git a/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/ContributionBuilderException.java b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/ContributionBuilderException.java new file mode 100644 index 0000000000..10c18def10 --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/ContributionBuilderException.java @@ -0,0 +1,45 @@ +/* + * 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.workspace.builder; + +/** + * Reports a contribution builder exception. + * + * @version $Rev$ $Date$ + */ +public class ContributionBuilderException extends Exception { + private static final long serialVersionUID = -1198817287971778953L; + + public ContributionBuilderException() { + } + + public ContributionBuilderException(String message) { + super(message); + } + + public ContributionBuilderException(Throwable cause) { + super(cause); + } + + public ContributionBuilderException(String message, Throwable cause) { + super(message, cause); + } + +} diff --git a/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/ContributionBuilderExtensionPoint.java b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/ContributionBuilderExtensionPoint.java new file mode 100644 index 0000000000..8200321eec --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/ContributionBuilderExtensionPoint.java @@ -0,0 +1,51 @@ +/* + * 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.workspace.builder; + +/** + * An extension point for Contribution builders. + * + * @version $Rev: $ $Date: $ + */ +public interface ContributionBuilderExtensionPoint { + + /** + * Adds a contribution builder. + * + * @param contributionBuilder + */ + void addContributionBuilder(ContributionBuilder contributionBuilder); + + /** + * Removes a contribution builder. + * + * @param contributionBuilder + */ + void removeContributionBuilder(ContributionBuilder contributionBuilder); + + /** + * Returns the contribution builder with the given id. + * + * @param id + * @return + */ + ContributionBuilder getContributionBuilder(String id); + +} diff --git a/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/DefaultContributionBuilderExtensionPoint.java b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/DefaultContributionBuilderExtensionPoint.java new file mode 100644 index 0000000000..c94601be67 --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/builder/DefaultContributionBuilderExtensionPoint.java @@ -0,0 +1,138 @@ +/* + * 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.workspace.builder; + +import java.lang.reflect.Constructor; +import java.util.Collection; +import java.util.HashMap; +import java.util.Map; + +import org.apache.tuscany.sca.contribution.Contribution; +import org.apache.tuscany.sca.core.ExtensionPointRegistry; +import org.apache.tuscany.sca.core.FactoryExtensionPoint; +import org.apache.tuscany.sca.extensibility.ServiceDeclaration; +import org.apache.tuscany.sca.extensibility.ServiceDiscovery; +import org.apache.tuscany.sca.monitor.Monitor; +import org.apache.tuscany.sca.workspace.Workspace; + +/** + * Default implementation of a provider factory extension point. + * + * @version $Rev$ $Date$ + */ +public class DefaultContributionBuilderExtensionPoint implements ContributionBuilderExtensionPoint { + + private ExtensionPointRegistry registry; + private final Map builders = new HashMap(); + private boolean loaded; + + public DefaultContributionBuilderExtensionPoint(ExtensionPointRegistry registry) { + this.registry = registry; + } + + public void addContributionBuilder(ContributionBuilder builder) { + builders.put(builder.getID(), builder); + } + + public void removeContributionBuilder(ContributionBuilder builder) { + builders.remove(builder.getID()); + } + + public ContributionBuilder getContributionBuilder(String id) { + loadBuilders(); + return builders.get(id); + } + + /** + * Load builders declared under META-INF/services. + */ + private synchronized void loadBuilders() { + if (loaded) + return; + + FactoryExtensionPoint factories = registry.getExtensionPoint(FactoryExtensionPoint.class); + + // Get the provider factory service declarations + Collection builderDeclarations; + ServiceDiscovery serviceDiscovery = ServiceDiscovery.getInstance(); + try { + builderDeclarations = serviceDiscovery.getServiceDeclarations(ContributionBuilder.class.getName()); + } catch (Exception e) { + throw new IllegalStateException(e); + } + + for (ServiceDeclaration builderDeclaration : builderDeclarations) { + Map attributes = builderDeclaration.getAttributes(); + String id = attributes.get("id"); + + ContributionBuilder builder = new LazyContributionBuilder(id, builderDeclaration, this, factories); + builders.put(id, builder); + } + } + + /** + * A wrapper around a contribution builder allowing lazy + * loading and initialization of implementation providers. + */ + private static class LazyContributionBuilder implements ContributionBuilder { + + private FactoryExtensionPoint factories; + private String id; + private ServiceDeclaration builderDeclaration; + private ContributionBuilder builder; + private ContributionBuilderExtensionPoint builders; + + private LazyContributionBuilder(String id, ServiceDeclaration factoryDeclaration, + ContributionBuilderExtensionPoint builders, FactoryExtensionPoint factories) { + this.id = id; + this.builderDeclaration = factoryDeclaration; + this.builders = builders; + this.factories = factories; + } + + public String getID() { + return id; + } + + public void build(Contribution contribution, Workspace workspace, Monitor monitor) throws ContributionBuilderException { + getBuilder().build(contribution, workspace, monitor); + } + + private ContributionBuilder getBuilder() { + if (builder == null) { + try { + Class builderClass = (Class)builderDeclaration.loadClass(); + try { + Constructor constructor = builderClass.getConstructor(FactoryExtensionPoint.class); + builder = constructor.newInstance(factories); + } catch (NoSuchMethodException e) { + Constructor constructor = builderClass.getConstructor(ContributionBuilderExtensionPoint.class, FactoryExtensionPoint.class); + builder = constructor.newInstance(builders, factories); + } + } catch (Exception e) { + throw new IllegalStateException(e); + } + } + return builder; + } + + } + +} diff --git a/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/impl/WorkspaceFactoryImpl.java b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/impl/WorkspaceFactoryImpl.java new file mode 100644 index 0000000000..e41cc3ea83 --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/impl/WorkspaceFactoryImpl.java @@ -0,0 +1,40 @@ +/* + * 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.workspace.impl; + +import org.apache.tuscany.sca.workspace.Workspace; +import org.apache.tuscany.sca.workspace.WorkspaceFactory; + + +/** + * Default implementation of a contribution workspace model factory. + * + * @version $Rev$ $Date$ + */ +public class WorkspaceFactoryImpl implements WorkspaceFactory { + + protected WorkspaceFactoryImpl() { + } + + public Workspace createWorkspace() { + return new WorkspaceImpl(); + } + +} diff --git a/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/impl/WorkspaceImpl.java b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/impl/WorkspaceImpl.java new file mode 100644 index 0000000000..7674c13627 --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/impl/WorkspaceImpl.java @@ -0,0 +1,155 @@ +/* + * 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.workspace.impl; + +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +import org.apache.tuscany.sca.assembly.Composite; +import org.apache.tuscany.sca.assembly.impl.ExtensibleImpl; +import org.apache.tuscany.sca.contribution.Artifact; +import org.apache.tuscany.sca.contribution.Contribution; +import org.apache.tuscany.sca.contribution.Export; +import org.apache.tuscany.sca.contribution.Import; +import org.apache.tuscany.sca.contribution.resolver.ModelResolver; +import org.apache.tuscany.sca.workspace.Workspace; + +/** + * WorkspaceImpl + * + * @version $Rev$ $Date$ + */ +class WorkspaceImpl extends ExtensibleImpl implements Workspace { + + private List contributions = new ArrayList(); + private String location; + private String uri; + private Object model; + private byte[] contents; + private boolean unresolved; + private ModelResolver modelResolver; + private List dependencies = new ArrayList(); + private Set types = new HashSet(); + /** + * Constructs a new workspace. + */ + WorkspaceImpl() { + types.add("application/vnd.tuscany.workspace"); + } + + public String getLocation() { + return location; + } + + public T getModel() { + return (T) model; + } + + public String getURI() { + return uri; + } + + public void setLocation(String location) { + this.location = location; + } + + public void setModel(Object model) { + this.model = model; + } + + public byte[] getContents() { + return contents; + } + + public void setContents(byte[] contents) { + this.contents = contents; + } + + public void setURI(String uri) { + this.uri = uri; + } + + public boolean isUnresolved() { + return unresolved; + } + + public void setUnresolved(boolean unresolved) { + this.unresolved = unresolved; + } + + public List getContributions() { + return contributions; + } + + public List getArtifacts() { + return (List)(Object)contributions; + } + + public List getDependencies() { + return dependencies; + } + + public ClassLoader getClassLoader() { + //FIXME Remove later + return null; + } + + public void setClassLoader(ClassLoader classLoader) { + //FIXME Remove later + } + + public List getDeployables() { + List deployables = new ArrayList(); + for (Contribution contribution: contributions) { + deployables.addAll(contribution.getDeployables()); + } + return deployables; + } + + public List getExports() { + List exports = new ArrayList(); + for (Contribution contribution: contributions) { + exports.addAll(contribution.getExports()); + } + return exports; + } + + public List getImports() { + List imports = new ArrayList(); + for (Contribution contribution: contributions) { + imports.addAll(contribution.getImports()); + } + return imports; + } + + public ModelResolver getModelResolver() { + return modelResolver; + } + + public void setModelResolver(ModelResolver modelResolver) { + this.modelResolver = modelResolver; + } + + public Set getTypes() { + return types; + } +} diff --git a/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/xml/WorkspaceDocumentProcessor.java b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/xml/WorkspaceDocumentProcessor.java new file mode 100644 index 0000000000..62e05d29fc --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/xml/WorkspaceDocumentProcessor.java @@ -0,0 +1,130 @@ +/* + * 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.workspace.xml; + +import java.io.IOException; +import java.io.InputStream; +import java.net.URI; +import java.net.URL; +import java.net.URLConnection; + +import javax.xml.stream.XMLInputFactory; +import javax.xml.stream.XMLStreamException; +import javax.xml.stream.XMLStreamReader; + +import org.apache.tuscany.sca.contribution.processor.ContributionReadException; +import org.apache.tuscany.sca.contribution.processor.ContributionResolveException; +import org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor; +import org.apache.tuscany.sca.contribution.processor.URLArtifactProcessor; +import org.apache.tuscany.sca.contribution.resolver.ModelResolver; +import org.apache.tuscany.sca.monitor.Monitor; +import org.apache.tuscany.sca.monitor.Problem; +import org.apache.tuscany.sca.monitor.Problem.Severity; +import org.apache.tuscany.sca.workspace.Workspace; + +/** + * A contribution workspace document processor. + * + * @version $Rev: 709339 $ $Date: 2008-10-31 04:01:44 +0000 (Fri, 31 Oct 2008) $ + */ +public class WorkspaceDocumentProcessor implements URLArtifactProcessor { + private XMLInputFactory inputFactory; + private StAXArtifactProcessor staxProcessor; + private Monitor monitor; + + /** + * Constructs a new componentType processor. + * @param factory + * @param policyFactory + * @param registry + */ + public WorkspaceDocumentProcessor(StAXArtifactProcessor staxProcessor, + XMLInputFactory inputFactory, + Monitor monitor) { + this.staxProcessor = staxProcessor; + this.inputFactory = inputFactory; + this.monitor = monitor; + } + + /** + * Report a exception. + * + * @param problems + * @param message + * @param model + */ + private void error(String message, Object model, Exception ex) { + if (monitor != null) { + Problem problem = monitor.createProblem(this.getClass().getName(), "workspace-xml-validation-messages", Severity.ERROR, model, message, ex); + monitor.problem(problem); + } + } + + public Workspace read(URL contributionURL, URI uri, URL url) throws ContributionReadException { + InputStream urlStream = null; + try { + + // Create a stream reader + URLConnection connection = url.openConnection(); + connection.setUseCaches(false); + urlStream = connection.getInputStream(); + XMLStreamReader reader = inputFactory.createXMLStreamReader(url.toString(), urlStream); + reader.nextTag(); + + // Read the workspace model + Workspace workspace = (Workspace)staxProcessor.read(reader); + if (workspace != null) { + workspace.setURI(uri.toString()); + } + + return workspace; + + } catch (XMLStreamException e) { + ContributionReadException ce = new ContributionReadException(e); + error("ContributionReadException", inputFactory, ce); + throw ce; + } catch (IOException e) { + ContributionReadException ce = new ContributionReadException(e); + error("ContributionReadException", staxProcessor, ce); + throw ce; + } finally { + try { + if (urlStream != null) { + urlStream.close(); + urlStream = null; + } + } catch (IOException ioe) { + //ignore + } + } + } + + public void resolve(Workspace workspace, ModelResolver resolver) throws ContributionResolveException { + staxProcessor.resolve(workspace, resolver); + } + + public String getArtifactType() { + return ".workspace"; + } + + public Class getModelType() { + return Workspace.class; + } +} diff --git a/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/xml/WorkspaceProcessor.java b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/xml/WorkspaceProcessor.java new file mode 100644 index 0000000000..33ac7aa342 --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/java/org/apache/tuscany/sca/workspace/xml/WorkspaceProcessor.java @@ -0,0 +1,167 @@ +/* + * 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.workspace.xml; + +import static javax.xml.stream.XMLStreamConstants.END_ELEMENT; +import static javax.xml.stream.XMLStreamConstants.START_ELEMENT; + +import java.util.List; + +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.contribution.Contribution; +import org.apache.tuscany.sca.contribution.ContributionFactory; +import org.apache.tuscany.sca.contribution.processor.BaseStAXArtifactProcessor; +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.StAXArtifactProcessor; +import org.apache.tuscany.sca.contribution.resolver.ModelResolver; +import org.apache.tuscany.sca.core.FactoryExtensionPoint; +import org.apache.tuscany.sca.monitor.Monitor; +import org.apache.tuscany.sca.workspace.Workspace; +import org.apache.tuscany.sca.workspace.WorkspaceFactory; + +/** + * A contribution workspace processor. + * + * @version $Rev: 750323 $ $Date: 2009-03-05 05:52:01 +0000 (Thu, 05 Mar 2009) $ + */ +public class WorkspaceProcessor extends BaseStAXArtifactProcessor implements StAXArtifactProcessor { + + private static final String SCA10_TUSCANY_NS = "http://tuscany.apache.org/xmlns/sca/1.1"; + private static final QName WORKSPACE_QNAME = new QName(SCA10_TUSCANY_NS, "workspace"); + private static final QName CONTRIBUTION_QNAME = new QName(SCA10_TUSCANY_NS, "contribution"); + private static final String URI = "uri"; + private static final String LOCATION = "location"; + + private WorkspaceFactory workspaceFactory; + private ContributionFactory contributionFactory; + + /** + * Constructs a new contribution workspace processor. + * + * @param contributionFactory + * @param extensionProcessor + */ + public WorkspaceProcessor(WorkspaceFactory workspaceFactory, ContributionFactory contributionFactory, StAXArtifactProcessor extensionProcessor) { + this.workspaceFactory = workspaceFactory; + this.contributionFactory = contributionFactory; + } + + /** + * Constructs a new contribution workspace processor. + * + * @param modelFactories + * @param extensionProcessor + */ + public WorkspaceProcessor(FactoryExtensionPoint modelFactories, StAXArtifactProcessor extensionProcessor, Monitor monitor) { + this.workspaceFactory = modelFactories.getFactory(WorkspaceFactory.class); + this.contributionFactory = modelFactories.getFactory(ContributionFactory.class); + } + + public Workspace read(XMLStreamReader reader) throws ContributionReadException, XMLStreamException { + + Workspace workspace = null; + Contribution contribution = null; + + // Read the workspace document + while (reader.hasNext()) { + int event = reader.getEventType(); + switch (event) { + case START_ELEMENT: + QName name = reader.getName(); + + if (WORKSPACE_QNAME.equals(name)) { + + // Read a + workspace = workspaceFactory.createWorkspace(); + workspace.setUnresolved(true); + + } else if (CONTRIBUTION_QNAME.equals(name)) { + + // Read a + contribution = contributionFactory.createContribution(); + contribution.setURI(getString(reader, URI)); + contribution.setLocation(getString(reader, LOCATION)); + contribution.setUnresolved(true); + workspace.getContributions().add(contribution); + } + break; + + case END_ELEMENT: + name = reader.getName(); + + // Clear current state when reading reaching end element + if (CONTRIBUTION_QNAME.equals(name)) { + contribution = null; + } + break; + } + + // Read the next element + if (reader.hasNext()) { + reader.next(); + } + } + return workspace; + } + + public void write(Workspace workspace, XMLStreamWriter writer) throws ContributionWriteException, XMLStreamException { + + // Write element + writeStartDocument(writer, WORKSPACE_QNAME); + + // Write elements + for (Contribution contribution: workspace.getContributions()) { + writeStart(writer, CONTRIBUTION_QNAME, + new XAttr(URI, contribution.getURI()), new XAttr(LOCATION, contribution.getLocation())); + writeEnd(writer); + } + + writeEndDocument(writer); + } + + public void resolve(Workspace workspace, ModelResolver resolver) throws ContributionResolveException { + + // Resolve the contributions referenced by the workspace + List contributions = workspace.getContributions(); + for (int i = 0, n = contributions.size(); i < n; i++) { + Contribution contribution = contributions.get(i); + Contribution resolved = resolver.resolveModel(Contribution.class, contribution); + if (resolved != contribution) { + contributions.set(i, resolved); + } + } + + workspace.setUnresolved(false); + } + + public QName getArtifactType() { + return WORKSPACE_QNAME; + } + + public Class getModelType() { + return Workspace.class; + } +} diff --git a/java/sca-contrib/modules/workspace/src/main/resources/META-INF/services/org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor b/java/sca-contrib/modules/workspace/src/main/resources/META-INF/services/org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor new file mode 100644 index 0000000000..86a302a103 --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/resources/META-INF/services/org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor @@ -0,0 +1,19 @@ +# 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. + +# Implementation class for the artifact processor extension +org.apache.tuscany.sca.workspace.xml.WorkspaceProcessor;qname=http://tuscany.apache.org/xmlns/sca/1.1#workspace,model=org.apache.tuscany.sca.workspace.Workspace diff --git a/java/sca-contrib/modules/workspace/src/main/resources/META-INF/services/org.apache.tuscany.sca.workspace.WorkspaceFactory b/java/sca-contrib/modules/workspace/src/main/resources/META-INF/services/org.apache.tuscany.sca.workspace.WorkspaceFactory new file mode 100644 index 0000000000..d390d29d90 --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/resources/META-INF/services/org.apache.tuscany.sca.workspace.WorkspaceFactory @@ -0,0 +1,18 @@ +# 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. + +org.apache.tuscany.sca.workspace.DefaultWorkspaceFactory \ No newline at end of file diff --git a/java/sca-contrib/modules/workspace/src/main/resources/META-INF/services/org.apache.tuscany.sca.workspace.builder.ContributionBuilderExtensionPoint b/java/sca-contrib/modules/workspace/src/main/resources/META-INF/services/org.apache.tuscany.sca.workspace.builder.ContributionBuilderExtensionPoint new file mode 100644 index 0000000000..98ad0b72b0 --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/resources/META-INF/services/org.apache.tuscany.sca.workspace.builder.ContributionBuilderExtensionPoint @@ -0,0 +1,18 @@ +# 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. + +org.apache.tuscany.sca.workspace.builder.DefaultContributionBuilderExtensionPoint \ No newline at end of file diff --git a/java/sca-contrib/modules/workspace/src/main/resources/workspace-xml-validation-messages.properties b/java/sca-contrib/modules/workspace/src/main/resources/workspace-xml-validation-messages.properties new file mode 100644 index 0000000000..f83db411bf --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/main/resources/workspace-xml-validation-messages.properties @@ -0,0 +1,22 @@ +# +# +# 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. +# +# +ContributionReadException = ContributionReadException occured due to : +ContributionResolveException = ContributionResolveException occured due to : \ No newline at end of file diff --git a/java/sca-contrib/modules/workspace/src/test/java/org/apache/tuscany/sca/workspace/xml/ContributionWorkspaceProcessorTestCase.java b/java/sca-contrib/modules/workspace/src/test/java/org/apache/tuscany/sca/workspace/xml/ContributionWorkspaceProcessorTestCase.java new file mode 100644 index 0000000000..19924da859 --- /dev/null +++ b/java/sca-contrib/modules/workspace/src/test/java/org/apache/tuscany/sca/workspace/xml/ContributionWorkspaceProcessorTestCase.java @@ -0,0 +1,95 @@ +/* + * 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.workspace.xml; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; +import static org.junit.Assert.fail; + +import java.io.StringReader; + +import javax.xml.stream.XMLInputFactory; +import javax.xml.stream.XMLStreamException; +import javax.xml.stream.XMLStreamReader; + +import org.apache.tuscany.sca.contribution.processor.DefaultStAXArtifactProcessorExtensionPoint; +import org.apache.tuscany.sca.contribution.processor.ExtensibleStAXArtifactProcessor; +import org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor; +import org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessorExtensionPoint; +import org.apache.tuscany.sca.core.DefaultExtensionPointRegistry; +import org.apache.tuscany.sca.workspace.Workspace; +import org.junit.BeforeClass; +import org.junit.Test; + +/** + * Test the workspace processor. + * + * @version $Rev: 750323 $ $Date: 2009-03-05 05:52:01 +0000 (Thu, 05 Mar 2009) $ + */ + +public class ContributionWorkspaceProcessorTestCase { + + private static final String VALID_XML = + "" + "" + + "" + + "" + + ""; + + private static final String INVALID_XML = + "" + "" + + "" + + "" + + "" + + ""; + + private static XMLInputFactory inputFactory; + private static StAXArtifactProcessor staxProcessor; + + @BeforeClass + public static void setUp() throws Exception { + DefaultExtensionPointRegistry extensionPoints = new DefaultExtensionPointRegistry(); + inputFactory = XMLInputFactory.newInstance(); + StAXArtifactProcessorExtensionPoint staxProcessors = + new DefaultStAXArtifactProcessorExtensionPoint(extensionPoints); + staxProcessor = new ExtensibleStAXArtifactProcessor(staxProcessors, inputFactory, null, null); + } + + @Test + public void testRead() throws Exception { + XMLStreamReader reader = inputFactory.createXMLStreamReader(new StringReader(VALID_XML)); + Workspace workspace = (Workspace)staxProcessor.read(reader); + assertNotNull(workspace); + assertEquals(2, workspace.getContributions().size()); + assertEquals("uri2", workspace.getContributions().get(1).getURI()); + assertEquals("location2", workspace.getContributions().get(1).getLocation()); + } + + @Test + public void testReadInvalid() throws Exception { + XMLStreamReader reader = inputFactory.createXMLStreamReader(new StringReader(INVALID_XML)); + try { + staxProcessor.read(reader); + fail("InvalidException should have been thrown"); + } catch (XMLStreamException e) { + assertTrue(true); + } + } +} -- cgit v1.2.3