/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.jersey.apache.connector;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.List;
import java.util.Map;
import java.util.logging.Logger;
import javax.ws.rs.HttpMethod;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.core.Application;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Request;
import javax.ws.rs.core.Response;
import org.glassfish.jersey.client.ClientConfig;
import org.glassfish.jersey.filter.LoggingFilter;
import org.glassfish.jersey.process.Inflector;
import org.glassfish.jersey.server.ContainerRequest;
import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.server.model.Resource;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.Test;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
/**
* This very basic resource showcases support of a HTTP TRACE method,
* not directly supported by JAX-RS API.
*
* @author Marek Potociar (marek.potociar at oracle.com)
*/
public class TraceSupportTest extends JerseyTest {
private static final Logger LOGGER = Logger.getLogger(TraceSupportTest.class.getName());
/**
* Programmatic tracing root resource path.
*/
public static final String ROOT_PATH_PROGRAMMATIC = "tracing/programmatic";
/**
* Annotated class-based tracing root resource path.
*/
public static final String ROOT_PATH_ANNOTATED = "tracing/annotated";
@HttpMethod(TRACE.NAME)
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TRACE {
public static final String NAME = "TRACE";
}
@Path(ROOT_PATH_ANNOTATED)
public static class TracingResource {
@TRACE
@Produces("text/plain")
public String trace(Request request) {
return stringify((ContainerRequest) request);
}
}
@Override
protected Application configure() {
ResourceConfig config = new ResourceConfig(TracingResource.class);
config.register(new LoggingFilter(LOGGER, true));
final Resource.Builder resourceBuilder = Resource.builder(ROOT_PATH_PROGRAMMATIC);
resourceBuilder.addMethod(TRACE.NAME).handledBy(new Inflector<ContainerRequestContext, Response>() {
@Override
public Response apply(ContainerRequestContext request) {
if (request == null) {
return Response.noContent().build();
} else {
return Response.ok(stringify((ContainerRequest) request), MediaType.TEXT_PLAIN).build();
}
}
});
return config.registerResources(resourceBuilder.build());
}
private String[] expectedFragmentsProgrammatic = new String[]{
"TRACE http://localhost:" + this.getPort() + "/tracing/programmatic"
};
private String[] expectedFragmentsAnnotated = new String[]{
"TRACE http://localhost:" + this.getPort() + "/tracing/annotated"
};
private WebTarget prepareTarget(String path) {
final WebTarget target = target();
target.register(LoggingFilter.class);
return target.path(path);
}
@Test
public void testProgrammaticApp() throws Exception {
Response response = prepareTarget(ROOT_PATH_PROGRAMMATIC).request("text/plain").method(TRACE.NAME);
assertEquals(Response.Status.OK.getStatusCode(), response.getStatusInfo().getStatusCode());
String responseEntity = response.readEntity(String.class);
for (String expectedFragment : expectedFragmentsProgrammatic) {
assertTrue("Expected fragment '" + expectedFragment + "' not found in response:\n" + responseEntity,
// toLowerCase - http header field names are case insensitive
responseEntity.contains(expectedFragment));
}
}
@Test
public void testAnnotatedApp() throws Exception {
Response response = prepareTarget(ROOT_PATH_ANNOTATED).request("text/plain").method(TRACE.NAME);
assertEquals(Response.Status.OK.getStatusCode(), response.getStatusInfo().getStatusCode());
String responseEntity = response.readEntity(String.class);
for (String expectedFragment : expectedFragmentsAnnotated) {
assertTrue("Expected fragment '" + expectedFragment + "' not found in response:\n" + responseEntity,
// toLowerCase - http header field names are case insensitive
responseEntity.contains(expectedFragment));
}
}
@Test
public void testTraceWithEntity() throws Exception {
_testTraceWithEntity(false, false);
}
@Test
public void testAsyncTraceWithEntity() throws Exception {
_testTraceWithEntity(true, false);
}
@Test
public void testTraceWithEntityApacheConnector() throws Exception {
_testTraceWithEntity(false, true);
}
@Test
public void testAsyncTraceWithEntityApacheConnector() throws Exception {
_testTraceWithEntity(true, true);
}
private void _testTraceWithEntity(final boolean isAsync, final boolean useApacheConnection) throws Exception {
try {
WebTarget target = useApacheConnection ? getApacheClient().target(target().getUri()) : target();
target = target.path(ROOT_PATH_ANNOTATED);
final Entity<String> entity = Entity.entity("trace", MediaType.WILDCARD_TYPE);
Response response;
if (!isAsync) {
response = target.request().method(TRACE.NAME, entity);
} else {
response = target.request().async().method(TRACE.NAME, entity).get();
}
fail("A TRACE request MUST NOT include an entity. (response=" + response + ")");
} catch (Exception e) {
// OK
}
}
private Client getApacheClient() {
return ClientBuilder.newClient(new ClientConfig().connectorProvider(new ApacheConnectorProvider()));
}
public static String stringify(ContainerRequest request) {
StringBuilder buffer = new StringBuilder();
printRequestLine(buffer, request);
printPrefixedHeaders(buffer, request.getHeaders());
if (request.hasEntity()) {
buffer.append(request.readEntity(String.class)).append("\n");
}
return buffer.toString();
}
private static void printRequestLine(StringBuilder buffer, ContainerRequest request) {
buffer.append(request.getMethod()).append(" ").append(request.getUriInfo().getRequestUri().toASCIIString()).append("\n");
}
private static void printPrefixedHeaders(StringBuilder buffer, Map<String, List<String>> headers) {
for (Map.Entry<String, List<String>> e : headers.entrySet()) {
List<String> val = e.getValue();
String header = e.getKey();
if (val.size() == 1) {
buffer.append(header).append(": ").append(val.get(0)).append("\n");
} else {
StringBuilder sb = new StringBuilder();
boolean add = false;
for (String s : val) {
if (add) {
sb.append(',');
}
add = true;
sb.append(s);
}
buffer.append(header).append(": ").append(sb.toString()).append("\n");
}
}
}
}