-
Notifications
You must be signed in to change notification settings - Fork 339
/
ValidationBinder.java
306 lines (256 loc) · 12.8 KB
/
ValidationBinder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
/*
* Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2018, 2019 Payara Foundation 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.server.validation.internal;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.ArrayList;
import java.util.List;
import java.util.WeakHashMap;
import java.util.function.Supplier;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.ws.rs.container.ResourceContext;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.ExceptionMapper;
import javax.ws.rs.ext.MessageBodyWriter;
import javax.ws.rs.ext.Providers;
import javax.inject.Inject;
import javax.inject.Singleton;
import javax.validation.Configuration;
import javax.validation.TraversableResolver;
import javax.validation.Validation;
import javax.validation.ValidationException;
import javax.validation.ValidationProviderResolver;
import javax.validation.Validator;
import javax.validation.ValidatorContext;
import javax.validation.ValidatorFactory;
import javax.validation.spi.ValidationProvider;
import org.glassfish.jersey.internal.ServiceFinder;
import org.glassfish.jersey.internal.inject.AbstractBinder;
import org.glassfish.jersey.internal.inject.InjectionManager;
import org.glassfish.jersey.internal.util.PropertiesHelper;
import org.glassfish.jersey.internal.util.ReflectionHelper;
import org.glassfish.jersey.model.internal.RankedComparator;
import org.glassfish.jersey.model.internal.RankedProvider;
import org.glassfish.jersey.server.ServerProperties;
import org.glassfish.jersey.server.internal.inject.ConfiguredValidator;
import org.glassfish.jersey.server.spi.ValidationInterceptor;
import org.glassfish.jersey.server.validation.ValidationConfig;
/**
* Bean Validation provider injection binder.
*
* @author Michal Gajdos
*/
public final class ValidationBinder extends AbstractBinder {
private static final Logger LOGGER = Logger.getLogger(ValidationBinder.class.getName());
@Override
protected void configure() {
bindFactory(DefaultConfigurationProvider.class, Singleton.class).to(Configuration.class).in(Singleton.class);
bindFactory(DefaultValidatorFactoryProvider.class, Singleton.class).to(ValidatorFactory.class).in(Singleton.class);
bindFactory(DefaultValidatorProvider.class, Singleton.class).to(Validator.class).in(Singleton.class);
bindFactory(ConfiguredValidatorProvider.class, Singleton.class).to(ConfiguredValidator.class);
// Custom Exception Mapper and Writer - registering in binder to make possible for users register their own providers.
bind(ValidationExceptionMapper.class).to(ExceptionMapper.class).in(Singleton.class);
bind(ValidationErrorMessageBodyWriter.class).to(MessageBodyWriter.class).in(Singleton.class);
}
/**
* Factory providing default {@link javax.validation.Configuration} instance.
*/
private static class DefaultConfigurationProvider implements Supplier<Configuration> {
private final boolean inOsgi;
public DefaultConfigurationProvider() {
this.inOsgi = ReflectionHelper.getOsgiRegistryInstance() != null;
}
@Override
public Configuration get() {
try {
if (!inOsgi) {
return Validation.byDefaultProvider().configure();
} else {
return Validation
.byDefaultProvider()
.providerResolver(new ValidationProviderResolver() {
@Override
public List<ValidationProvider<?>> getValidationProviders() {
final List<ValidationProvider<?>> validationProviders = new ArrayList<>();
for (final ValidationProvider validationProvider : ServiceFinder
.find(ValidationProvider.class)) {
validationProviders.add(validationProvider);
}
return validationProviders;
}
})
.configure();
}
} catch (final ValidationException e) {
// log and re-trow
LOGGER.log(Level.FINE, LocalizationMessages.VALIDATION_EXCEPTION_PROVIDER(), e);
throw e;
}
}
}
/**
* Factory providing default (un-configured) {@link ValidatorFactory} instance.
*/
private static class DefaultValidatorFactoryProvider implements Supplier<ValidatorFactory> {
@Inject
private Configuration config;
@Override
public ValidatorFactory get() {
return config.buildValidatorFactory();
}
}
/**
* Factory providing default (un-configured) {@link Validator} instance.
*/
private static class DefaultValidatorProvider implements Supplier<Validator> {
@Inject
private ValidatorFactory factory;
@Override
public Validator get() {
return factory.getValidator();
}
}
/**
* Factory providing configured {@link Validator} instance.
*/
private static class ConfiguredValidatorProvider implements Supplier<ConfiguredValidator> {
@Inject
private InjectionManager injectionManager;
@Inject
private Configuration validationConfig;
@Inject
private ValidatorFactory factory;
@Context
private javax.ws.rs.core.Configuration jaxRsConfig;
@Context
private Providers providers;
@Context
private ResourceContext resourceContext;
private ConfiguredValidator defaultValidator;
private final WeakHashMap<ContextResolver<ValidationConfig>, ConfiguredValidator> validatorCache =
new WeakHashMap<>();
@Override
public ConfiguredValidator get() {
// Custom Configuration.
final ContextResolver<ValidationConfig> contextResolver =
providers.getContextResolver(ValidationConfig.class, MediaType.WILDCARD_TYPE);
if (contextResolver == null) {
return getDefaultValidator();
} else {
if (!validatorCache.containsKey(contextResolver)) {
final ValidateOnExecutionHandler validateOnExecutionHandler =
new ValidateOnExecutionHandler(validationConfig, !isValidateOnExecutableOverrideCheckDisabled());
final ValidatorContext context = getDefaultValidatorContext(validateOnExecutionHandler);
final ValidationConfig config = contextResolver.getContext(ValidationConfig.class);
if (config != null) {
// MessageInterpolator
if (config.getMessageInterpolator() != null) {
context.messageInterpolator(config.getMessageInterpolator());
}
// TraversableResolver
if (config.getTraversableResolver() != null) {
context.traversableResolver(
getTraversableResolver(config.getTraversableResolver(), validateOnExecutionHandler));
}
// ConstraintValidatorFactory
if (config.getConstraintValidatorFactory() != null) {
context.constraintValidatorFactory(config.getConstraintValidatorFactory());
}
// ParameterNameProvider
if (config.getParameterNameProvider() != null) {
context.parameterNameProvider(config.getParameterNameProvider());
}
}
validatorCache.put(contextResolver,
new DefaultConfiguredValidator(context.getValidator(), this.validationConfig,
validateOnExecutionHandler, getValidationInterceptors()));
}
return validatorCache.get(contextResolver);
}
}
private Iterable<ValidationInterceptor> getValidationInterceptors() {
final Iterable<RankedProvider<ValidationInterceptor>> validationInterceptorIterable =
org.glassfish.jersey.internal.inject.Providers
.getAllRankedProviders(injectionManager, ValidationInterceptor.class);
return org.glassfish.jersey.internal.inject.Providers.sortRankedProviders(
new RankedComparator<ValidationInterceptor>(), validationInterceptorIterable);
}
/**
* Return default validator.
*
* @return default validator.
*/
private ConfiguredValidator getDefaultValidator() {
if (defaultValidator == null) {
final ValidateOnExecutionHandler validateOnExecutionHandler =
new ValidateOnExecutionHandler(validationConfig, !isValidateOnExecutableOverrideCheckDisabled());
final Validator validator = getDefaultValidatorContext(validateOnExecutionHandler).getValidator();
defaultValidator = new DefaultConfiguredValidator(validator, validationConfig,
validateOnExecutionHandler, getValidationInterceptors());
}
return defaultValidator;
}
/**
* Return default {@link ValidatorContext validator context} able to inject JAX-RS resources/providers.
*
* @param handler handler to create traversable resolver for.
* @return default validator context.
*/
private ValidatorContext getDefaultValidatorContext(final ValidateOnExecutionHandler handler) {
final ValidatorContext context = factory.usingContext();
// if CDI is available use composite factiry
if (AccessController.doPrivileged(
ReflectionHelper.classForNamePA("javax.enterprise.inject.spi.BeanManager")) != null) {
// Composite Configuration - due to PAYARA-2491
// https://github.com/payara/Payara/issues/2245
context.constraintValidatorFactory(resourceContext.getResource(
CompositeInjectingConstraintValidatorFactory.class));
} else {
// Default Configuration.
context.constraintValidatorFactory(resourceContext.getResource(InjectingConstraintValidatorFactory.class));
}
// Traversable Resolver.
context.traversableResolver(getTraversableResolver(factory.getTraversableResolver(), handler));
return context;
}
/**
* Create traversable resolver able to process {@link javax.validation.executable.ValidateOnExecution} annotation on
* beans.
*
* @param delegate resolver to be wrapped into the custom traversable resolver.
* @param handler handler to create traversable resolver for.
* @return custom traversable resolver.
*/
private ValidateOnExecutionTraversableResolver getTraversableResolver(TraversableResolver delegate,
final ValidateOnExecutionHandler handler) {
if (delegate == null) {
delegate = validationConfig.getDefaultTraversableResolver();
}
final boolean validationEnabled = validationConfig.getBootstrapConfiguration().isExecutableValidationEnabled();
final ValidateOnExecutionTraversableResolver traversableResolver = new
ValidateOnExecutionTraversableResolver(delegate, handler, validationEnabled);
return resourceContext.initResource(traversableResolver);
}
private boolean isValidateOnExecutableOverrideCheckDisabled() {
return PropertiesHelper.isProperty(
jaxRsConfig.getProperty(ServerProperties.BV_DISABLE_VALIDATE_ON_EXECUTABLE_OVERRIDE_CHECK));
}
}
}