diff options
Diffstat (limited to '')
8 files changed, 594 insertions, 0 deletions
diff --git a/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/Widget.java b/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/Widget.java new file mode 100644 index 0000000000..f47850a05c --- /dev/null +++ b/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/Widget.java @@ -0,0 +1,34 @@ +/* + * 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.implementation.widget; + +import java.io.InputStream; + +import org.apache.tuscany.sca.data.collection.Collection; + +/** + * The service interface of widget implementations. This is not an API for application + * developers. Application developers should use the data collection API to invoke + * widget components. + * + * @version $Rev$ $Date$ + */ +public interface Widget extends Collection<String, InputStream> { +} diff --git a/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/WidgetImplementation.java b/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/WidgetImplementation.java new file mode 100644 index 0000000000..b35cc41dd4 --- /dev/null +++ b/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/WidgetImplementation.java @@ -0,0 +1,134 @@ +/* + * 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.implementation.widget; + +import java.net.URL; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +import org.apache.tuscany.sca.assembly.AssemblyFactory; +import org.apache.tuscany.sca.assembly.ConstrainingType; +import org.apache.tuscany.sca.assembly.Implementation; +import org.apache.tuscany.sca.assembly.Property; +import org.apache.tuscany.sca.assembly.Reference; +import org.apache.tuscany.sca.assembly.Service; +import org.apache.tuscany.sca.interfacedef.InvalidInterfaceException; +import org.apache.tuscany.sca.interfacedef.java.JavaInterface; +import org.apache.tuscany.sca.interfacedef.java.JavaInterfaceContract; +import org.apache.tuscany.sca.interfacedef.java.JavaInterfaceFactory; + + +/** + * The model representing a widget implementation in an SCA assembly model. + * + * @version $Rev$ $Date$ + */ +public class WidgetImplementation implements Implementation { + private Service widgetService; + private List<Reference> references = new ArrayList<Reference>(); + private List<Property> properties = new ArrayList<Property>(); + + private String location; + private URL url; + private boolean unresolved; + + /** + * Constructs a new resource implementation. + */ + WidgetImplementation(AssemblyFactory assemblyFactory, + JavaInterfaceFactory javaFactory) { + + // Resource implementation always provide a single service exposing + // the Resource interface, and have no references and properties + widgetService = assemblyFactory.createService(); + widgetService.setName("Widget"); + + // Create the Java interface contract for the Resource service + JavaInterface javaInterface; + try { + javaInterface = javaFactory.createJavaInterface(Widget.class); + } catch (InvalidInterfaceException e) { + throw new IllegalArgumentException(e); + } + JavaInterfaceContract interfaceContract = javaFactory.createJavaInterfaceContract(); + interfaceContract.setInterface(javaInterface); + widgetService.setInterfaceContract(interfaceContract); + } + + public String getLocation() { + return location; + } + + public void setLocation(String location) { + this.location = location; + } + + public URL getLocationURL() { + return url; + } + + public void setLocationURL(URL url) { + this.url = url; + } + + public ConstrainingType getConstrainingType() { + // The resource implementation does not support constrainingTypes + return null; + } + + public List<Property> getProperties() { + return properties; + } + + public List<Service> getServices() { + // The resource implementation does not support services + return Collections.singletonList(widgetService); + } + + public List<Reference> getReferences() { + return references; + } + + public String getURI() { + return location; + } + + public void setConstrainingType(ConstrainingType constrainingType) { + // The resource implementation does not support constrainingTypes + } + + public void setURI(String uri) { + this.location = uri; + } + + + public boolean isUnresolved() { + return unresolved; + } + + public void setUnresolved(boolean unresolved) { + this.unresolved = unresolved; + } + + @Override + public String toString() { + return "Widget : " + getLocation(); + } +} diff --git a/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/WidgetImplementationFactory.java b/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/WidgetImplementationFactory.java new file mode 100644 index 0000000000..dc5759a13d --- /dev/null +++ b/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/WidgetImplementationFactory.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.implementation.widget; + +import org.apache.tuscany.sca.assembly.AssemblyFactory; +import org.apache.tuscany.sca.core.FactoryExtensionPoint; +import org.apache.tuscany.sca.interfacedef.java.JavaInterfaceFactory; + +/** + * Factory for the widget implementation model. + * + * @version $Rev$ $Date$ + */ +public class WidgetImplementationFactory { + + private AssemblyFactory assemblyFactory; + private JavaInterfaceFactory javaFactory; + + public WidgetImplementationFactory(FactoryExtensionPoint modelFactories) { + assemblyFactory = modelFactories.getFactory(AssemblyFactory.class); + javaFactory = modelFactories.getFactory(JavaInterfaceFactory.class); + } + + public WidgetImplementation createWidgetImplementation() { + return new WidgetImplementation(assemblyFactory, javaFactory); + } + +} diff --git a/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/WidgetImplementationIntrospector.java b/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/WidgetImplementationIntrospector.java new file mode 100644 index 0000000000..abe00bac5b --- /dev/null +++ b/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/WidgetImplementationIntrospector.java @@ -0,0 +1,145 @@ +/* + * 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.implementation.widget; + +import java.net.URL; +import java.net.URLConnection; +import java.util.Scanner; + +import org.apache.tuscany.sca.assembly.AssemblyFactory; +import org.apache.tuscany.sca.assembly.Property; +import org.apache.tuscany.sca.assembly.Reference; + +/** + * + * @version $Rev$ $Date$ + */ +class WidgetImplementationIntrospector { + private static final String WEB_REFERENCE_ANNOTATION = "//@Reference"; + private static final String WEB_PROPERTY_ANNOTATION = "//@Property"; + + private AssemblyFactory assemblyFactory; + private WidgetImplementation widgetImplementation; + + WidgetImplementationIntrospector(AssemblyFactory assemblyFactory, WidgetImplementation widgetImplementation) { + this.widgetImplementation = widgetImplementation; + this.assemblyFactory = assemblyFactory; + } + + + /** + * Introspect and populate a given widget implementation + */ + public void introspectImplementation() { + URL htmlWidget = widgetImplementation.getLocationURL(); + + try { + URLConnection connection = htmlWidget.openConnection(); + connection.setUseCaches(false); + Scanner scanner = new Scanner(connection.getInputStream()); + while(scanner.hasNextLine()) { + String line = scanner.nextLine(); + if(line.contains(WEB_PROPERTY_ANNOTATION)) { + //process the next line, as it has the property info + if (scanner.hasNextLine()) { + Property property = processPropertyScript(scanner.nextLine()); + if (property != null) { + widgetImplementation.getProperties().add(property); + } + } + + } else if(line.contains(WEB_REFERENCE_ANNOTATION)) { + //process the next line, as it has the reference info + if (scanner.hasNextLine()) { + Reference reference = processReferenceScript(scanner.nextLine()); + if(reference != null){ + widgetImplementation.getReferences().add(reference); + } + + } + } + } + + } catch(Exception e) { + + } + + + } + + + /** + * Process Property declaration in JavaScript code + * Supported ways: + * //@Property + * var locale = Property("locale"); + * + * //@Property + * locale = Property("locale"); + * + * @param scriptContent + * @return + */ + private Property processPropertyScript(String scriptContent) { + Property property = null; + String propertyName = null; + + String tokens[] = scriptContent.split("="); + tokens = tokens[0].split(" "); + propertyName = tokens[tokens.length -1]; + + if(propertyName != null) { + property = assemblyFactory.createProperty(); + property.setName(propertyName); + } + + return property; + } + + /** + * Process Reference declaration in JavaScript code + * Supported ways : + * //@Reference + * var catalog = new Reference("catalog"); + * + * //@Reference + * catalog = new Reference("catalog"); + * + * @param scriptContent + * @return + */ + private Reference processReferenceScript(String scriptContent) { + Reference reference = null; + String referenceName = null; + + String tokens[] = scriptContent.split("="); + + // find the string between the quotes + tokens = tokens[1].split("\""); + referenceName = tokens[1]; + + if(referenceName != null) { + reference = assemblyFactory.createReference(); + reference.setName(referenceName); + } + + return reference; + } +} diff --git a/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/WidgetImplementationProcessor.java b/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/WidgetImplementationProcessor.java new file mode 100644 index 0000000000..1d3e71dfcb --- /dev/null +++ b/java/sca/modules/implementation-widget/src/main/java/org/apache/tuscany/sca/implementation/widget/WidgetImplementationProcessor.java @@ -0,0 +1,175 @@ +/* + * 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.implementation.widget; + +import static javax.xml.stream.XMLStreamConstants.END_ELEMENT; + +import java.io.IOException; +import java.net.URL; + +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.AssemblyFactory; +import org.apache.tuscany.sca.assembly.xml.Constants; +import org.apache.tuscany.sca.contribution.Artifact; +import org.apache.tuscany.sca.contribution.ContributionFactory; +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.monitor.Problem; +import org.apache.tuscany.sca.monitor.Problem.Severity; + + +/** + * Implements a StAX artifact processor for Widget implementations. + * + * @version $Rev$ $Date$ + */ +public class WidgetImplementationProcessor implements StAXArtifactProcessor<WidgetImplementation> { + private static final QName IMPLEMENTATION_WIDGET = new QName(Constants.SCA10_TUSCANY_NS, "implementation.widget"); + + private AssemblyFactory assemblyFactory; + private ContributionFactory contributionFactory; + private WidgetImplementationFactory implementationFactory; + private Monitor monitor; + + public WidgetImplementationProcessor(FactoryExtensionPoint modelFactories, Monitor monitor) { + assemblyFactory = modelFactories.getFactory(AssemblyFactory.class); + contributionFactory = modelFactories.getFactory(ContributionFactory.class); + implementationFactory = new WidgetImplementationFactory(modelFactories); + 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(), "impl-widget-validation-messages", Severity.ERROR, model, message, ex); + monitor.problem(problem); + } + } + + /** + * Report a error. + * + * @param problems + * @param message + * @param model + */ + private void error(String message, Object model, Object... messageParameters) { + if (monitor != null) { + Problem problem = monitor.createProblem(this.getClass().getName(), "impl-widget-validation-messages", Severity.ERROR, model, message, (Object[])messageParameters); + monitor.problem(problem); + } + } + + public QName getArtifactType() { + // Returns the QName of the XML element processed by this processor + return IMPLEMENTATION_WIDGET; + } + + public Class<WidgetImplementation> getModelType() { + // Returns the type of model processed by this processor + return WidgetImplementation.class; + } + + public WidgetImplementation read(XMLStreamReader reader) throws ContributionReadException, XMLStreamException { + + // Read an <implementation.widget> element + + // Create and initialize the resource implementation model + WidgetImplementation implementation = null; + + // Read the location attribute specifying the location of the resources + String location = reader.getAttributeValue(null, "location"); + if (location != null) { + implementation = implementationFactory.createWidgetImplementation(); + implementation.setLocation(location); + implementation.setUnresolved(true); + } else { + error("LocationAttributeMissing", reader); + //throw new ContributionReadException(MSG_LOCATION_MISSING); + } + + // Skip to end element + while (reader.hasNext()) { + if (reader.next() == END_ELEMENT && IMPLEMENTATION_WIDGET.equals(reader.getName())) { + break; + } + } + + return implementation; + } + + public void resolve(WidgetImplementation implementation, ModelResolver resolver) throws ContributionResolveException { + + if (implementation != null) { + // Resolve the resource directory location + Artifact artifact = contributionFactory.createArtifact(); + artifact.setURI(implementation.getLocation()); + Artifact resolved = resolver.resolveModel(Artifact.class, artifact); + if (resolved.getLocation() != null) { + try { + implementation.setLocationURL(new URL(resolved.getLocation())); + + //introspect implementation + WidgetImplementationIntrospector widgetIntrospector = + new WidgetImplementationIntrospector(assemblyFactory, implementation); + widgetIntrospector.introspectImplementation(); + + implementation.setUnresolved(false); + } catch (IOException e) { + ContributionResolveException ce = new ContributionResolveException(e); + error("ContributionResolveException", resolver, ce); + //throw ce; + } + } else { + error("CouldNotResolveLocation", resolver, implementation.getLocation()); + //throw new ContributionResolveException("Could not resolve implementation.widget location: " + implementation.getLocation()); + } + } + } + + public void write(WidgetImplementation implementation, XMLStreamWriter writer) throws ContributionWriteException, XMLStreamException { + + // Write <implementation.widget> + writer.setPrefix("widget",IMPLEMENTATION_WIDGET.getNamespaceURI()); + writer.writeStartElement(IMPLEMENTATION_WIDGET.getNamespaceURI(), IMPLEMENTATION_WIDGET.getLocalPart()); + writer.writeNamespace("widget",IMPLEMENTATION_WIDGET.getNamespaceURI()); + + + if (implementation.getLocation() != null) { + writer.writeAttribute("location", implementation.getLocation()); + } + + writer.writeEndElement(); + } +} diff --git a/java/sca/modules/implementation-widget/src/main/resources/META-INF/services/org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor b/java/sca/modules/implementation-widget/src/main/resources/META-INF/services/org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor new file mode 100644 index 0000000000..6c167a6b31 --- /dev/null +++ b/java/sca/modules/implementation-widget/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.implementation.widget.WidgetImplementationProcessor;qname=http://tuscany.apache.org/xmlns/sca/1.0#implementation.widget,model=org.apache.tuscany.sca.implementation.widget.WidgetImplementation diff --git a/java/sca/modules/implementation-widget/src/main/resources/META-INF/services/org.apache.tuscany.sca.implementation.widget.WidgetImplementationFactory b/java/sca/modules/implementation-widget/src/main/resources/META-INF/services/org.apache.tuscany.sca.implementation.widget.WidgetImplementationFactory new file mode 100644 index 0000000000..fc45baa16d --- /dev/null +++ b/java/sca/modules/implementation-widget/src/main/resources/META-INF/services/org.apache.tuscany.sca.implementation.widget.WidgetImplementationFactory @@ -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 model factory +org.apache.tuscany.sca.implementation.widget.WidgetImplementationFactory diff --git a/java/sca/modules/implementation-widget/src/main/resources/impl-widget-validation-messages.properties b/java/sca/modules/implementation-widget/src/main/resources/impl-widget-validation-messages.properties new file mode 100644 index 0000000000..3778bd4c50 --- /dev/null +++ b/java/sca/modules/implementation-widget/src/main/resources/impl-widget-validation-messages.properties @@ -0,0 +1,23 @@ +# +# +# 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. +# +# +ContributionResolveException = ContributionResolveException occured due to: +LocationAttributeMissing = Reading implementation.widget - location attribute missing +CouldNotResolveLocation = Could not resolve implementation.widget location: {0} |