Skip to content

Commit a9c6925

Browse files
jansupoljansupol
committed
Enable @ConstrainedTo on Features
Signed-off-by: Jan Supol <jan.supol@oracle.com>
1 parent 7c07f3f commit a9c6925

File tree

3 files changed

+226
-11
lines changed

3 files changed

+226
-11
lines changed

‎core-common/src/main/java/org/glassfish/jersey/model/internal/CommonConfig.java

+31-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2012, 2019 Oracle and/or its affiliates. All rights reserved.
33
*
44
* This program and the accompanying materials are made available under the
55
* terms of the Eclipse Public License v. 2.0, which is available at
@@ -106,37 +106,55 @@ private static final class FeatureRegistration {
106106

107107
private final Class<? extends Feature> featureClass;
108108
private final Feature feature;
109+
private final RuntimeType runtimeType;
109110

110111
private FeatureRegistration(final Class<? extends Feature> featureClass) {
111112
this.featureClass = featureClass;
112113
this.feature = null;
114+
final ConstrainedTo runtimeTypeConstraint = featureClass.getAnnotation(ConstrainedTo.class);
115+
this.runtimeType = runtimeTypeConstraint == null ? null : runtimeTypeConstraint.value();
113116
}
114117

115118
private FeatureRegistration(final Feature feature) {
116119
this.featureClass = feature.getClass();
117120
this.feature = feature;
121+
final ConstrainedTo runtimeTypeConstraint = featureClass.getAnnotation(ConstrainedTo.class);
122+
this.runtimeType = runtimeTypeConstraint == null ? null : runtimeTypeConstraint.value();
118123
}
119124

120125
/**
121126
* Get the registered feature class.
122127
*
123128
* @return registered feature class.
124129
*/
125-
Class<? extends Feature> getFeatureClass() {
130+
private Class<? extends Feature> getFeatureClass() {
126131
return featureClass;
127132
}
128133

134+
135+
129136
/**
130137
* Get the registered feature instance or {@code null} if this is a
131138
* class based feature registration.
132139
*
133140
* @return the registered feature instance or {@code null} if this is a
134141
* class based feature registration.
135142
*/
136-
public Feature getFeature() {
143+
private Feature getFeature() {
137144
return feature;
138145
}
139146

147+
/**
148+
* Get the {@code RuntimeType} constraint given by {@code ConstrainedTo} annotated
149+
* the Feature or {@code null} if not annotated.
150+
*
151+
* @return the {@code RuntimeType} constraint given by {@code ConstrainedTo} annotated
152+
* the Feature or {@code null} if not annotated.
153+
*/
154+
private RuntimeType getFeatureRuntimeType() {
155+
return runtimeType;
156+
}
157+
140158
@Override
141159
public boolean equals(final Object obj) {
142160
if (this == obj) {
@@ -674,13 +692,17 @@ private void configureFeatures(InjectionManager injectionManager,
674692
// init lazily
675693
featureContextWrapper = new FeatureContextWrapper(this, injectionManager);
676694
}
677-
final boolean success = feature.configure(featureContextWrapper);
678695

679-
if (success) {
680-
processed.add(registration);
681-
configureFeatures(injectionManager, processed, resetRegistrations(), managedObjectsFinalizer);
682-
enabledFeatureClasses.add(registration.getFeatureClass());
683-
enabledFeatures.add(feature);
696+
final RuntimeType runtimeTypeConstraint = registration.getFeatureRuntimeType();
697+
if (runtimeTypeConstraint == null || type.equals(runtimeTypeConstraint)) {
698+
final boolean success = feature.configure(featureContextWrapper);
699+
700+
if (success) {
701+
processed.add(registration);
702+
configureFeatures(injectionManager, processed, resetRegistrations(), managedObjectsFinalizer);
703+
enabledFeatureClasses.add(registration.getFeatureClass());
704+
enabledFeatures.add(feature);
705+
}
684706
}
685707
}
686708
}

‎core-server/src/main/java/org/glassfish/jersey/server/internal/inject/WebTargetValueParamProvider.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2012, 2019 Oracle and/or its affiliates. All rights reserved.
33
*
44
* This program and the accompanying materials are made available under the
55
* terms of the Eclipse Public License v. 2.0, which is available at
@@ -287,7 +287,7 @@ private void copyProviders(Configuration source, Configurable<?> target) {
287287
for (Object o : source.getInstances()) {
288288
Class<?> c = o.getClass();
289289
if (!targetConfig.isRegistered(o)) {
290-
target.register(c, source.getContracts(c));
290+
target.register(o, source.getContracts(c));
291291
}
292292
}
293293
}

‎tests/e2e/src/test/java/org/glassfish/jersey/tests/e2e/common/FeatureConstraintTest.java

+193
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
/*
2+
* Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved.
3+
*
4+
* This program and the accompanying materials are made available under the
5+
* terms of the Eclipse Public License v. 2.0, which is available at
6+
* http://www.eclipse.org/legal/epl-2.0.
7+
*
8+
* This Source Code may also be made available under the following Secondary
9+
* Licenses when the conditions for such availability set forth in the
10+
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
11+
* version 2 with the GNU Classpath Exception, which is available at
12+
* https://www.gnu.org/software/classpath/license.html.
13+
*
14+
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15+
*/
16+
17+
package org.glassfish.jersey.tests.e2e.common;
18+
19+
import org.glassfish.jersey.server.ResourceConfig;
20+
import org.glassfish.jersey.server.Uri;
21+
import org.glassfish.jersey.test.JerseyTest;
22+
import org.junit.Test;
23+
24+
import static org.hamcrest.CoreMatchers.is;
25+
import static org.junit.Assert.assertThat;
26+
27+
import javax.ws.rs.ConstrainedTo;
28+
import javax.ws.rs.GET;
29+
import javax.ws.rs.Path;
30+
import javax.ws.rs.RuntimeType;
31+
import javax.ws.rs.client.WebTarget;
32+
import javax.ws.rs.core.Application;
33+
import javax.ws.rs.core.Configuration;
34+
import javax.ws.rs.core.Context;
35+
import javax.ws.rs.core.Feature;
36+
import javax.ws.rs.core.FeatureContext;
37+
import java.util.concurrent.atomic.AtomicInteger;
38+
39+
public class FeatureConstraintTest extends JerseyTest {
40+
41+
public static AtomicInteger clientEnvironmentHitCount = new AtomicInteger(0);
42+
public static AtomicInteger serverEnvironmentHitCount = new AtomicInteger(0);
43+
public static AtomicInteger clientServerEnvironmentHitCount = new AtomicInteger(0);
44+
45+
@Override
46+
protected Application configure() {
47+
return new ResourceConfig(PropagatedConfigResource.class, ServerConstrainedClassFeature.class,
48+
ClientConstrainedClassFeature.class, ClientServerConstrainedClassFeature.class)
49+
.register(new ServerConstrainedInstanceFeature())
50+
.register(new ClientConstrainedInstanceFeature())
51+
.register(new ClientServerConstrainedInstanceFeature());
52+
}
53+
54+
@ConstrainedTo(RuntimeType.SERVER)
55+
public static class ServerConstrainedClassFeature implements Feature {
56+
protected int increment = 10;
57+
@Override
58+
public boolean configure(FeatureContext context) {
59+
if (context.getConfiguration().getRuntimeType().equals(RuntimeType.CLIENT)) {
60+
clientEnvironmentHitCount.set(clientEnvironmentHitCount.get() + increment);
61+
}
62+
return true;
63+
}
64+
}
65+
66+
@ConstrainedTo(RuntimeType.SERVER)
67+
public static class ServerConstrainedInstanceFeature extends ServerConstrainedClassFeature {
68+
{
69+
increment = 100;
70+
}
71+
};
72+
73+
@ConstrainedTo(RuntimeType.CLIENT)
74+
public static class ClientConstrainedClassFeature implements Feature {
75+
protected int increment = 10;
76+
@Override
77+
public boolean configure(FeatureContext context) {
78+
if (context.getConfiguration().getRuntimeType().equals(RuntimeType.SERVER)) {
79+
serverEnvironmentHitCount.set(serverEnvironmentHitCount.get() + increment);
80+
}
81+
return true;
82+
}
83+
}
84+
85+
@ConstrainedTo(RuntimeType.CLIENT)
86+
public static class ClientConstrainedInstanceFeature extends ClientConstrainedClassFeature {
87+
{
88+
increment = 100;
89+
}
90+
};
91+
92+
public static class ClientServerConstrainedClassFeature implements Feature {
93+
protected int increment = 10;
94+
@Override
95+
public boolean configure(FeatureContext context) {
96+
if (context.getConfiguration().getRuntimeType().equals(RuntimeType.SERVER)) {
97+
clientServerEnvironmentHitCount.set(clientServerEnvironmentHitCount.get() + increment);
98+
}
99+
if (context.getConfiguration().getRuntimeType().equals(RuntimeType.CLIENT)) {
100+
clientServerEnvironmentHitCount.set(clientServerEnvironmentHitCount.get() + (100 * increment));
101+
}
102+
return true;
103+
}
104+
}
105+
106+
public static class ClientServerConstrainedInstanceFeature extends ClientServerConstrainedClassFeature {
107+
{
108+
increment = 100;
109+
}
110+
};
111+
112+
@Path("/")
113+
public static class PropagatedConfigResource {
114+
@Uri("/isRegistered")
115+
WebTarget target;
116+
117+
@Path("isRegistered")
118+
@GET
119+
public boolean isRegisteredOnServer(@Context Configuration config) {
120+
return config.isRegistered(ServerConstrainedClassFeature.class)
121+
&& config.isRegistered(ServerConstrainedInstanceFeature.class)
122+
&& config.isRegistered(ClientConstrainedClassFeature.class)
123+
&& config.isRegistered(ClientConstrainedInstanceFeature.class)
124+
&& config.isRegistered(ClientServerConstrainedClassFeature.class)
125+
&& config.isRegistered(ClientServerConstrainedInstanceFeature.class);
126+
}
127+
128+
@Path("isInherited")
129+
@GET
130+
public boolean isInheritedInInjectedClientConfig() {
131+
final Configuration config = target.getConfiguration();
132+
return isRegisteredOnServer(config);
133+
}
134+
135+
@Path("featureConfigurationNotInvoked")
136+
@GET
137+
public boolean featureConfigurationNotInvoked() {
138+
boolean ret = target
139+
.register(ServerConstrainedClassFeature.class)
140+
.register(new ServerConstrainedInstanceFeature())
141+
.register(ClientConstrainedClassFeature.class)
142+
.register(new ClientConstrainedInstanceFeature())
143+
.register(ClientServerConstrainedClassFeature.class)
144+
.register(new ClientServerConstrainedInstanceFeature())
145+
.request().get().readEntity(boolean.class);
146+
return ret;
147+
}
148+
}
149+
150+
@Test
151+
public void test() {
152+
assertThat("*Constrained*Feature must be registered in a server configuration",
153+
target("isRegistered")
154+
.register(ServerConstrainedClassFeature.class)
155+
.register(new ServerConstrainedInstanceFeature())
156+
.register(ClientConstrainedClassFeature.class)
157+
.register(new ClientConstrainedInstanceFeature())
158+
.register(ClientServerConstrainedClassFeature.class)
159+
.register(new ClientServerConstrainedInstanceFeature())
160+
.request().get().readEntity(boolean.class),
161+
is(true));
162+
163+
assertThat("Server Features should not have been configured the Client", clientEnvironmentHitCount.get(), is(0));
164+
assertThat("Client Features should not have been configured the Server", serverEnvironmentHitCount.get(), is(0));
165+
assertThat("ClientSever Features should have been configured", clientServerEnvironmentHitCount.get(), is(11110));
166+
clientServerEnvironmentHitCount.set(0); //reset configuration invoked on a server, it won't happen again
167+
168+
assertThat("*Constrained*Feature must be in an application classes set",
169+
target("isInherited").request().get().readEntity(boolean.class),
170+
is(true));
171+
172+
assertThat("Server Features should not have been configured the Client", clientEnvironmentHitCount.get(), is(0));
173+
assertThat("Client Features should not have been configured the Server", serverEnvironmentHitCount.get(), is(0));
174+
assertThat("ClientSever Features should not have been configured", clientServerEnvironmentHitCount.get(), is(0));
175+
176+
assertThat("ServerConstrainedFeature must be in an application classes set",
177+
target("featureConfigurationNotInvoked")
178+
.register(ServerConstrainedClassFeature.class)
179+
.register(new ServerConstrainedInstanceFeature())
180+
.register(ClientConstrainedClassFeature.class)
181+
.register(new ClientConstrainedInstanceFeature())
182+
.register(ClientServerConstrainedClassFeature.class)
183+
.register(new ClientServerConstrainedInstanceFeature())
184+
.request().get().readEntity(boolean.class),
185+
is(true));
186+
187+
assertThat("Server Features should not have been configured the Client", clientEnvironmentHitCount.get(), is(0));
188+
assertThat("Client Features should not have been configured the Server", serverEnvironmentHitCount.get(), is(0));
189+
assertThat("ClientSever Features should have been configured", clientServerEnvironmentHitCount.get(), is(22000));
190+
}
191+
192+
193+
}

0 commit comments

Comments
 (0)