Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support more optionals #4783

Merged
merged 3 commits into from
Jul 26, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,16 @@
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.security.AccessController;
import java.text.ParseException;
import java.util.Date;
import java.util.List;
import java.util.Optional;
import java.util.OptionalDouble;
import java.util.OptionalInt;
import java.util.OptionalLong;

import javax.inject.Inject;
import javax.inject.Singleton;
Expand Down Expand Up @@ -252,16 +256,16 @@ public String toString(final T value) throws IllegalArgumentException {

/**
* Provider of {@link ParamConverter param converter} that produce the Optional instance
* by invoking {@link AggregatedProvider}.
* by invoking {@link ParamConverterProvider}.
*/
@Singleton
public static class OptionalProvider implements ParamConverterProvider {
public static class OptionalCustomProvider implements ParamConverterProvider {

// Delegates to this provider when the type of Optional is extracted.
private final InjectionManager manager;

@Inject
public OptionalProvider(InjectionManager manager) {
public OptionalCustomProvider(InjectionManager manager) {
this.manager = manager;
}

Expand Down Expand Up @@ -305,6 +309,125 @@ public String toString(T value) throws IllegalArgumentException {

}

/**
* Provider of {@link ParamConverter param converter} that produce the Optional instance
* by invoking {@link AggregatedProvider}.
*/
@Singleton
public static class OptionalProvider implements ParamConverterProvider {

// Delegates to this provider when the type of Optional is extracted.
private final AggregatedProvider aggregated;

@Inject
public OptionalProvider(AggregatedProvider aggregated) {
this.aggregated = aggregated;
}

@Override
public <T> ParamConverter<T> getConverter(Class<T> rawType, Type genericType, Annotation[] annotations) {
final Optionals optionals = Optionals.getOptional(rawType);
return (optionals == null) ? null : new ParamConverter<T>() {

@Override
public T fromString(String value) {
if (value == null) {
return (T) optionals.empty();
} else {
if (genericType instanceof ParameterizedType) {
// Optional is parameterized
ParameterizedType parametrized = (ParameterizedType) genericType;
Type type = parametrized.getActualTypeArguments()[0];
T val = aggregated.getConverter((Class<T>) type, type, annotations).fromString(value.toString());
if (val != null) {
return (T) optionals.of(val);
} else {
/*
* In this case we don't send Optional.empty() because 'value' is not null.
* But we return null because the provider didn't find how to parse it.
*/
return null;
}
} else {
// Others are not parameterized
return (T) optionals.of(value);
}
}
}

@Override
public String toString(T value) throws IllegalArgumentException {
/*
* Unfortunately 'orElse' cannot be stored in an Optional. As only one value can
* be stored, it makes no sense that 'value' is Optional. It can just be the value.
* We don't fail here but we don't process it.
*/
return null;
}
};
}

private static enum Optionals {

OPTIONAL(Optional.class) {
@Override
Object empty() {
return Optional.empty();
}
@Override
Object of(Object value) {
return Optional.of(value);
}
}, OPTIONAL_INT(OptionalInt.class) {
@Override
Object empty() {
return OptionalInt.empty();
}
@Override
Object of(Object value) {
return OptionalInt.of(Integer.parseInt((String) value));
}
}, OPTIONAL_DOUBLE(OptionalDouble.class) {
@Override
Object empty() {
return OptionalDouble.empty();
}
@Override
Object of(Object value) {
return OptionalDouble.of(Double.parseDouble((String) value));
}
}, OPTIONAL_LONG(OptionalLong.class) {
@Override
Object empty() {
return OptionalLong.empty();
}
@Override
Object of(Object value) {
return OptionalLong.of(Long.parseLong((String) value));
}
};

private final Class<?> clazz;

private Optionals(Class<?> clazz) {
this.clazz = clazz;
}

private static Optionals getOptional(Class<?> clazz) {
for (Optionals optionals : Optionals.values()) {
if (optionals.clazz == clazz) {
return optionals;
}
}
return null;
}

abstract Object empty();

abstract Object of(Object value);
}
}

/**
* Aggregated {@link ParamConverterProvider param converter provider}.
*/
Expand All @@ -326,7 +449,8 @@ public AggregatedProvider(InjectionManager manager) {
new CharacterProvider(),
new TypeFromString(),
new StringConstructor(),
new OptionalProvider(manager)
new OptionalCustomProvider(manager),
new OptionalProvider(this)
};
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
/*
* Copyright (c) 2021 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.server;

import static org.junit.Assert.assertEquals;

import java.util.List;
import java.util.Optional;
import java.util.OptionalDouble;
import java.util.OptionalInt;
import java.util.OptionalLong;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Application;
import javax.ws.rs.core.Response;

import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.Test;

public class OptionalParamConverterNoProviderTest extends JerseyTest {

private static final String PARAM_NAME = "paramName";

@Path("/OptionalResource")
public static class OptionalResource {

@GET
@Path("/fromString")
public Response fromString(@QueryParam(PARAM_NAME) Optional<String> data) {
return Response.ok(data.orElse("")).build();
}

@GET
@Path("/fromInteger")
public Response fromInteger(@QueryParam(PARAM_NAME) Optional<Integer> data) {
return Response.ok(data.orElse(0)).build();
}

@GET
@Path("/fromList")
public Response fromList(@QueryParam(PARAM_NAME) List<Optional<Integer>> data) {
StringBuilder builder = new StringBuilder("");
for (Optional<Integer> val : data) {
builder.append(val.orElse(0));
}
return Response.ok(builder.toString()).build();
}

@GET
@Path("/fromInteger2")
public Response fromInteger2(@QueryParam(PARAM_NAME) OptionalInt data) {
return Response.ok(data.orElse(0)).build();
}

@GET
@Path("/fromLong")
public Response fromLong(@QueryParam(PARAM_NAME) OptionalLong data) {
return Response.ok(data.orElse(0)).build();
}

@GET
@Path("/fromDouble")
public Response fromDouble(@QueryParam(PARAM_NAME) OptionalDouble data) {
return Response.ok(data.orElse(0.1)).build();
}
}

@Override
protected Application configure() {
return new ResourceConfig(OptionalResource.class);
}

@Test
public void fromOptionalStr() {
Response empty = target("/OptionalResource/fromString").request().get();
Response notEmpty = target("/OptionalResource/fromString").queryParam(PARAM_NAME, "anyValue").request().get();
assertEquals(200, empty.getStatus());
assertEquals("", empty.readEntity(String.class));
assertEquals(200, notEmpty.getStatus());
assertEquals("anyValue", notEmpty.readEntity(String.class));
}

@Test
public void fromOptionalInt() {
Response empty = target("/OptionalResource/fromInteger").request().get();
Response notEmpty = target("/OptionalResource/fromInteger").queryParam(PARAM_NAME, 1).request().get();
assertEquals(200, empty.getStatus());
assertEquals(Integer.valueOf(0), empty.readEntity(Integer.class));
assertEquals(200, notEmpty.getStatus());
assertEquals(Integer.valueOf(1), notEmpty.readEntity(Integer.class));
}

@Test
public void fromOptionalInt2() {
Response empty = target("/OptionalResource/fromInteger2").request().get();
Response notEmpty = target("/OptionalResource/fromInteger2").queryParam(PARAM_NAME, 1).request().get();
assertEquals(200, empty.getStatus());
assertEquals(Integer.valueOf(0), empty.readEntity(Integer.class));
assertEquals(200, notEmpty.getStatus());
assertEquals(Integer.valueOf(1), notEmpty.readEntity(Integer.class));
}

@Test
public void fromOptionalList() {
Response empty = target("/OptionalResource/fromList").request().get();
Response notEmpty = target("/OptionalResource/fromList").queryParam(PARAM_NAME, 1)
.queryParam(PARAM_NAME, 2).request().get();
assertEquals(200, empty.getStatus());
assertEquals("", empty.readEntity(String.class));
assertEquals(200, notEmpty.getStatus());
assertEquals("12", notEmpty.readEntity(String.class));
}

@Test
public void fromOptionalLong() {
Response empty = target("/OptionalResource/fromLong").request().get();
Response notEmpty = target("/OptionalResource/fromLong").queryParam(PARAM_NAME, 1L).request().get();
assertEquals(200, empty.getStatus());
assertEquals(Long.valueOf(0L), empty.readEntity(Long.class));
assertEquals(200, notEmpty.getStatus());
assertEquals(Long.valueOf(1L), notEmpty.readEntity(Long.class));
}

@Test
public void fromOptionalDouble() {
Response empty = target("/OptionalResource/fromDouble").request().get();
Response notEmpty = target("/OptionalResource/fromDouble").queryParam(PARAM_NAME, 1.1).request().get();
assertEquals(200, empty.getStatus());
assertEquals(Double.valueOf(0.1), empty.readEntity(Double.class));
assertEquals(200, notEmpty.getStatus());
assertEquals(Double.valueOf(1.1), notEmpty.readEntity(Double.class));
}
}