ProvidersOrderingTest.java
/*
* Copyright (c) 2012, 2023 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.jersey.tests.e2e.common;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Application;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.MessageBodyReader;
import javax.ws.rs.ext.MessageBodyWriter;
import org.glassfish.jersey.message.MessageBodyWorkers;
import org.glassfish.jersey.message.internal.AbstractMessageReaderWriterProvider;
import org.glassfish.jersey.message.internal.ReaderWriter;
import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
/**
* @author Pavel Bucek
*/
public class ProvidersOrderingTest extends JerseyTest {
public static class MyType {
}
public static class MyTypeExt extends MyType {
}
public static class MyTypeExtExt extends MyTypeExt {
}
@Produces("application/test1")
public static class MyMBW1 implements MessageBodyWriter<MyType> {
private final List<Class<?>> callList;
public MyMBW1(List<Class<?>> callList) {
this.callList = callList;
}
@Override
public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
callList.add(this.getClass());
return false;
}
@Override
public long getSize(MyType myType, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return -1;
}
@Override
public void writeTo(MyType myType,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String, Object> httpHeaders,
OutputStream entityStream) throws IOException, WebApplicationException {
}
}
@Produces("application/*")
public static class MyMBW2 implements MessageBodyWriter<MyType> {
private final List<Class<?>> callList;
public MyMBW2(List<Class<?>> callList) {
this.callList = callList;
}
@Override
public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
callList.add(this.getClass());
return false;
}
@Override
public long getSize(MyType myType, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return -1;
}
@Override
public void writeTo(MyType myType,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String, Object> httpHeaders,
OutputStream entityStream) throws IOException, WebApplicationException {
}
}
@Produces("*/*")
public static class MyMBW3 implements MessageBodyWriter<MyType> {
private final List<Class<?>> callList;
public MyMBW3(List<Class<?>> callList) {
this.callList = callList;
}
@Override
public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
callList.add(this.getClass());
return true;
}
@Override
public long getSize(MyType myType, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return -1;
}
@Override
public void writeTo(MyType myType,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String, Object> httpHeaders,
OutputStream entityStream) throws IOException, WebApplicationException {
entityStream.write("test".getBytes());
}
}
@Produces("application/*")
public static class MyMBW4 implements MessageBodyWriter<MyTypeExt> {
private final List<Class<?>> callList;
public MyMBW4(List<Class<?>> callList) {
this.callList = callList;
}
@Override
public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
callList.add(this.getClass());
return false;
}
@Override
public long getSize(MyTypeExt myType, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return -1;
}
@Override
public void writeTo(MyTypeExt myType,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String, Object> httpHeaders,
OutputStream entityStream) throws IOException, WebApplicationException {
}
}
@Produces("application/xml")
public static class MyMBW5 implements MessageBodyWriter<Object> {
@Override
public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return false;
}
@Override
public long getSize(Object myType, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return -1;
}
@Override
public void writeTo(Object myType,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String, Object> httpHeaders,
OutputStream entityStream) throws IOException, WebApplicationException {
}
}
@Consumes("application/test")
public static class MyMBR1 implements MessageBodyReader<MyType> {
private final List<Class<?>> callList;
public MyMBR1(List<Class<?>> callList) {
this.callList = callList;
}
@Override
public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
callList.add(this.getClass());
return false;
}
@Override
public MyType readFrom(Class<MyType> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String, String> httpHeaders,
InputStream entityStream) throws IOException, WebApplicationException {
return null;
}
}
@Consumes("application/test1")
public static class MyMBR2 implements MessageBodyReader<MyTypeExt> {
private final List<Class<?>> callList;
public MyMBR2(List<Class<?>> callList) {
this.callList = callList;
}
@Override
public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
callList.add(this.getClass());
return false;
}
@Override
public MyTypeExt readFrom(Class<MyTypeExt> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String, String> httpHeaders,
InputStream entityStream) throws IOException, WebApplicationException {
return null;
}
}
@Consumes("application/test1")
public static class MyMBR3 implements MessageBodyReader<MyTypeExtExt> {
private final List<Class<?>> callList;
public MyMBR3(List<Class<?>> callList) {
this.callList = callList;
}
@Override
public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
callList.add(this.getClass());
return true;
}
@Override
public MyTypeExtExt readFrom(Class<MyTypeExtExt> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String, String> httpHeaders,
InputStream entityStream) throws IOException, WebApplicationException {
return new MyTypeExtExt();
}
}
@Path("/")
public static class MyResource {
@Context
MessageBodyWorkers messageBodyWorkers;
@PUT
@Consumes("application/test1")
public MyType getMyType(MyTypeExtExt myType) {
final Map<MediaType, List<MessageBodyWriter>> writers = messageBodyWorkers.getWriters(MediaType.APPLICATION_XML_TYPE);
final List<MessageBodyWriter> messageBodyWriters = writers.get(MediaType.APPLICATION_XML_TYPE);
assertTrue(messageBodyWriters.get(0) instanceof MyMBW5);
return myType;
}
@Path("bytearray")
@POST
public byte[] bytearray(byte[] bytes) {
return bytes;
}
}
private List<Class<?>> callList;
@Override
protected Application configure() {
callList = new ArrayList<>();
final ResourceConfig resourceConfig = new ResourceConfig(MyResource.class, MyMBW5.class);
resourceConfig.registerInstances(new MyMBW1(callList), new MyMBW2(callList), new MyMBW3(callList), new MyMBW4(callList),
new MyMBR1(callList), new MyMBR2(callList), new MyMBR3(callList), new MyByteArrayProvider());
return resourceConfig;
}
@Test
@SuppressWarnings("unchecked")
public void orderingTest() {
callList.clear();
WebTarget target = target();
try {
Response response = target.request("application/test1")
.put(Entity.entity("test", "application/test1"), Response.class);
assertNotNull(response);
assertEquals(200, response.getStatus(),
"Request was not handled correctly, most likely fault in MessageBodyWorker selection.");
} catch (Exception e) {
System.out.println(e.getMessage());
e.printStackTrace();
fail("Request was not handled correctly, most likely fault in MessageBodyWorker selection.");
}
List<Class<?>> classes = Arrays.asList(
MyMBR3.class, // MBR - smallest type distance (MBR1 and MBR2 are not called because of that)
MyMBW4.class, // MBW - type distance
MyMBW1.class, // MBW - most specific media type application/test1
MyMBW2.class, // MBW - application/*
MyMBW3.class // MBW - */*, first usable writer (returns true to isWriteable call)
);
assertEquals(classes, callList);
}
@Test
public void replaceBuiltInProvider() {
callList.clear();
WebTarget target = target("bytearray");
try {
Response response = target.request().post(Entity.text("replaceBuiltInProvider"), Response.class);
assertNotNull(response);
assertEquals(200, response.getStatus(),
"Request was not handled correctly, most likely fault in MessageBodyWorker selection.");
} catch (Exception e) {
System.out.println(e.getMessage());
e.printStackTrace();
fail("Request was not handled correctly, most likely fault in MessageBodyWorker selection.");
}
assertTrue(MyByteArrayProvider.counter == 2); // used to read and write entity on server side.
}
@Produces({"application/octet-stream", "*/*"})
@Consumes({"application/octet-stream", "*/*"})
public static final class MyByteArrayProvider extends AbstractMessageReaderWriterProvider<byte[]> {
public static int counter = 0;
@Override
public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return type == byte[].class;
}
@Override
public byte[] readFrom(
Class<byte[]> type,
Type genericType,
Annotation annotations[],
MediaType mediaType,
MultivaluedMap<String, String> httpHeaders,
InputStream entityStream) throws IOException {
ByteArrayOutputStream out = new ByteArrayOutputStream();
ReaderWriter.writeTo(entityStream, out);
counter++;
return out.toByteArray();
}
@Override
public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return type == byte[].class;
}
@Override
public void writeTo(
byte[] t,
Class<?> type,
Type genericType,
Annotation annotations[],
MediaType mediaType,
MultivaluedMap<String, Object> httpHeaders,
OutputStream entityStream) throws IOException {
counter++;
entityStream.write(t);
}
@Override
public long getSize(byte[] t, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return t.length;
}
}
}