Clean up build so that JAX-RS uses the same response pipeline as the

non-JAX-RS codebase for create/update/delete responses, re #374

hapi-fhir-jaxrsserver-base/src/main/java/ca/uhn/fhir/jaxrs/server/AbstractJaxRsConformanceProvider.java

@@ -25,9 +25,11 @@ import java.lang.annotation.Annotation;
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map.Entry;
+import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 
 import javax.annotation.PostConstruct;
@@ -52,6 +54,7 @@ import ca.uhn.fhir.jaxrs.server.util.JaxRsRequest.Builder;
 import ca.uhn.fhir.rest.annotation.IdParam;
 import ca.uhn.fhir.rest.api.RequestTypeEnum;
 import ca.uhn.fhir.rest.api.RestOperationTypeEnum;
+import ca.uhn.fhir.rest.api.SummaryEnum;
 import ca.uhn.fhir.rest.method.BaseMethodBinding;
 import ca.uhn.fhir.rest.method.ParseAction;
 import ca.uhn.fhir.rest.server.Constants;
@@ -63,8 +66,7 @@ import ca.uhn.fhir.rest.server.RestulfulServerConfiguration;
 import ca.uhn.fhir.util.ReflectionUtil;
 
 /**
- * This is the conformance provider for the jax rs servers. It requires all providers to be registered
+ * This is the conformance provider for the jax rs servers. It requires all providers to be registered during startup because the conformance profile is generated during the postconstruct phase.
- * during startup because the conformance profile is generated during the postconstruct phase.
  * 
  * @author Peter Van Houte | peter.vanhoute@agfa.com | Agfa Healthcare
  */
@@ -86,9 +88,13 @@ public abstract class AbstractJaxRsConformanceProvider extends AbstractJaxRsProv
 
 	/**
 	 * Constructor allowing the description, servername and server to be set
-     * @param implementationDescription the implementation description. If null, "" is used
+	 * 
-     * @param serverName the server name. If null, "" is used
+	 * @param implementationDescription
-     * @param serverVersion the server version. If null, "" is used
+	 *           the implementation description. If null, "" is used
+	 * @param serverName
+	 *           the server name. If null, "" is used
+	 * @param serverVersion
+	 *           the server version. If null, "" is used
 	 */
 	protected AbstractJaxRsConformanceProvider(String implementationDescription, String serverName, String serverVersion) {
 		serverConfiguration.setFhirContext(getFhirContext());
@@ -99,10 +105,15 @@ public abstract class AbstractJaxRsConformanceProvider extends AbstractJaxRsProv
 
 	/**
 	 * Constructor allowing the description, servername and server to be set
-     * @param ctx the {@link FhirContext} instance.
+	 * 
-     * @param implementationDescription the implementation description. If null, "" is used
+	 * @param ctx
-     * @param serverName the server name. If null, "" is used
+	 *           the {@link FhirContext} instance.
-     * @param serverVersion the server version. If null, "" is used
+	 * @param implementationDescription
+	 *           the implementation description. If null, "" is used
+	 * @param serverName
+	 *           the server name. If null, "" is used
+	 * @param serverVersion
+	 *           the server version. If null, "" is used
 	 */
 	protected AbstractJaxRsConformanceProvider(FhirContext ctx, String implementationDescription, String serverName, String serverVersion) {
 		super(ctx);
@@ -113,9 +124,8 @@ public abstract class AbstractJaxRsConformanceProvider extends AbstractJaxRsProv
 	}
 
 	/**
-	 * This method will set the conformance during the postconstruct phase. The
+	 * This method will set the conformance during the postconstruct phase. The method {@link AbstractJaxRsConformanceProvider#getProviders()} is used to get all the resource providers include in the
-	 * method {@link AbstractJaxRsConformanceProvider#getProviders()} is used to
+	 * conformance
-	 * get all the resource providers include in the conformance
 	 */
 	@PostConstruct
 	protected void setUpPostConstruct() {
@@ -144,14 +154,15 @@ public abstract class AbstractJaxRsConformanceProvider extends AbstractJaxRsProv
 
 	/**
 	 * This method must return all the resource providers which need to be included in the conformance
-     * @return a map of the resource providers and their corresponding classes. This class needs to be given
+	 * 
-     * explicitly because retrieving the interface using {@link Object#getClass()} may not give the correct
+	 * @return a map of the resource providers and their corresponding classes. This class needs to be given explicitly because retrieving the interface using {@link Object#getClass()} may not give the
-     * interface in a jee environment.
+	 *         correct interface in a jee environment.
 	 */
 	protected abstract ConcurrentHashMap<Class<? extends IResourceProvider>, IResourceProvider> getProviders();
 
 	/**
 	 * This method will retrieve the conformance using the http OPTIONS method
+	 * 
 	 * @return the response containing the conformance
 	 */
 	@OPTIONS
@@ -162,6 +173,7 @@ public abstract class AbstractJaxRsConformanceProvider extends AbstractJaxRsProv
 
 	/**
 	 * This method will retrieve the conformance using the http GET method
+	 * 
 	 * @return the response containing the conformance
 	 */
 	@GET
@@ -170,18 +182,30 @@ public abstract class AbstractJaxRsConformanceProvider extends AbstractJaxRsProv
 		Builder request = getRequest(RequestTypeEnum.OPTIONS, RestOperationTypeEnum.METADATA);
 		IRestfulResponse response = request.build().getResponse();
 		response.addHeader(Constants.HEADER_CORS_ALLOW_ORIGIN, "*");
+		
+		IBaseResource conformance = null;
 		if (super.getFhirContext().getVersion().getVersion().equals(FhirVersionEnum.DSTU3)) {
-		    return (Response) response.returnResponse(ParseAction.create(myDstu3Conformance), Constants.STATUS_HTTP_200_OK, true, null, getResourceType().getSimpleName());
+			conformance = myDstu3Conformance;
+//			return (Response) response.returnResponse(ParseAction.create(myDstu3Conformance), Constants.STATUS_HTTP_200_OK, true, null, getResourceType().getSimpleName());
 		} else if (super.getFhirContext().getVersion().getVersion().equals(FhirVersionEnum.DSTU2)) {
-	        return (Response) response.returnResponse(ParseAction.create(myDstu2Conformance), Constants.STATUS_HTTP_200_OK, true, null, getResourceType().getSimpleName());
+			conformance = myDstu2Conformance;
+//			return (Response) response.returnResponse(ParseAction.create(myDstu2Conformance), Constants.STATUS_HTTP_200_OK, true, null, getResourceType().getSimpleName());
+		}
+		
+		if (conformance != null) {
+			Set<SummaryEnum> summaryMode = Collections.emptySet();
+			return (Response) response.streamResponseAsResource(conformance, false, summaryMode, Constants.STATUS_HTTP_200_OK, true, false);
 		}
 		return (Response) response.returnResponse(null, Constants.STATUS_HTTP_500_INTERNAL_ERROR, true, null, getResourceType().getSimpleName());
 	}
 
 	/**
 	 * This method will add a provider to the conformance. This method is almost an exact copy of {@link ca.uhn.fhir.rest.server.RestfulServer#findResourceMethods }
-     * @param theProvider an instance of the provider interface
+	 * 
-     * @param theProviderInterface the class describing the providers interface 
+	 * @param theProvider
+	 *           an instance of the provider interface
+	 * @param theProviderInterface
+	 *           the class describing the providers interface
 	 * @return the numbers of basemethodbindings added
 	 * @see ca.uhn.fhir.rest.server.RestfulServer#findResourceMethods
 	 */

hapi-fhir-jaxrsserver-base/src/test/java/ca/uhn/fhir/jaxrs/server/util/JaxRsResponseDstu3Test.java

@@ -100,15 +100,15 @@ public class JaxRsResponseDstu3Test {
 	@Test
 	public void testReturnResponse() throws IOException {
 		IdType theId = new IdType(15L);
-		ParseAction<?> outcome = ParseAction.create(createPatient());
 		int operationStatus = 200;
 		boolean allowPrefer = true;
 		String resourceName = "Patient";
 		MethodOutcome methodOutcome = new MethodOutcome(theId);
-		Response result = response.returnResponse(outcome, operationStatus, allowPrefer, methodOutcome, resourceName);
+		boolean addContentLocationHeader = true;
+		boolean respondGzip = true;
+		Response result = (Response) RestfulServerUtils.streamResponseAsResource(request.getServer(), createPatient(), theSummaryMode, 200, addContentLocationHeader, respondGzip, this.request);
 		assertEquals(200, result.getStatus());
-		assertEquals(Constants.CT_JSON+Constants.CHARSET_UTF8_CTSUFFIX, result.getHeaderString(Constants.HEADER_CONTENT_TYPE));
+		assertEquals("application/json+fhir; charset=UTF-8", result.getHeaderString(Constants.HEADER_CONTENT_TYPE));
-		System.out.println(result.getEntity().toString());
 		assertTrue(result.getEntity().toString().contains("resourceType\":\"Patient"));
 		assertTrue(result.getEntity().toString().contains("15"));
 		
@@ -117,30 +117,32 @@ public class JaxRsResponseDstu3Test {
 	@Test
 	public void testReturnResponseAsXml() throws IOException {
 		IdType theId = new IdType(15L);
-		ParseAction<?> outcome = ParseAction.create(createPatient());
 		int operationStatus = 200;
 		boolean allowPrefer = true;
 		String resourceName = "Patient";
 		MethodOutcome methodOutcome = new MethodOutcome(theId);
 		response.getRequestDetails().getParameters().put(Constants.PARAM_FORMAT, new String[]{Constants.CT_XML});
-		Response result = response.returnResponse(outcome, operationStatus, allowPrefer, methodOutcome, resourceName);
+		boolean addContentLocationHeader = true;
+		boolean respondGzip = true;
+		Response result = (Response) RestfulServerUtils.streamResponseAsResource(request.getServer(), createPatient(), theSummaryMode, 200, addContentLocationHeader, respondGzip, this.request);
 		assertEquals(200, result.getStatus());
-		assertEquals(Constants.CT_XML+Constants.CHARSET_UTF8_CTSUFFIX, result.getHeaderString(Constants.HEADER_CONTENT_TYPE));
+		assertEquals("application/xml+fhir; charset=UTF-8", result.getHeaderString(Constants.HEADER_CONTENT_TYPE));
 		assertTrue(result.getEntity().toString().contains("<Patient"));
 		assertTrue(result.getEntity().toString().contains("15"));
 	}
 	
 	@Test
 	public void testNoOutcomeXml() throws IOException {
-		ParseAction<?> outcome = ParseAction.create((IBaseResource) null);
 		int operationStatus = Constants.STATUS_HTTP_204_NO_CONTENT;
 		boolean allowPrefer = true;
 		String resourceName = "Patient";
 		MethodOutcome methodOutcome = new MethodOutcome(null);
 		response.getRequestDetails().getParameters().put(Constants.PARAM_FORMAT, new String[]{Constants.CT_XML});
-		Response result = response.returnResponse(outcome, operationStatus, allowPrefer, methodOutcome, resourceName);
+		boolean addContentLocationHeader = true;
+		boolean respondGzip = true;
+		Response result = (Response) RestfulServerUtils.streamResponseAsResource(request.getServer(), null, theSummaryMode, 204, addContentLocationHeader, respondGzip, this.request);
 		assertEquals(204, result.getStatus());
-		assertEquals(Constants.CT_XML+Constants.CHARSET_UTF8_CTSUFFIX, result.getHeaderString(Constants.HEADER_CONTENT_TYPE));
+		assertEquals(null, result.getHeaderString(Constants.HEADER_CONTENT_TYPE));
 	}
 
 	private Bundle getSinglePatientResource() {

hapi-fhir-jaxrsserver-base/src/test/java/ca/uhn/fhir/jaxrs/server/util/JaxRsResponseTest.java

@@ -11,7 +11,6 @@ import java.util.Set;
 import javax.ws.rs.core.Response;
 
 import org.hl7.fhir.instance.model.api.IBaseBinary;
-import org.hl7.fhir.instance.model.api.IBaseResource;
 import org.junit.Before;
 import org.junit.Test;
 
@@ -19,9 +18,7 @@ import ca.uhn.fhir.model.api.Bundle;
 import ca.uhn.fhir.model.dstu2.resource.Binary;
 import ca.uhn.fhir.model.dstu2.resource.Patient;
 import ca.uhn.fhir.model.primitive.IdDt;
-import ca.uhn.fhir.rest.api.MethodOutcome;
 import ca.uhn.fhir.rest.api.SummaryEnum;
-import ca.uhn.fhir.rest.method.ParseAction;
 import ca.uhn.fhir.rest.server.Constants;
 import ca.uhn.fhir.rest.server.RestfulServerUtils;
 
@@ -42,7 +39,6 @@ public class JaxRsResponseTest {
 	
 	@Test
 	public void testGetResponseWriterNoZipNoBrowser() throws IOException {
-		boolean theRequestIsBrowser = false;
 		boolean respondGzip = false;
 		Set<SummaryEnum> theSummaryMode = Collections.<SummaryEnum>emptySet();
 		Response result = (Response) RestfulServerUtils.streamResponseAsBundle(request.getServer(), bundle, theSummaryMode, respondGzip, request);
@@ -54,7 +50,6 @@ public class JaxRsResponseTest {
 
 	@Test
 	public void testSendAttachmentResponse() throws IOException {
-		boolean theRequestIsBrowser = true;
 		boolean respondGzip = true;
 		IBaseBinary binary = new Binary();
 		String contentType = "foo";
@@ -70,7 +65,6 @@ public class JaxRsResponseTest {
 	
 	@Test
 	public void testSendAttachmentResponseNoContent() throws IOException {
-		boolean theRequestIsBrowser = true;
 		boolean respondGzip = true;
 		IBaseBinary binary = new Binary();
 		binary.setContent(new byte[]{});
@@ -83,7 +77,6 @@ public class JaxRsResponseTest {
 	
 	@Test
 	public void testSendAttachmentResponseEmptyContent() throws IOException {
-		boolean theRequestIsBrowser = true;
 		boolean respondGzip = true;
 		IBaseBinary binary = new Binary();
 		boolean theAddContentLocationHeader = false;
@@ -96,15 +89,12 @@ public class JaxRsResponseTest {
 
 	@Test
 	public void testReturnResponse() throws IOException {
-		IdDt theId = new IdDt(15L);
+		boolean addContentLocationHeader = true;
-		ParseAction<?> outcome = ParseAction.create(createPatient());
+		boolean respondGzip = true;
-		int operationStatus = 200;
+		//		Response result = response.returnResponse(outcome, operationStatus, allowPrefer, methodOutcome, resourceName);
-		boolean allowPrefer = true;
+		Response result = (Response) RestfulServerUtils.streamResponseAsResource(request.getServer(), createPatient(), theSummaryMode, 200, addContentLocationHeader, respondGzip, this.request);
-		String resourceName = "Patient";
-		MethodOutcome methodOutcome = new MethodOutcome(theId);
-		Response result = response.returnResponse(outcome, operationStatus, allowPrefer, methodOutcome, resourceName);
 		assertEquals(200, result.getStatus());
-		assertEquals(Constants.CT_JSON+Constants.CHARSET_UTF8_CTSUFFIX, result.getHeaderString(Constants.HEADER_CONTENT_TYPE));
+		assertEquals("application/json+fhir; charset=UTF-8", result.getHeaderString(Constants.HEADER_CONTENT_TYPE));
 		System.out.println(result.getEntity().toString());
 		assertTrue(result.getEntity().toString().contains("resourceType\":\"Patient"));
 		assertTrue(result.getEntity().toString().contains("15"));
@@ -113,31 +103,24 @@ public class JaxRsResponseTest {
 	
 	@Test
 	public void testReturnResponseAsXml() throws IOException {
-		IdDt theId = new IdDt(15L);
-		ParseAction<?> outcome = ParseAction.create(createPatient());
-		int operationStatus = 200;
-		boolean allowPrefer = true;
-		String resourceName = "Patient";
-		MethodOutcome methodOutcome = new MethodOutcome(theId);
 		response.getRequestDetails().getParameters().put(Constants.PARAM_FORMAT, new String[]{Constants.CT_XML});
-		Response result = response.returnResponse(outcome, operationStatus, allowPrefer, methodOutcome, resourceName);
+		boolean addContentLocationHeader = true;
+		boolean respondGzip = true;
+		Response result = (Response) RestfulServerUtils.streamResponseAsResource(request.getServer(), createPatient(), theSummaryMode, 200, addContentLocationHeader, respondGzip, this.request);
 		assertEquals(200, result.getStatus());
-		assertEquals(Constants.CT_XML+Constants.CHARSET_UTF8_CTSUFFIX, result.getHeaderString(Constants.HEADER_CONTENT_TYPE));
+		assertEquals("application/xml+fhir; charset=UTF-8", result.getHeaderString(Constants.HEADER_CONTENT_TYPE));
 		assertTrue(result.getEntity().toString().contains("<Patient"));
 		assertTrue(result.getEntity().toString().contains("15"));
 	}
 	
 	@Test
 	public void testNoOutcomeXml() throws IOException {
-		ParseAction<?> outcome = ParseAction.create((IBaseResource) null);
-		int operationStatus = Constants.STATUS_HTTP_204_NO_CONTENT;
-		boolean allowPrefer = true;
-		String resourceName = "Patient";
-		MethodOutcome methodOutcome = new MethodOutcome(null);
 		response.getRequestDetails().getParameters().put(Constants.PARAM_FORMAT, new String[]{Constants.CT_XML});
-		Response result = response.returnResponse(outcome, operationStatus, allowPrefer, methodOutcome, resourceName);
+		boolean addContentLocationHeader = true;
-		assertEquals(204, result.getStatus());
+		boolean respondGzip = true;
-		assertEquals(Constants.CT_XML+Constants.CHARSET_UTF8_CTSUFFIX, result.getHeaderString(Constants.HEADER_CONTENT_TYPE));
+		Response result = (Response) RestfulServerUtils.streamResponseAsResource(request.getServer(), createPatient(), theSummaryMode, 200, addContentLocationHeader, respondGzip, this.request);
+		assertEquals(200, result.getStatus());
+		assertEquals("application/xml+fhir; charset=UTF-8", result.getHeaderString(Constants.HEADER_CONTENT_TYPE));
 	}
 
 	private Bundle getSinglePatientResource() {