| <!DOCTYPE html> |
| <html lang="en"> |
| |
| <head> |
| <meta charset="UTF-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <title>Apache TomEE</title> |
| <meta name="description" |
| content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." /> |
| <meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" /> |
| <meta name="author" content="Luka Cvetinovic for Codrops" /> |
| <link rel="icon" href="../../favicon.ico"> |
| <link rel="icon" type="image/png" href="../../favicon.png"> |
| <meta name="msapplication-TileColor" content="#80287a"> |
| <meta name="theme-color" content="#80287a"> |
| <link rel="stylesheet" type="text/css" href="../../css/normalize.css"> |
| <link rel="stylesheet" type="text/css" href="../../css/bootstrap.css"> |
| <link rel="stylesheet" type="text/css" href="../../css/owl.css"> |
| <link rel="stylesheet" type="text/css" href="../../css/animate.css"> |
| <link rel="stylesheet" type="text/css" href="../../fonts/font-awesome-4.1.0/css/font-awesome.min.css"> |
| <link rel="stylesheet" type="text/css" href="../../fonts/eleganticons/et-icons.css"> |
| <link rel="stylesheet" type="text/css" href="../../css/jqtree.css"> |
| <link rel="stylesheet" type="text/css" href="../../css/idea.css"> |
| <link rel="stylesheet" type="text/css" href="../../css/cardio.css"> |
| |
| <script type="text/javascript"> |
| <!-- Matomo --> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function () { |
| var u = "//matomo.privacy.apache.org/"; |
| _paq.push(['setTrackerUrl', u + 'matomo.php']); |
| _paq.push(['setSiteId', '5']); |
| var d = document, g = d.createElement('script'), s = d.getElementsByTagName('script')[0]; |
| g.async = true; |
| g.src = u + 'matomo.js'; |
| s.parentNode.insertBefore(g, s); |
| })(); |
| <!-- End Matomo Code --> |
| </script> |
| </head> |
| |
| <body> |
| <div class="preloader"> |
| <img src="../../img/loader.gif" alt="Preloader image"> |
| </div> |
| <nav class="navbar"> |
| <div class="container"> |
| <div class="row"> <div class="col-md-12"> |
| |
| <!-- Brand and toggle get grouped for better mobile display --> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="/" title="Apache TomEE"> |
| <span> |
| |
| |
| <img |
| src="../../img/apache_tomee-logo.svg" |
| onerror="this.src='../../img/apache_tomee-logo.jpg'" |
| height="50" |
| > |
| |
| |
| </span> |
| </a> |
| </div> |
| <!-- Collect the nav links, forms, and other content for toggling --> |
| <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> |
| <ul class="nav navbar-nav navbar-right main-nav"> |
| <li><a href="../../docs.html">Documentation</a></li> |
| <li><a href="../../community/index.html">Community</a></li> |
| <li><a href="../../security/security.html">Security</a></li> |
| <li><a class="btn btn-accent accent-orange no-shadow" href="../../download.html">Downloads</a></li> |
| </ul> |
| </div> |
| <!-- /.navbar-collapse --> |
| </div></div> |
| </div> |
| <!-- /.container-fluid --> |
| </nav> |
| |
| |
| <div id="main-block" class="container main-block"> |
| <div class="row title"> |
| <div class="col-md-12"> |
| <div class='page-header'> |
| |
| <h1>null</h1> |
| </div> |
| </div> |
| </div> |
| <div class="row"> |
| |
| <div class="col-md-12"> |
| <h1>Bean Validation - Design By Contract</h1> |
| <p>Bean Validation (aka JSR 303) contains an optional appendix dealing with method validation.</p> |
| <p>Some implementions of this JSR implement this appendix (Apache bval, Hibernate validator for example).</p> |
| <p>OpenEJB provides an interceptor which allows you to use this feature to do design by contract.</p> |
| <h1>Design by contract</h1> |
| <p>The goal is to be able to configure with a finer grain your contract. In the example you specify the minimum centimeters a sport man should jump at pole vaulting:</p> |
| <pre><code>@Local |
| public interface PoleVaultingManager { |
| int points(@Min(120) int centimeters); |
| } |
| </code></pre> |
| <h1>Usage</h1> |
| <p>TomEE and OpenEJB do not provide anymore <code>BeanValidationAppendixInterceptor</code> since Bean Validation 1.1 does it (with a slighly different usage but the exact same feature).</p> |
| <p>So basically you don't need to configure anything to use it.</p> |
| <h1>Errors</h1> |
| <p>If a parameter is not validated an exception is thrown, it is an EJBException wrapping a ConstraintViolationException:</p> |
| <pre><code>try { |
| gamesManager.addSportMan("I lose", "EN"); |
| fail("no space should be in names"); |
| } catch (EJBException wrappingException) { |
| assertTrue(wrappingException.getCause() instanceof ConstraintViolationException); |
| ConstraintViolationException exception = ConstraintViolationException.class.cast(wrappingException.getCausedByException()); |
| assertEquals(1, exception.getConstraintViolations().size()); |
| } |
| </code></pre> |
| <h1>Example</h1> |
| <h2>OlympicGamesManager</h2> |
| <pre><code>package org.superbiz.designbycontract; |
| |
| import javax.ejb.Stateless; |
| import javax.validation.constraints.NotNull; |
| import javax.validation.constraints.Pattern; |
| import javax.validation.constraints.Size; |
| |
| @Stateless |
| public class OlympicGamesManager { |
| public String addSportMan(@Pattern(regexp = "^[A-Za-z]+$") String name, @Size(min = 2, max = 4) String country) { |
| if (country.equals("USA")) { |
| return null; |
| } |
| return new StringBuilder(name).append(" [").append(country).append("]").toString(); |
| } |
| } |
| </code></pre> |
| <h2>PoleVaultingManager</h2> |
| <pre><code>package org.superbiz.designbycontract; |
| |
| import javax.ejb.Local; |
| import javax.validation.constraints.Min; |
| |
| @Local |
| public interface PoleVaultingManager { |
| int points(@Min(120) int centimeters); |
| } |
| </code></pre> |
| <h2>PoleVaultingManagerBean</h2> |
| <pre><code>package org.superbiz.designbycontract; |
| |
| import javax.ejb.Stateless; |
| |
| @Stateless |
| public class PoleVaultingManagerBean implements PoleVaultingManager { |
| @Override |
| public int points(int centimeters) { |
| return centimeters - 120; |
| } |
| } |
| </code></pre> |
| <h2>OlympicGamesTest</h2> |
| <pre><code>public class OlympicGamesTest { |
| private static Context context; |
| |
| @EJB |
| private OlympicGamesManager gamesManager; |
| |
| @EJB |
| private PoleVaultingManager poleVaultingManager; |
| |
| @BeforeClass |
| public static void start() { |
| Properties properties = new Properties(); |
| properties.setProperty(BeanContext.USER_INTERCEPTOR_KEY, BeanValidationAppendixInterceptor.class.getName()); |
| context = EJBContainer.createEJBContainer(properties).getContext(); |
| } |
| |
| @Before |
| public void inject() throws Exception { |
| context.bind("inject", this); |
| } |
| |
| @AfterClass |
| public static void stop() throws Exception { |
| if (context != null) { |
| context.close(); |
| } |
| } |
| |
| @Test |
| public void sportMenOk() throws Exception { |
| assertEquals("IWin [FR]", gamesManager.addSportMan("IWin", "FR")); |
| } |
| |
| @Test |
| public void sportMenKoBecauseOfName() throws Exception { |
| try { |
| gamesManager.addSportMan("I lose", "EN"); |
| fail("no space should be in names"); |
| } catch (EJBException wrappingException) { |
| assertTrue(wrappingException.getCause() instanceof ConstraintViolationException); |
| ConstraintViolationException exception = ConstraintViolationException.class.cast(wrappingException.getCausedByException()); |
| assertEquals(1, exception.getConstraintViolations().size()); |
| } |
| } |
| |
| @Test |
| public void sportMenKoBecauseOfCountry() throws Exception { |
| try { |
| gamesManager.addSportMan("ILoseTwo", "TOO-LONG"); |
| fail("country should be between 2 and 4 characters"); |
| } catch (EJBException wrappingException) { |
| assertTrue(wrappingException.getCause() instanceof ConstraintViolationException); |
| ConstraintViolationException exception = ConstraintViolationException.class.cast(wrappingException.getCausedByException()); |
| assertEquals(1, exception.getConstraintViolations().size()); |
| } |
| } |
| |
| @Test |
| public void polVaulting() throws Exception { |
| assertEquals(100, poleVaultingManager.points(220)); |
| } |
| |
| @Test |
| public void tooShortPolVaulting() throws Exception { |
| try { |
| poleVaultingManager.points(119); |
| fail("the jump is too short"); |
| } catch (EJBException wrappingException) { |
| assertTrue(wrappingException.getCause() instanceof ConstraintViolationException); |
| ConstraintViolationException exception = ConstraintViolationException.class.cast(wrappingException.getCausedByException()); |
| assertEquals(1, exception.getConstraintViolations().size()); |
| } |
| } |
| } |
| </code></pre> |
| <h1>Running</h1> |
| <pre><code>------------------------------------------------------- |
| T E S T S |
| ------------------------------------------------------- |
| Running OlympicGamesTest |
| Apache OpenEJB 4.0.0-beta-1 build: 20111002-04:06 |
| http://tomee.apache.org/ |
| INFO - openejb.home = /Users/dblevins/examples/bean-validation-design-by-contract |
| INFO - openejb.base = /Users/dblevins/examples/bean-validation-design-by-contract |
| INFO - Using 'javax.ejb.embeddable.EJBContainer=true' |
| INFO - Configuring Service(id=Default Security Service, type=SecurityService, provider-id=Default Security Service) |
| INFO - Configuring Service(id=Default Transaction Manager, type=TransactionManager, provider-id=Default Transaction Manager) |
| INFO - Found EjbModule in classpath: /Users/dblevins/examples/bean-validation-design-by-contract/target/classes |
| INFO - Beginning load: /Users/dblevins/examples/bean-validation-design-by-contract/target/classes |
| INFO - Configuring enterprise application: /Users/dblevins/examples/bean-validation-design-by-contract |
| INFO - Configuring Service(id=Default Stateless Container, type=Container, provider-id=Default Stateless Container) |
| INFO - Auto-creating a container for bean PoleVaultingManagerBean: Container(type=STATELESS, id=Default Stateless Container) |
| INFO - Configuring Service(id=Default Managed Container, type=Container, provider-id=Default Managed Container) |
| INFO - Auto-creating a container for bean OlympicGamesTest: Container(type=MANAGED, id=Default Managed Container) |
| INFO - Enterprise application "/Users/dblevins/examples/bean-validation-design-by-contract" loaded. |
| INFO - Assembling app: /Users/dblevins/examples/bean-validation-design-by-contract |
| INFO - Jndi(name="java:global/bean-validation-design-by-contract/PoleVaultingManagerBean!org.superbiz.designbycontract.PoleVaultingManager") |
| INFO - Jndi(name="java:global/bean-validation-design-by-contract/PoleVaultingManagerBean") |
| INFO - Jndi(name="java:global/bean-validation-design-by-contract/OlympicGamesManager!org.superbiz.designbycontract.OlympicGamesManager") |
| INFO - Jndi(name="java:global/bean-validation-design-by-contract/OlympicGamesManager") |
| INFO - Jndi(name="java:global/EjbModule236054577/OlympicGamesTest!OlympicGamesTest") |
| INFO - Jndi(name="java:global/EjbModule236054577/OlympicGamesTest") |
| INFO - Created Ejb(deployment-id=OlympicGamesManager, ejb-name=OlympicGamesManager, container=Default Stateless Container) |
| INFO - Created Ejb(deployment-id=PoleVaultingManagerBean, ejb-name=PoleVaultingManagerBean, container=Default Stateless Container) |
| INFO - Created Ejb(deployment-id=OlympicGamesTest, ejb-name=OlympicGamesTest, container=Default Managed Container) |
| INFO - Started Ejb(deployment-id=OlympicGamesManager, ejb-name=OlympicGamesManager, container=Default Stateless Container) |
| INFO - Started Ejb(deployment-id=PoleVaultingManagerBean, ejb-name=PoleVaultingManagerBean, container=Default Stateless Container) |
| INFO - Started Ejb(deployment-id=OlympicGamesTest, ejb-name=OlympicGamesTest, container=Default Managed Container) |
| INFO - Deployed Application(path=/Users/dblevins/examples/bean-validation-design-by-contract) |
| Tests run: 5, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.245 sec |
| |
| Results : |
| |
| Tests run: 5, Failures: 0, Errors: 0, Skipped: 0 |
| </code></pre> |
| </div> |
| |
| </div> |
| </div> |
| <div style="margin-bottom: 30px;"></div> |
| <footer> |
| <div class="container"> |
| <div class="row"> |
| <div class="col-sm-6 text-center-mobile"> |
| <h3 class="white">Be simple. Be certified. Be Tomcat.</h3> |
| <h5 class="light regular light-white">"A good application in a good server"</h5> |
| <ul class="social-footer"> |
| <li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li> |
| <li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li> |
| </ul> |
| <h5 class="light regular light-white"> |
| <a href="../../privacy-policy.html" class="white">Privacy Policy</a> |
| </h5> |
| </div> |
| <div class="col-sm-6 text-center-mobile"> |
| <div class="row opening-hours"> |
| <div class="col-sm-3 text-center-mobile"> |
| <h5><a href="../../latest/docs/" class="white">Documentation</a></h5> |
| <ul class="list-unstyled"> |
| <li><a href="../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li> |
| <li><a href="../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li> |
| <li><a href="../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li> |
| <li><a href="../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li> |
| </ul> |
| </div> |
| <div class="col-sm-3 text-center-mobile"> |
| <h5><a href="../../latest/examples/" class="white">Examples</a></h5> |
| <ul class="list-unstyled"> |
| <li><a href="../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li> |
| <li><a href="../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li> |
| <li><a href="../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li> |
| <li><a href="../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li> |
| </ul> |
| </div> |
| <div class="col-sm-3 text-center-mobile"> |
| <h5><a href="../../community/index.html" class="white">Community</a></h5> |
| <ul class="list-unstyled"> |
| <li><a href="../../community/contributors.html" class="regular light-white">Contributors</a></li> |
| <li><a href="../../community/social.html" class="regular light-white">Social</a></li> |
| <li><a href="../../community/sources.html" class="regular light-white">Sources</a></li> |
| </ul> |
| </div> |
| <div class="col-sm-3 text-center-mobile"> |
| <h5><a href="../../security/index.html" class="white">Security</a></h5> |
| <ul class="list-unstyled"> |
| <li><a href="https://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li> |
| <li><a href="https://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li> |
| <li><a href="https://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="row bottom-footer text-center-mobile"> |
| <div class="col-sm-12 light-white"> |
| <p>Copyright © 1999-2022 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> |
| </div> |
| </div> |
| </div> |
| </footer> |
| <!-- Holder for mobile navigation --> |
| <div class="mobile-nav"> |
| <ul> |
| <li><a hef="../../latest/docs/admin/index.html">Administrators</a> |
| <li><a hef="../../latest/docs/developer/index.html">Developers</a> |
| <li><a hef="../../latest/docs/advanced/index.html">Advanced</a> |
| <li><a hef="../../community/index.html">Community</a> |
| </ul> |
| <a href="#" class="close-link"><i class="arrow_up"></i></a> |
| </div> |
| <!-- Scripts --> |
| <script src="../../js/jquery-1.11.1.min.js"></script> |
| <script src="../../js/owl.carousel.min.js"></script> |
| <script src="../../js/bootstrap.min.js"></script> |
| <script src="../../js/wow.min.js"></script> |
| <script src="../../js/typewriter.js"></script> |
| <script src="../../js/jquery.onepagenav.js"></script> |
| <script src="../../js/tree.jquery.js"></script> |
| <script src="../../js/highlight.pack.js"></script> |
| <script src="../../js/main.js"></script> |
| </body> |
| |
| </html> |
| |