org.jooby.hbv.Hbv Maven / Gradle / Ivy
The newest version!
/**
* Apache License
* Version 2.0, January 2004
* http://www.apache.org/licenses/
*
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*
* 1. Definitions.
*
* "License" shall mean the terms and conditions for use, reproduction,
* and distribution as defined by Sections 1 through 9 of this document.
*
* "Licensor" shall mean the copyright owner or entity authorized by
* the copyright owner that is granting the License.
*
* "Legal Entity" shall mean the union of the acting entity and all
* other entities that control, are controlled by, or are under common
* control with that entity. For the purposes of this definition,
* "control" means (i) the power, direct or indirect, to cause the
* direction or management of such entity, whether by contract or
* otherwise, or (ii) ownership of fifty percent (50%) or more of the
* outstanding shares, or (iii) beneficial ownership of such entity.
*
* "You" (or "Your") shall mean an individual or Legal Entity
* exercising permissions granted by this License.
*
* "Source" form shall mean the preferred form for making modifications,
* including but not limited to software source code, documentation
* source, and configuration files.
*
* "Object" form shall mean any form resulting from mechanical
* transformation or translation of a Source form, including but
* not limited to compiled object code, generated documentation,
* and conversions to other media types.
*
* "Work" shall mean the work of authorship, whether in Source or
* Object form, made available under the License, as indicated by a
* copyright notice that is included in or attached to the work
* (an example is provided in the Appendix below).
*
* "Derivative Works" shall mean any work, whether in Source or Object
* form, that is based on (or derived from) the Work and for which the
* editorial revisions, annotations, elaborations, or other modifications
* represent, as a whole, an original work of authorship. For the purposes
* of this License, Derivative Works shall not include works that remain
* separable from, or merely link (or bind by name) to the interfaces of,
* the Work and Derivative Works thereof.
*
* "Contribution" shall mean any work of authorship, including
* the original version of the Work and any modifications or additions
* to that Work or Derivative Works thereof, that is intentionally
* submitted to Licensor for inclusion in the Work by the copyright owner
* or by an individual or Legal Entity authorized to submit on behalf of
* the copyright owner. For the purposes of this definition, "submitted"
* means any form of electronic, verbal, or written communication sent
* to the Licensor or its representatives, including but not limited to
* communication on electronic mailing lists, source code control systems,
* and issue tracking systems that are managed by, or on behalf of, the
* Licensor for the purpose of discussing and improving the Work, but
* excluding communication that is conspicuously marked or otherwise
* designated in writing by the copyright owner as "Not a Contribution."
*
* "Contributor" shall mean Licensor and any individual or Legal Entity
* on behalf of whom a Contribution has been received by Licensor and
* subsequently incorporated within the Work.
*
* 2. Grant of Copyright License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* copyright license to reproduce, prepare Derivative Works of,
* publicly display, publicly perform, sublicense, and distribute the
* Work and such Derivative Works in Source or Object form.
*
* 3. Grant of Patent License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* (except as stated in this section) patent license to make, have made,
* use, offer to sell, sell, import, and otherwise transfer the Work,
* where such license applies only to those patent claims licensable
* by such Contributor that are necessarily infringed by their
* Contribution(s) alone or by combination of their Contribution(s)
* with the Work to which such Contribution(s) was submitted. If You
* institute patent litigation against any entity (including a
* cross-claim or counterclaim in a lawsuit) alleging that the Work
* or a Contribution incorporated within the Work constitutes direct
* or contributory patent infringement, then any patent licenses
* granted to You under this License for that Work shall terminate
* as of the date such litigation is filed.
*
* 4. Redistribution. You may reproduce and distribute copies of the
* Work or Derivative Works thereof in any medium, with or without
* modifications, and in Source or Object form, provided that You
* meet the following conditions:
*
* (a) You must give any other recipients of the Work or
* Derivative Works a copy of this License; and
*
* (b) You must cause any modified files to carry prominent notices
* stating that You changed the files; and
*
* (c) You must retain, in the Source form of any Derivative Works
* that You distribute, all copyright, patent, trademark, and
* attribution notices from the Source form of the Work,
* excluding those notices that do not pertain to any part of
* the Derivative Works; and
*
* (d) If the Work includes a "NOTICE" text file as part of its
* distribution, then any Derivative Works that You distribute must
* include a readable copy of the attribution notices contained
* within such NOTICE file, excluding those notices that do not
* pertain to any part of the Derivative Works, in at least one
* of the following places: within a NOTICE text file distributed
* as part of the Derivative Works; within the Source form or
* documentation, if provided along with the Derivative Works; or,
* within a display generated by the Derivative Works, if and
* wherever such third-party notices normally appear. The contents
* of the NOTICE file are for informational purposes only and
* do not modify the License. You may add Your own attribution
* notices within Derivative Works that You distribute, alongside
* or as an addendum to the NOTICE text from the Work, provided
* that such additional attribution notices cannot be construed
* as modifying the License.
*
* You may add Your own copyright statement to Your modifications and
* may provide additional or different license terms and conditions
* for use, reproduction, or distribution of Your modifications, or
* for any such Derivative Works as a whole, provided Your use,
* reproduction, and distribution of the Work otherwise complies with
* the conditions stated in this License.
*
* 5. Submission of Contributions. Unless You explicitly state otherwise,
* any Contribution intentionally submitted for inclusion in the Work
* by You to the Licensor shall be under the terms and conditions of
* this License, without any additional terms or conditions.
* Notwithstanding the above, nothing herein shall supersede or modify
* the terms of any separate license agreement you may have executed
* with Licensor regarding such Contributions.
*
* 6. Trademarks. This License does not grant permission to use the trade
* names, trademarks, service marks, or product names of the Licensor,
* except as required for reasonable and customary use in describing the
* origin of the Work and reproducing the content of the NOTICE file.
*
* 7. Disclaimer of Warranty. Unless required by applicable law or
* agreed to in writing, Licensor provides the Work (and each
* Contributor provides its Contributions) on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied, including, without limitation, any warranties or conditions
* of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
* PARTICULAR PURPOSE. You are solely responsible for determining the
* appropriateness of using or redistributing the Work and assume any
* risks associated with Your exercise of permissions under this License.
*
* 8. Limitation of Liability. In no event and under no legal theory,
* whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law (such as deliberate and grossly
* negligent acts) or agreed to in writing, shall any Contributor be
* liable to You for damages, including any direct, indirect, special,
* incidental, or consequential damages of any character arising as a
* result of this License or out of the use or inability to use the
* Work (including but not limited to damages for loss of goodwill,
* work stoppage, computer failure or malfunction, or any and all
* other commercial damages or losses), even if such Contributor
* has been advised of the possibility of such damages.
*
* 9. Accepting Warranty or Additional Liability. While redistributing
* the Work or Derivative Works thereof, You may choose to offer,
* and charge a fee for, acceptance of support, warranty, indemnity,
* or other liability obligations and/or rights consistent with this
* License. However, in accepting such obligations, You may act only
* on Your own behalf and on Your sole responsibility, not on behalf
* of any other Contributor, and only if You agree to indemnify,
* defend, and hold each Contributor harmless for any liability
* incurred by, or claims asserted against, such Contributor by reason
* of your accepting any such warranty or additional liability.
*
* END OF TERMS AND CONDITIONS
*
* APPENDIX: How to apply the Apache License to your work.
*
* To apply the Apache License to your work, attach the following
* boilerplate notice, with the fields enclosed by brackets "{}"
* replaced with your own identifying information. (Don't include
* the brackets!) The text should be enclosed in the appropriate
* comment syntax for the file format. We also recommend that a
* file or class name and description of purpose be included on the
* same "printed page" as the copyright notice for easier
* identification within third-party archives.
*
* Copyright 2014 Edgar Espina
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jooby.hbv;
import static java.util.Objects.requireNonNull;
import static javax.validation.Validation.byProvider;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Predicate;
import javax.validation.ConstraintValidatorFactory;
import javax.validation.ConstraintViolationException;
import javax.validation.ValidationException;
import javax.validation.Validator;
import org.hibernate.validator.HibernateValidator;
import org.hibernate.validator.HibernateValidatorConfiguration;
import org.jooby.Env;
import org.jooby.Jooby;
import org.jooby.Parser;
import org.jooby.Request;
import com.google.inject.Binder;
import com.google.inject.TypeLiteral;
import com.google.inject.multibindings.Multibinder;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
import com.typesafe.config.ConfigValueFactory;
/**
* Bean validation via Hibernate Validator.
*
* exposes
*
* - a {@link Validator},
* - a {@link HibernateValidatorConfiguration} and
* - a {@link Parser}
*
*
* usage
*
*
* {
* use(new Hbv());
*
* get("/", req {@literal ->} {
* Validator validator = req.require(Validator.class);
* Car car = req.params().to(Car.class);
* Set<ConstraintViolation> violations = validator.validate(car);
* if (violations.size() {@literal >} 0) {
* // handle errors
* ...
* }
* });
* }
*
*
* automatic validations of HTTP params and body
*
* Previous example demonstrate how to manually validate a bean created via:
* {@link Request#params()} or {@link Request#body()}. The boilerplate code can be avoided if you
* explicitly tell the validation module which classes require validation.
*
* The previous example can be rewritten as:
*
*
* {
* use(new Hbv(Car.class));
*
* get("/", () {@literal ->} {
* Car car = req.params().to(Car.class);
* // a valid car is here
* ...
* });
* }
*
*
* Here a {@link Parser} will do the boilerplate part and throws
* a {@link ConstraintViolationException}.
*
* rendering a ConstraintViolationException
*
* The default err handler will render the {@link ConstraintViolationException} without problem, but
* suppose we have a JavaScript client and want to display the errors in a friendly way.
*
*
* {
* use(new Jackson()); // JSON renderer
*
* use(new Hbv(Car.class)); // Validate Car objects
*
* err((req, rsp, err) {@literal ->} {
* Throwable cause = err.getCause();
* if (cause instanceof ConstraintViolationException) {
* Set<ConstraintViolation<?>> constraints =
* ((ConstraintViolationException) cause) .getConstraintViolations();
*
* Map<Path, String> errors = constraints.stream()
* .collect(Collectors.toMap(
* ConstraintViolation::getPropertyPath,
* ConstraintViolation::getMessage
* ));
* rsp.send(errors);
* }
* });
*
* get("/", () {@literal ->} {
* Car car = req.params().to(Car.class);
* // a valid car is here
* ...
* });
* }
*
*
* The call to rsp.send(errors); will be rendered by ```Jackson``` (or any other that
* applies) and will produces a more friendly response, here it will be a JavaScript object with the
* errors.
*
* constraint validator factory
*
* {@link ConstraintValidatorFactory} is the extension point for customizing how constraint
* validators are instantiated and released.
*
* In Jooby, a {@link ConstraintValidatorFactory} is powered by Guice.
*
* configuration
*
* Any property defined at hibernate.validator will be add it automatically:
*
* application.conf:
*
*
* hibernate.validator.fail_fast = true
*
*
* Or programmatically:
*
*
* {
* use(new Hbv().doWith(config {@literal ->} {
* config.failFast(true);
* }));
* }
*
*
* @author edgar
* @since 0.6.0
*/
public class Hbv implements Jooby.Module {
private final Predicate> predicate;
private BiConsumer configurer;
/**
* Creates a new {@link Hbv} module.
*
* @param predicate A predicate to test if a class require validation or not.
*/
public Hbv(final Predicate> predicate) {
this.predicate = requireNonNull(predicate, "Predicate is required.");
}
/**
* Creates a new {@link Hbv} module.
*
* @param classes List of classes that require validation.
*/
public Hbv(final Class... classes) {
this(typeIs(classes));
}
/**
* Creates a new {@link Hbv} module. No automatic validation is applied.
*/
public Hbv() {
this(none());
}
/**
* Setup a configurer callback.
*
* @param configurer Configurer callback.
* @return This module.
*/
public Hbv doWith(final Consumer configurer) {
requireNonNull(configurer, "Configurer callback is required.");
this.configurer = (hvc, conf) -> configurer.accept(hvc);
return this;
}
/**
* Setup a configurer callback.
*
* @param configurer Configurer callback.
* @return This module.
*/
public Hbv doWith(final BiConsumer configurer) {
this.configurer = requireNonNull(configurer, "Configurer callback is required.");
return this;
}
@Override
public void configure(final Env env, final Config config, final Binder binder) {
HibernateValidatorConfiguration configuration = byProvider(HibernateValidator.class)
.configure();
if (config.hasPath("hibernate.validator")) {
config.getConfig("hibernate.validator").root().forEach((k, v) -> configuration.addProperty("hibernate.validator." + k, v.unwrapped().toString()));
}
if (configurer != null) {
configurer.accept(configuration, config);
}
binder.bind(HibernateValidatorConfiguration.class).toInstance(configuration);
binder.bind(Validator.class).toProvider(HbvFactory.class).asEagerSingleton();
env.lifeCycle(HbvFactory.class);
Multibinder.newSetBinder(binder, Parser.class).addBinding()
.toInstance(new HbvParser(predicate));
}
@Override
public Config config() {
return ConfigFactory.empty(Hbv.class.getName())
.withValue("err." + ValidationException.class.getName(),
ConfigValueFactory.fromAnyRef(400));
}
static Predicate> typeIs(final Class[] classes) {
return type -> {
Class it = type.getRawType();
for (Class klass : classes) {
if (it.isAssignableFrom(klass)) {
return true;
}
}
return false;
};
}
static Predicate> none() {
return type -> false;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy