Details
diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/glue/DefaultJaxrsModule.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/glue/DefaultJaxrsModule.java
index f19b31d..e8292d4 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/glue/DefaultJaxrsModule.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/glue/DefaultJaxrsModule.java
@@ -20,6 +20,7 @@ package org.killbill.billing.jaxrs.glue;
import org.killbill.billing.jaxrs.DefaultJaxrsService;
import org.killbill.billing.jaxrs.JaxrsExecutors;
import org.killbill.billing.jaxrs.JaxrsService;
+import org.killbill.billing.jaxrs.util.JaxrsUriBuilder;
import org.killbill.billing.platform.api.KillbillConfigSource;
import org.killbill.billing.util.config.JaxrsConfig;
import org.killbill.billing.util.glue.KillBillModule;
@@ -36,7 +37,7 @@ public class DefaultJaxrsModule extends KillBillModule {
final ConfigurationObjectFactory factory = new ConfigurationObjectFactory(skifeConfigSource);
final JaxrsConfig jaxrsConfig = factory.build(JaxrsConfig.class);
bind(JaxrsConfig.class).toInstance(jaxrsConfig);
-
+ bind(JaxrsUriBuilder.class).asEagerSingleton();
bind(JaxrsExecutors.class).asEagerSingleton();
bind(JaxrsService.class).to(DefaultJaxrsService.class).asEagerSingleton();
}
diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/AccountResource.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/AccountResource.java
index 30a96c2..ca85ff4 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/AccountResource.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/AccountResource.java
@@ -1032,8 +1032,8 @@ public class AccountResource extends JaxRsResourceBase {
@HeaderParam(HDR_COMMENT) final String comment,
@javax.ws.rs.core.Context final HttpServletRequest request,
@javax.ws.rs.core.Context final UriInfo uriInfo) throws CustomFieldApiException {
- return super.createCustomFields(UUID.fromString(id), customFields,
- context.createContext(createdBy, reason, comment, request), uriInfo);
+ return super.createCustomFields(UUID.fromString(id), customFields, context.createContext(createdBy, reason,
+ comment, request), uriInfo);
}
@TimedResource
diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/JaxRsResourceBase.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/JaxRsResourceBase.java
index b800815..19a8d26 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/JaxRsResourceBase.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/JaxRsResourceBase.java
@@ -544,7 +544,8 @@ public abstract class JaxRsResourceBase implements JaxrsResource {
Preconditions.checkArgument(actual == expected, errorMessage);
}
- protected Response createPaymentResponse(final UriInfo uriInfo, final Payment payment, final TransactionType transactionType, @Nullable final String transactionExternalKey) {
+ protected Response createPaymentResponse(final UriInfo uriInfo, final Payment payment, final TransactionType transactionType,
+ @Nullable final String transactionExternalKey) {
final PaymentTransaction createdTransaction = findCreatedTransaction(payment, transactionType, transactionExternalKey);
Preconditions.checkNotNull(createdTransaction, "No transaction of type '%s' found", transactionType);
diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/SubscriptionResource.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/SubscriptionResource.java
index 5032362..0efacbc 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/SubscriptionResource.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/SubscriptionResource.java
@@ -48,7 +48,6 @@ import org.killbill.billing.account.api.AccountUserApi;
import org.killbill.billing.catalog.api.BillingActionPolicy;
import org.killbill.billing.catalog.api.BillingPeriod;
import org.killbill.billing.catalog.api.CatalogApiException;
-import org.killbill.billing.catalog.api.CatalogUserApi;
import org.killbill.billing.catalog.api.PhaseType;
import org.killbill.billing.catalog.api.PlanPhasePriceOverride;
import org.killbill.billing.catalog.api.PlanPhaseSpecifier;
diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/util/JaxrsUriBuilder.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/util/JaxrsUriBuilder.java
index a40529f..68d4fda 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/util/JaxrsUriBuilder.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/util/JaxrsUriBuilder.java
@@ -20,6 +20,7 @@ import java.net.URI;
import java.util.Map;
import javax.annotation.Nullable;
+import javax.inject.Inject;
import javax.ws.rs.Path;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriBuilder;
@@ -27,19 +28,34 @@ import javax.ws.rs.core.UriInfo;
import org.killbill.billing.jaxrs.resources.JaxRsResourceBase;
import org.killbill.billing.jaxrs.resources.JaxrsResource;
+import org.killbill.billing.util.config.JaxrsConfig;
public class JaxrsUriBuilder {
- public Response buildResponse(final UriInfo uriInfo, final Class<? extends JaxrsResource> theClass, final String getMethodName, final Object objectId) {
+ private final JaxrsConfig jaxrsConfig;
+
+ @Inject
+ public JaxrsUriBuilder(JaxrsConfig jaxrsConfig) {
+ this.jaxrsConfig = jaxrsConfig;
+ }
+
+ public Response buildResponse(final UriInfo uriInfo, final Class<? extends JaxrsResource> theClass,
+ final String getMethodName, final Object objectId) {
final URI location = buildLocation(uriInfo, theClass, getMethodName, objectId);
- return Response.created(location).build();
+ return !jaxrsConfig.isJaxrsLocationFullUrl() ?
+ Response.status(Response.Status.CREATED).header("Location", location.getPath()).build() :
+ Response.created(location).build();
}
- public URI buildLocation(final UriInfo uriInfo, final Class<? extends JaxrsResource> theClass, final String getMethodName, final Object objectId) {
- final UriBuilder uriBuilder = getUriBuilder(theClass, getMethodName).scheme(uriInfo.getAbsolutePath().getScheme())
- .host(uriInfo.getAbsolutePath().getHost())
- .port(uriInfo.getAbsolutePath().getPort());
+ public URI buildLocation(final UriInfo uriInfo, final Class<? extends JaxrsResource> theClass,
+ final String getMethodName, final Object objectId) {
+ final UriBuilder uriBuilder = getUriBuilder(uriInfo.getBaseUri().getPath(), theClass, getMethodName);
+ if (jaxrsConfig.isJaxrsLocationFullUrl()) {
+ uriBuilder.scheme(uriInfo.getAbsolutePath().getScheme())
+ .host(uriInfo.getAbsolutePath().getHost())
+ .port(uriInfo.getAbsolutePath().getPort());
+ }
return objectId != null ? uriBuilder.build(objectId) : uriBuilder.build();
}
@@ -74,6 +90,12 @@ public class JaxrsUriBuilder {
return ri.entity(obj).build();
}
+ private UriBuilder getUriBuilder(final String path, final Class<? extends JaxrsResource> theClassMaybeEnhanced, @Nullable final String getMethodName) {
+ final Class theClass = getNonEnhancedClass(theClassMaybeEnhanced);
+ return getMethodName != null ? UriBuilder.fromPath(path.equals("/") ? path.substring(1) : path).path(theClass).path(theClass, getMethodName) :
+ UriBuilder.fromPath(path).path(theClass);
+ }
+
private UriBuilder getUriBuilder(final Class<? extends JaxrsResource> theClassMaybeEnhanced, @Nullable final String getMethodName) {
final Class theClass = getNonEnhancedClass(theClassMaybeEnhanced);
return getMethodName != null ? UriBuilder.fromResource(theClass).path(theClass, getMethodName) :
diff --git a/profiles/killbill/src/test/java/org/killbill/billing/jaxrs/TestBuildResponse.java b/profiles/killbill/src/test/java/org/killbill/billing/jaxrs/TestBuildResponse.java
new file mode 100644
index 0000000..123265d
--- /dev/null
+++ b/profiles/killbill/src/test/java/org/killbill/billing/jaxrs/TestBuildResponse.java
@@ -0,0 +1,108 @@
+/*
+ * Copyright 2016 The Billing Project, LLC
+ *
+ * The Billing Project 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.killbill.billing.jaxrs;
+
+import org.killbill.billing.jaxrs.resources.AccountResource;
+import org.killbill.billing.jaxrs.util.JaxrsUriBuilder;
+import org.killbill.billing.server.log.ServerTestSuiteNoDB;
+import org.killbill.billing.util.config.JaxrsConfig;
+import org.testng.annotations.Test;
+
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.UriInfo;
+import java.net.URI;
+import java.util.UUID;
+
+import com.sun.jersey.api.client.ClientResponse.Status;
+
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertEqualsNoOrder;
+
+public class TestBuildResponse extends ServerTestSuiteNoDB {
+
+ @Test(groups = "fast", description = "Tests Uri Builder with Path Like URL and root Location")
+ public void testUriBuilderWithPathLikeUrlAndRoot() throws Exception {
+ UUID objectId = UUID.randomUUID();
+
+ final UriInfo uriInfo = mock(UriInfo.class);
+ URI uri = URI.create("http://localhost:8080");
+ when(uriInfo.getBaseUri()).thenReturn(uri);
+
+ JaxrsConfig jaxrsConfig = mock(JaxrsConfig.class);
+ when(jaxrsConfig.isJaxrsLocationFullUrl()).thenReturn(false);
+ JaxrsUriBuilder uriBuilder = new JaxrsUriBuilder(jaxrsConfig);
+ Response response = uriBuilder.buildResponse(uriInfo, AccountResource.class, "getAccount", objectId);
+
+ assertEquals(response.getStatus(), Status.CREATED.getStatusCode());
+ assertEquals(response.getMetadata().get("Location").get(0), "/1.0/kb/accounts/" + objectId.toString());
+ }
+
+ @Test(groups = "fast", description = "Tests Uri Builder with Path Like URL and non root Location")
+ public void testUriBuilderWithPathLikeUrlAndNonRoot() throws Exception {
+ UUID objectId = UUID.randomUUID();
+
+ final UriInfo uriInfo = mock(UriInfo.class);
+ URI uri = URI.create("http://localhost:8080/killbill");
+ when(uriInfo.getBaseUri()).thenReturn(uri);
+
+ JaxrsConfig jaxrsConfig = mock(JaxrsConfig.class);
+ when(jaxrsConfig.isJaxrsLocationFullUrl()).thenReturn(false);
+ JaxrsUriBuilder uriBuilder = new JaxrsUriBuilder(jaxrsConfig);
+ Response response = uriBuilder.buildResponse(uriInfo, AccountResource.class, "getAccount", objectId);
+
+ assertEquals(response.getStatus(), Status.CREATED.getStatusCode());
+ assertEquals(response.getMetadata().get("Location").get(0), "/killbill/1.0/kb/accounts/" + objectId.toString());
+ }
+
+ @Test(groups = "fast", description = "Tests Uri Builder with Full URL and root Location")
+ public void testUriBuilderWithoutPathLikeUrlAndRoot() throws Exception {
+ UUID objectId = UUID.randomUUID();
+
+ final UriInfo uriInfo = mock(UriInfo.class);
+ URI uri = URI.create("http://localhost:8080");
+ when(uriInfo.getBaseUri()).thenReturn(uri);
+ when(uriInfo.getAbsolutePath()).thenReturn(uri);
+
+ JaxrsConfig jaxrsConfig = mock(JaxrsConfig.class);
+ when(jaxrsConfig.isJaxrsLocationFullUrl()).thenReturn(true);
+ JaxrsUriBuilder uriBuilder = new JaxrsUriBuilder(jaxrsConfig);
+ Response response = uriBuilder.buildResponse(uriInfo, AccountResource.class, "getAccount", objectId);
+
+ assertEquals(response.getStatus(), Status.CREATED.getStatusCode());
+ assertEquals(response.getMetadata().get("Location").get(0).toString(), uri.toString() + "/1.0/kb/accounts/" + objectId.toString());
+ }
+
+ @Test(groups = "fast", description = "Tests Uri Builder with Full URL and non root Location")
+ public void testUriBuilderWithoutPathLikeUrlAndNonRoot() throws Exception {
+ UUID objectId = UUID.randomUUID();
+
+ final UriInfo uriInfo = mock(UriInfo.class);
+ URI uri = URI.create("http://localhost:8080/killbill");
+ when(uriInfo.getBaseUri()).thenReturn(uri);
+ when(uriInfo.getAbsolutePath()).thenReturn(uri);
+
+ JaxrsConfig jaxrsConfig = mock(JaxrsConfig.class);
+ when(jaxrsConfig.isJaxrsLocationFullUrl()).thenReturn(true);
+ JaxrsUriBuilder uriBuilder = new JaxrsUriBuilder(jaxrsConfig);
+ Response response = uriBuilder.buildResponse(uriInfo, AccountResource.class, "getAccount", objectId);
+
+ assertEquals(response.getStatus(), Status.CREATED.getStatusCode());
+ assertEquals(response.getMetadata().get("Location").get(0).toString(), uri.toString() + "/1.0/kb/accounts/" + objectId.toString());
+ }
+}
diff --git a/util/src/main/java/org/killbill/billing/util/config/JaxrsConfig.java b/util/src/main/java/org/killbill/billing/util/config/JaxrsConfig.java
index a8583e8..42e5b91 100644
--- a/util/src/main/java/org/killbill/billing/util/config/JaxrsConfig.java
+++ b/util/src/main/java/org/killbill/billing/util/config/JaxrsConfig.java
@@ -34,4 +34,9 @@ public interface JaxrsConfig extends KillbillConfig {
@Description("Total timeout for all callables associated to a given api call (parallel mode)")
TimeSpan getJaxrsTimeout();
+ @Config("org.killbill.jaxrs.location.full.url")
+ @Default("false")
+ @Description("Type of return for the jaxrs response location URL")
+ boolean isJaxrsLocationFullUrl();
+
}