Author: lresende
Date: Fri May 7 23:48:28 2010
New Revision: 942274
URL: http://svn.apache.org/viewvc?rev=942274&view=rev
Log:
Adding support for declarative http headers in binding.rest
Added:
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/test/java/org/apache/tuscany/sca/binding/rest/xml/
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/test/java/org/apache/tuscany/sca/binding/rest/xml/RESTBindingProcessorTestCase.java
(with props)
Modified:
tuscany/sca-java-2.x/trunk/modules/binding-rest-runtime/src/main/java/org/apache/tuscany/sca/binding/rest/provider/RESTBindingListenerServlet.java
tuscany/sca-java-2.x/trunk/modules/binding-rest-runtime/src/test/resources/customer.composite
tuscany/sca-java-2.x/trunk/modules/binding-rest/META-INF/MANIFEST.MF
tuscany/sca-java-2.x/trunk/modules/binding-rest/pom.xml
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/RESTBinding.java
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/impl/RESTBindingImpl.java
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/xml/RESTBindingProcessor.java
Modified:
tuscany/sca-java-2.x/trunk/modules/binding-rest-runtime/src/main/java/org/apache/tuscany/sca/binding/rest/provider/RESTBindingListenerServlet.java
URL:
http://svn.apache.org/viewvc/tuscany/sca-java-2.x/trunk/modules/binding-rest-runtime/src/main/java/org/apache/tuscany/sca/binding/rest/provider/RESTBindingListenerServlet.java?rev=942274&r1=942273&r2=942274&view=diff
==============================================================================
---
tuscany/sca-java-2.x/trunk/modules/binding-rest-runtime/src/main/java/org/apache/tuscany/sca/binding/rest/provider/RESTBindingListenerServlet.java
(original)
+++
tuscany/sca-java-2.x/trunk/modules/binding-rest-runtime/src/main/java/org/apache/tuscany/sca/binding/rest/provider/RESTBindingListenerServlet.java
Fri May 7 23:48:28 2010
@@ -24,6 +24,9 @@ import java.io.InputStream;
import java.io.OutputStream;
import java.net.URLDecoder;
import java.text.ParseException;
+import java.util.Calendar;
+import java.util.Date;
+import java.util.GregorianCalendar;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
@@ -31,9 +34,11 @@ import javax.servlet.http.HttpServletReq
import javax.servlet.http.HttpServletResponse;
import org.apache.tuscany.sca.assembly.Binding;
+import org.apache.tuscany.sca.binding.rest.RESTBinding;
import org.apache.tuscany.sca.common.http.HTTPCacheContext;
import org.apache.tuscany.sca.common.http.HTTPContentTypeMapper;
import org.apache.tuscany.sca.common.http.HTTPContext;
+import org.apache.tuscany.sca.common.http.HTTPHeader;
import org.apache.tuscany.sca.invocation.Invoker;
import org.apache.tuscany.sca.invocation.Message;
import org.apache.tuscany.sca.invocation.MessageFactory;
@@ -49,7 +54,7 @@ public class RESTBindingListenerServlet
transient private MessageFactory messageFactory;
- transient private Binding binding;
+ transient private RESTBinding binding;
transient private Invoker bindingInvoker;
private Invoker invoker;
@@ -66,7 +71,7 @@ public class RESTBindingListenerServlet
* Constructs a new RESTServiceListenerServlet.
*/
public RESTBindingListenerServlet(Binding binding, Invoker bindingInvoker,
MessageFactory messageFactory) {
- this.binding = binding;
+ this.binding = (RESTBinding) binding;
this.bindingInvoker = bindingInvoker;
this.messageFactory = messageFactory;
}
@@ -137,10 +142,26 @@ public class RESTBindingListenerServlet
// return response to client
if (responseMessage.isFault()) {
// Turn a fault into an exception
- //throw new
ServletException((Throwable)responseMessage.getBody());
Throwable e = (Throwable)responseMessage.getBody();
response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.toString());
} else {
+
+ for(HTTPHeader header : binding.getHttpHeaders()) {
+ //treat special headers that need to be calculated
+ if(header.getName().equalsIgnoreCase("Expires")) {
+ GregorianCalendar calendar = new GregorianCalendar();
+ calendar.setTime(new Date());
+
+ calendar.add(Calendar.HOUR,
Integer.parseInt(header.getValue()));
+
+ response.setHeader("Expires",
HTTPCacheContext.RFC822DateFormat.format( calendar.getTime() ));
+ } else {
+ //default behaviour to pass the header value to HTTP
response
+ response.setHeader(header.getName(),
header.getValue());
+ }
+
+ }
+
//handle void operations
write(response.getOutputStream(), responseMessage.getBody());
response.getOutputStream().flush();
Modified:
tuscany/sca-java-2.x/trunk/modules/binding-rest-runtime/src/test/resources/customer.composite
URL:
http://svn.apache.org/viewvc/tuscany/sca-java-2.x/trunk/modules/binding-rest-runtime/src/test/resources/customer.composite?rev=942274&r1=942273&r2=942274&view=diff
==============================================================================
---
tuscany/sca-java-2.x/trunk/modules/binding-rest-runtime/src/test/resources/customer.composite
(original)
+++
tuscany/sca-java-2.x/trunk/modules/binding-rest-runtime/src/test/resources/customer.composite
Fri May 7 23:48:28 2010
@@ -28,6 +28,10 @@
<tuscany:binding.rest
uri="http://localhost:8085/Customer";>
<tuscany:wireFormat.xml />
<tuscany:operationSelector.jaxrs />
+ <tuscany:http-headers>
+ <tuscany:header name="Cache-Control"
value="no-cache"/>
+ <tuscany:header name="Expires" value="-1"/>
+ </tuscany:http-headers>
</tuscany:binding.rest>
</service>
</component>
Modified: tuscany/sca-java-2.x/trunk/modules/binding-rest/META-INF/MANIFEST.MF
URL:
http://svn.apache.org/viewvc/tuscany/sca-java-2.x/trunk/modules/binding-rest/META-INF/MANIFEST.MF?rev=942274&r1=942273&r2=942274&view=diff
==============================================================================
--- tuscany/sca-java-2.x/trunk/modules/binding-rest/META-INF/MANIFEST.MF
(original)
+++ tuscany/sca-java-2.x/trunk/modules/binding-rest/META-INF/MANIFEST.MF Fri
May 7 23:48:28 2010
@@ -15,6 +15,7 @@ Import-Package: javax.servlet.http,
javax.xml.stream,
org.apache.tuscany.sca.assembly;version="2.0.0",
org.apache.tuscany.sca.binding.rest;version="2.0.0",
+ org.apache.tuscany.sca.common.http;version="2.0.0",
org.apache.tuscany.sca.contribution.processor;version="2.0.0",
org.apache.tuscany.sca.contribution.resolver;version="2.0.0",
org.apache.tuscany.sca.core;version="2.0.0",
Modified: tuscany/sca-java-2.x/trunk/modules/binding-rest/pom.xml
URL:
http://svn.apache.org/viewvc/tuscany/sca-java-2.x/trunk/modules/binding-rest/pom.xml?rev=942274&r1=942273&r2=942274&view=diff
==============================================================================
--- tuscany/sca-java-2.x/trunk/modules/binding-rest/pom.xml (original)
+++ tuscany/sca-java-2.x/trunk/modules/binding-rest/pom.xml Fri May 7 23:48:28
2010
@@ -37,6 +37,12 @@
</dependency>
<dependency>
+ <groupId>org.apache.tuscany.sca</groupId>
+ <artifactId>tuscany-common-http</artifactId>
+ <version>2.0-SNAPSHOT</version>
+ </dependency>
+
+ <dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
Modified:
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/RESTBinding.java
URL:
http://svn.apache.org/viewvc/tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/RESTBinding.java?rev=942274&r1=942273&r2=942274&view=diff
==============================================================================
---
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/RESTBinding.java
(original)
+++
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/RESTBinding.java
Fri May 7 23:48:28 2010
@@ -19,9 +19,12 @@
package org.apache.tuscany.sca.binding.rest;
+import java.util.List;
+
import javax.xml.namespace.QName;
import org.apache.tuscany.sca.assembly.Binding;
+import org.apache.tuscany.sca.common.http.HTTPHeader;
/**
* REST binding model.
@@ -30,4 +33,6 @@ import org.apache.tuscany.sca.assembly.B
*/
public interface RESTBinding extends Binding {
QName TYPE = new QName(SCA11_TUSCANY_NS, "binding.rest");
+
+ public List<HTTPHeader> getHttpHeaders();
}
Modified:
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/impl/RESTBindingImpl.java
URL:
http://svn.apache.org/viewvc/tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/impl/RESTBindingImpl.java?rev=942274&r1=942273&r2=942274&view=diff
==============================================================================
---
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/impl/RESTBindingImpl.java
(original)
+++
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/impl/RESTBindingImpl.java
Fri May 7 23:48:28 2010
@@ -19,11 +19,15 @@
package org.apache.tuscany.sca.binding.rest.impl;
+import java.util.ArrayList;
+import java.util.List;
+
import javax.xml.namespace.QName;
import org.apache.tuscany.sca.assembly.OperationSelector;
import org.apache.tuscany.sca.assembly.WireFormat;
import org.apache.tuscany.sca.binding.rest.RESTBinding;
+import org.apache.tuscany.sca.common.http.HTTPHeader;
/**
@@ -35,6 +39,8 @@ class RESTBindingImpl implements RESTBin
private String name;
private String uri;
+
+ private List<HTTPHeader> httpHeaders = new ArrayList<HTTPHeader>();
private WireFormat wireFormat;
private OperationSelector operationSelector;
@@ -47,18 +53,22 @@ class RESTBindingImpl implements RESTBin
return name;
}
- public String getURI() {
- return uri;
- }
-
public void setName(String name) {
this.name = name;
}
+ public String getURI() {
+ return uri;
+ }
+
public void setURI(String uri) {
this.uri = uri;
}
+ public List<HTTPHeader> getHttpHeaders() {
+ return this.httpHeaders;
+ }
+
public boolean isUnresolved() {
return false;
}
Modified:
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/xml/RESTBindingProcessor.java
URL:
http://svn.apache.org/viewvc/tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/xml/RESTBindingProcessor.java?rev=942274&r1=942273&r2=942274&view=diff
==============================================================================
---
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/xml/RESTBindingProcessor.java
(original)
+++
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/main/java/org/apache/tuscany/sca/binding/rest/xml/RESTBindingProcessor.java
Fri May 7 23:48:28 2010
@@ -27,10 +27,12 @@ import javax.xml.stream.XMLStreamExcepti
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
+import org.apache.tuscany.sca.assembly.Base;
import org.apache.tuscany.sca.assembly.OperationSelector;
import org.apache.tuscany.sca.assembly.WireFormat;
import org.apache.tuscany.sca.binding.rest.RESTBinding;
import org.apache.tuscany.sca.binding.rest.RESTBindingFactory;
+import org.apache.tuscany.sca.common.http.HTTPHeader;
import org.apache.tuscany.sca.contribution.processor.BaseStAXArtifactProcessor;
import org.apache.tuscany.sca.contribution.processor.ContributionReadException;
import
org.apache.tuscany.sca.contribution.processor.ContributionResolveException;
@@ -48,7 +50,11 @@ import org.apache.tuscany.sca.core.Facto
* @version $Rev$ $Date$
*/
public class RESTBindingProcessor extends BaseStAXArtifactProcessor implements
StAXArtifactProcessor<RESTBinding> {
+ private static final QName HEADERS_QNAME = new
QName(Base.SCA11_TUSCANY_NS, "http-headers");
+ private static final QName HEADER_QNAME = new QName(Base.SCA11_TUSCANY_NS,
"header");
+
private static final String NAME = "name";
+ private static final String VALUE = "value";
private static final String URI = "uri";
private RESTBindingFactory httpBindingFactory;
@@ -71,49 +77,87 @@ public class RESTBindingProcessor extend
}
public RESTBinding read(XMLStreamReader reader, ProcessorContext context)
throws ContributionReadException, XMLStreamException {
- RESTBinding httpBinding = httpBindingFactory.createRESTBinding();
+ RESTBinding restBinding = httpBindingFactory.createRESTBinding();
+ /**
+ * <tuscany:binding.rest uri="http://localhost:8085/Customer";>
+ * <tuscany:wireFormat.xml />
+ * <tuscany:operationSelector.jaxrs />
+ * <tuscany:http-headers>
+ * <tuscany:header name="Cache-Control"
value="no-cache"/>
+ * <tuscany:header name="Expires" value="-1"/>
+ * </tuscany:http-headers>
+ * </tuscany:binding.rest>
+ *
+ */
while(reader.hasNext()) {
QName elementName = null;
int event = reader.getEventType();
switch (event) {
case START_ELEMENT:
elementName = reader.getName();
-
- if (RESTBinding.TYPE.equals(elementName)) {
+
+ if(RESTBinding.TYPE.equals(elementName)) {
+
+ // binding attributes
String name = getString(reader, NAME);
if(name != null) {
- httpBinding.setName(name);
+ restBinding.setName(name);
}
String uri = getURIString(reader, URI);
if (uri != null) {
- httpBinding.setURI(uri);
+ restBinding.setURI(uri);
+ }
+ break;
+
+ } else if (HEADERS_QNAME.equals(elementName)) {
+
+ // ignore wrapper element
+ break;
+
+ } else if (HEADER_QNAME.equals(elementName)) {
+
+ // header name/value pair
+ String name = getString(reader, NAME);
+ String value = getURIString(reader, VALUE);
+
+ if(name != null) {
+ restBinding.getHttpHeaders().add(new
HTTPHeader(name, value));
}
+ break;
+
} else {
// Read an extension element
Object extension = extensionProcessor.read(reader,
context);
if (extension != null) {
if (extension instanceof WireFormat) {
-
httpBinding.setRequestWireFormat((WireFormat)extension);
+
restBinding.setRequestWireFormat((WireFormat)extension);
} else if(extension instanceof OperationSelector) {
-
httpBinding.setOperationSelector((OperationSelector)extension);
+
restBinding.setOperationSelector((OperationSelector)extension);
}
}
+ break;
}
- }
+
+ case END_ELEMENT:
+ elementName = reader.getName();
- if (event == END_ELEMENT &&
RESTBinding.TYPE.equals(reader.getName())) {
- break;
+ if(RESTBinding.TYPE.equals(elementName)) {
+ return restBinding;
+ }
+ break;
}
+
+
// Read the next element
if (reader.hasNext()) {
reader.next();
}
}
- return httpBinding;
+ return restBinding;
}
public void write(RESTBinding restBinding, XMLStreamWriter writer,
ProcessorContext context) throws ContributionWriteException, XMLStreamException
{
Added:
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/test/java/org/apache/tuscany/sca/binding/rest/xml/RESTBindingProcessorTestCase.java
URL:
http://svn.apache.org/viewvc/tuscany/sca-java-2.x/trunk/modules/binding-rest/src/test/java/org/apache/tuscany/sca/binding/rest/xml/RESTBindingProcessorTestCase.java?rev=942274&view=auto
==============================================================================
---
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/test/java/org/apache/tuscany/sca/binding/rest/xml/RESTBindingProcessorTestCase.java
(added)
+++
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/test/java/org/apache/tuscany/sca/binding/rest/xml/RESTBindingProcessorTestCase.java
Fri May 7 23:48:28 2010
@@ -0,0 +1,93 @@
+/*
+ * 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.binding.rest.xml;
+
+import java.io.StringReader;
+
+import javax.xml.stream.XMLInputFactory;
+import javax.xml.stream.XMLStreamReader;
+
+import org.apache.tuscany.sca.assembly.Composite;
+import org.apache.tuscany.sca.binding.rest.RESTBinding;
+import
org.apache.tuscany.sca.contribution.processor.DefaultStAXArtifactProcessorExtensionPoint;
+import
org.apache.tuscany.sca.contribution.processor.ExtensibleStAXArtifactProcessor;
+import org.apache.tuscany.sca.contribution.processor.ProcessorContext;
+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.junit.Assert;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+
+/**
+ * @version $Rev$ $Date$
+ */
+public class RESTBindingProcessorTestCase {
+
+ private static final String COMPOSITE =
+ "<?xml version=\"1.0\" encoding=\"ASCII\"?>"
+ + "<composite
xmlns=\"http://docs.oasis-open.org/ns/opencsa/sca/200912\";
xmlns:tuscany=\"http://tuscany.apache.org/xmlns/sca/1.1\";
targetNamespace=\"http://binding-rest\"; name=\"binding-rest\">"
+ + " <component name=\"CustomerService\">"
+ + " <implementation.java
class=\"services.customer.CustomerServiceImpl\"/>"
+ + " <service name=\"CustomerService\">"
+ + " <tuscany:binding.rest
uri=\"http://localhost:8085/Customer\";>"
+ + " <tuscany:wireFormat.xml />"
+ + " <tuscany:operationSelector.jaxrs />"
+ + " <tuscany:http-headers>"
+ + " <tuscany:header name=\"Cache-Control\"
value=\"no-cache\"/>"
+ + " <tuscany:header name=\"Expires\" value=\"-1\"/>"
+ + " </tuscany:http-headers>"
+ + " </tuscany:binding.rest>"
+ + " </service>"
+ + " </component>"
+ + "</composite>";
+
+ private static XMLInputFactory inputFactory;
+ private static StAXArtifactProcessor<Object> staxProcessor;
+ private static ProcessorContext context;
+
+ @BeforeClass
+ public static void setUp() throws Exception {
+ DefaultExtensionPointRegistry extensionPoints = new
DefaultExtensionPointRegistry();
+ context = new ProcessorContext(extensionPoints);
+ inputFactory = XMLInputFactory.newInstance();
+
+ StAXArtifactProcessorExtensionPoint staxProcessors = new
DefaultStAXArtifactProcessorExtensionPoint(extensionPoints);
+ staxProcessor = new ExtensibleStAXArtifactProcessor(staxProcessors,
inputFactory, null);
+ }
+
+ /**
+ * Test parsing valid composite definition. Valid composite populated with
correct values expected.
+ * @throws Exception
+ */
+ @Test
+ public void testLoadValidComposite() throws Exception {
+ XMLStreamReader reader = inputFactory.createXMLStreamReader(new
StringReader(COMPOSITE));
+
+ Composite composite = (Composite)staxProcessor.read(reader, context);
+ RESTBinding binding = (RESTBinding)
composite.getComponents().get(0).getServices().get(0).getBindings().get(0);
+
+ Assert.assertNotNull(binding);
+ Assert.assertEquals(2, binding.getHttpHeaders().size());
+ Assert.assertEquals("Cache-Control",
binding.getHttpHeaders().get(0).getName());
+ Assert.assertEquals("no-cache",
binding.getHttpHeaders().get(0).getValue());
+ }
+}
Propchange:
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/test/java/org/apache/tuscany/sca/binding/rest/xml/RESTBindingProcessorTestCase.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
tuscany/sca-java-2.x/trunk/modules/binding-rest/src/test/java/org/apache/tuscany/sca/binding/rest/xml/RESTBindingProcessorTestCase.java
------------------------------------------------------------------------------
svn:keywords = Rev Date
