org.primefaces.validate.bean.BeanValidationMetadataMapper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation
Show all versions of primefaces Show documentation
PrimeFaces is one of the most popular UI libraries in Java EE Ecosystem and widely used by software companies, world renowned brands, banks, financial institutions, insurance companies, universities and more.
/**
* The MIT License
*
* Copyright (c) 2009-2019 PrimeTek
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.primefaces.validate.bean;
import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.el.PropertyNotFoundException;
import javax.faces.FacesException;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.validation.MessageInterpolator;
import javax.validation.constraints.AssertFalse;
import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.DecimalMax;
import javax.validation.constraints.DecimalMin;
import javax.validation.constraints.Digits;
import javax.validation.constraints.Future;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Null;
import javax.validation.constraints.Past;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import javax.validation.metadata.ConstraintDescriptor;
import org.primefaces.context.PrimeApplicationContext;
import org.primefaces.metadata.BeanValidationMetadataExtractor;
import org.primefaces.util.MapBuilder;
public class BeanValidationMetadataMapper {
private static final Logger LOGGER = Logger.getLogger(BeanValidationMetadataMapper.class.getName());
private static final Map, ClientValidationConstraint> CONSTRAINT_MAPPING
= MapBuilder., ClientValidationConstraint>builder()
.put(NotNull.class, new NotNullClientValidationConstraint())
.put(Null.class, new NullClientValidationConstraint())
.put(Size.class, new SizeClientValidationConstraint())
.put(Min.class, new MinClientValidationConstraint())
.put(Max.class, new MaxClientValidationConstraint())
.put(DecimalMin.class, new DecimalMinClientValidationConstraint())
.put(DecimalMax.class, new DecimalMaxClientValidationConstraint())
.put(AssertTrue.class, new AssertTrueClientValidationConstraint())
.put(AssertFalse.class, new AssertFalseClientValidationConstraint())
.put(Digits.class, new DigitsClientValidationConstraint())
.put(Past.class, new PastClientValidationConstraint())
.put(Future.class, new FutureClientValidationConstraint())
.put(Pattern.class, new PatternClientValidationConstraint())
.build();
private BeanValidationMetadataMapper() {
}
public static BeanValidationMetadata resolveValidationMetadata(FacesContext context, UIComponent component, PrimeApplicationContext applicationContext)
throws IOException {
Map metadata = null;
List validatorIds = null;
try {
// get BV ConstraintDescriptors
Set> constraints = BeanValidationMetadataExtractor.extractAllConstraintDescriptors(
context, applicationContext, component.getValueExpression("value"));
if (constraints != null && !constraints.isEmpty()) {
boolean interpolateClientSideValidationMessages =
applicationContext.getConfig().isInterpolateClientSideValidationMessages();
MessageInterpolator messageInterpolator = null;
if (interpolateClientSideValidationMessages) {
messageInterpolator = applicationContext.getValidatorFactory().getMessageInterpolator();
}
// loop BV ConstraintDescriptors
for (ConstraintDescriptor constraintDescriptor : constraints) {
Class annotationType = constraintDescriptor.getAnnotation().annotationType();
// lookup ClientValidationConstraint by constraint annotation (e.g. @NotNull)
ClientValidationConstraint clientValidationConstraint = CONSTRAINT_MAPPING.get(annotationType);
// mapping available? Otherwise try to lookup custom constraint
if (clientValidationConstraint == null) {
// custom constraint must use @ClientConstraint to map the ClientValidationConstraint
ClientConstraint clientConstraint = annotationType.getAnnotation(ClientConstraint.class);
if (clientConstraint != null) {
Class resolvedBy = clientConstraint.resolvedBy();
if (resolvedBy != null) {
try {
// TODO AppScoped instances? CDI?
// instantiate ClientValidationConstraint
clientValidationConstraint = (ClientValidationConstraint) resolvedBy.newInstance();
}
catch (Exception e) {
throw new FacesException("Could not instantiate ClientValidationConstraint!", e);
}
}
}
}
if (clientValidationConstraint != null) {
String validatorId = clientValidationConstraint.getValidatorId();
Map constraintMetadata;
if (interpolateClientSideValidationMessages) {
MessageInterpolatingConstraintWrapper interpolatingConstraint
= new MessageInterpolatingConstraintWrapper(messageInterpolator, constraintDescriptor);
constraintMetadata = clientValidationConstraint.getMetadata(interpolatingConstraint);
}
else {
constraintMetadata = clientValidationConstraint.getMetadata(constraintDescriptor);
}
if (constraintMetadata != null) {
if (metadata == null) {
metadata = new HashMap<>();
}
metadata.putAll(constraintMetadata);
}
if (validatorId != null) {
if (validatorIds == null) {
validatorIds = new ArrayList<>();
}
validatorIds.add(validatorId);
}
}
}
}
}
catch (PropertyNotFoundException e) {
String message = "Skip resolving of CSV BV metadata for component \"" + component.getClientId(context) + "\" because"
+ " the ValueExpression of the \"value\" attribute"
+ " isn't resolvable completely (e.g. a sub-expression returns null)";
LOGGER.log(Level.FINE, message);
}
if (metadata == null && validatorIds == null) {
return null;
}
return new BeanValidationMetadata(metadata, validatorIds);
}
public static void registerConstraintMapping(Class constraint, ClientValidationConstraint clientValidationConstraint) {
CONSTRAINT_MAPPING.put(constraint, clientValidationConstraint);
}
public static ClientValidationConstraint removeConstraintMapping(Class constraint) {
return CONSTRAINT_MAPPING.remove(constraint);
}
}