| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| <meta charset="UTF-8"> |
| <title>Custom Injection</title> |
| <meta name="description" content="Apache TomEE"> |
| <meta name="author" content="Apache TomEE"> |
| <meta name="google-translate-customization" content="f36a520c08f4c9-0a04e86a9c075ce9-g265f3196f697cf8f-10"> |
| <meta http-equiv="Pragma" content="no-cache"> |
| <meta http-equiv="Expires" content="0"> |
| <meta http-equiv="Cache-Control" content="no-store, no-cache, must-revalidate, max-age=0"> |
| |
| <!-- Le HTML5 shim, for IE6-8 support of HTML elements --> |
| <!--[if lt IE 9]> |
| <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> |
| <![endif]--> |
| |
| <!-- Le styles --> |
| <link href="./resources/css/bootstrap.css" rel="stylesheet"> |
| <link href="./resources/css/prettify.css" rel="stylesheet"> |
| <!--link href="./resources/css/bootstrap-mods.css" rel="stylesheet"--> |
| <link href="./resources/css/main.css" rel="stylesheet"> |
| <link href="./resources/font-awesome-4.6.3/css/font-awesome.min.css" rel="stylesheet"> |
| |
| <script type="text/javascript"> |
| var t = encodeURIComponent(document.title.replace(/^\s+|\s+$/g,"")); |
| var u = encodeURIComponent(""+document.URL); |
| |
| function fbshare () { |
| window.open( |
| "http://www.facebook.com/sharer/sharer.php?u="+u, |
| 'Share on Facebook', |
| 'width=640,height=426'); |
| }; |
| function gpshare () { |
| window.open( |
| "https://plus.google.com/share?url="+u, |
| 'Share on Google+', |
| 'width=584,height=385'); |
| }; |
| function twshare () { |
| window.open( |
| "https://twitter.com/intent/tweet?url="+u+"&text="+t, |
| 'Share on Twitter', |
| 'width=800,height=526'); |
| }; |
| function pinshare () { |
| window.open("//www.pinterest.com/pin/create/button/?url="+u+"&media=http%3A%2F%2Ftomee.apache.org%2Fresources%2Fimages%2Ffeather-logo.png&description="+t, |
| 'Share on Pinterest', |
| 'width=800,height=526'); |
| }; |
| </script> |
| |
| <!-- Le fav and touch icons --> |
| <link rel="shortcut icon" href="./favicon.ico"> |
| <link rel="apple-touch-icon" href="./resources/images/apple-touch-icon.png"> |
| <link rel="apple-touch-icon" sizes="72x72" href="./resources/images/apple-touch-icon-72x72.png"> |
| <link rel="apple-touch-icon" sizes="114x114" href="./resources/images/apple-touch-icon-114x114.png"> |
| |
| <script src="./resources/js/prettify.js" type="text/javascript"></script> |
| <script src="./resources/js/jquery-latest.js"></script> |
| <script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script> |
| <script src="./resources/js/common.js"></script> |
| <script src="./resources/js/prettyprint.js"></script> |
| <!--script src="//assets.pinterest.com/js/pinit.js" type="text/javascript" async></script//--> |
| |
| <script type="text/javascript"> |
| |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-2717626-1']); |
| _gaq.push(['_setDomainName', 'apache.org']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| |
| </script> |
| </head> |
| |
| <body> |
| |
| <div class="topbar" data-dropdown="dropdown"> |
| <div class="fill"> |
| <div class="container"> |
| <a class="brand" href="./index.html">Apache TomEE</a> |
| <ul class="nav"> |
| <li class="dropdown"> |
| <a class="dropdown-toggle" data-toggle="dropdown" href="#"> |
| Apache |
| <b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <!-- <li><a href="./misc/whoweare.html">Who we are?</a></li> --> |
| <!-- <li><a href="./misc/heritage.html">Heritage</a></li> --> |
| <li><a href="http://www.apache.org">Apache Home</a></li> |
| <!-- <li><a href="./misc/resources.html">Resources</a></li> --> |
| <li><a href="./misc/contact.html">Contact</a></li> |
| <li><a href="./misc/legal.html">Legal</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li class="divider"/> |
| <li><a href="http://www.apache.org/security">Security</a></li> |
| </ul> |
| </li> |
| <li><a href="./index.html">Home</a></li> |
| <li><a href="./downloads.html">Downloads</a></li> |
| <li><a href="./documentation.html">Documentation</a></li> |
| <li><a href="./examples-trunk/index.html">Examples</a></li> |
| <li><a href="./support.html">Support</a></li> |
| <li><a href="./contribute.html">Contribute</a></li> |
| <li><a href="./security/index.html">Security</a></li> |
| </ul> |
| |
| <!-- Google CSE Search Box Begins --> |
| <FORM class="pull-right" id="searchbox_010475492895890475512:_t4iqjrgx90" action="http://www.google.com/cse"> |
| <INPUT type="hidden" name="cx" value="010475492895890475512:_t4iqjrgx90"> |
| <INPUT type="hidden" name="cof" value="FORID:0"> |
| <INPUT size="18" width="130" style="width:130px" name="q" type="text" placeholder="Search"> |
| </FORM> |
| <!--<SCRIPT type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_010475492895890475512:_t4iqjrgx90"></SCRIPT>--> |
| <!-- Google CSE Search Box Ends --> |
| </div> |
| </div> |
| </div> |
| |
| <div class="container"> |
| |
| |
| <div class="page-header"> |
| <small><a href="./index.html">Home</a></small><br> |
| <h1>Custom Injection |
| |
| <div style="float: right; position: relative; bottom: -10px; "> |
| <a onclick="javascript:gpshare()" class="gp-share sprite" title="Share on Google+">share [gp]</a> |
| <a onclick="javascript:fbshare()" class="fb-share sprite" title="Share on Facebook">share [fb]</a> |
| <a onclick="javascript:twshare()" class="tw-share sprite" title="Share on Twitter">share [tw]</a> |
| <a onclick="javascript:pinshare()" class="pin-share sprite" title="Share on Pinterest">share [pin]</a> |
| <a data-toggle="modal" href="#edit" class="edit-page" title="Contribute to this Page">contribute</a> |
| </div> |
| </h1> |
| </div> |
| |
| <h1>Overview</h1> |
| |
| <p>As noted in the <a href="injection-of-env-entry-example.html">Injection of env-entry Example</a> |
| , the EJB 3.0 supported env-entry types are fairly limited. Also the use |
| of several <env-entry> tags in an ejb-jar.xml can get a bit verbose.</p> |
| |
| <p>OpenEJB does not restrict you to just these data types or require you to |
| use an ejb-jar.xml to declare them.</p> |
| |
| <ul> |
| <li><code>@Resource</code> can be used on any type for which there is |
| <code>java.beans.PropertyEditor</code></li> |
| <li>You may <code>install your own</code> PropertyEditors and package them with your |
| app.</li> |
| <li>Java Generics are supported (e.g. List<URI> myURIs)</li> |
| <li>You may use a <code>META-INF/env-entries.properties</code> file as an alternative |
| to an ejb-jar.xml</li> |
| </ul> |
| |
| <p>See <a href="built-in-type-converters.html">Built-in Type Converters</a> |
| for a full list of supported env-entry types.</p> |
| |
| <p>The source for this example is the "custom-injection" directory located in |
| the <a href="downloads.html">openejb-examples.zip</a> |
| available on the <a href="http://tomee.apache.org/downloads.html">download page</a>.</p> |
| |
| <p><a name="CustomInjection-TheCode"></a></p> |
| |
| <h1>The Code</h1> |
| |
| <p><a name="CustomInjection-BeanClass"></a></p> |
| |
| <h2>Bean Class</h2> |
| |
| <pre><code>@Stateless |
| public class Stratocaster { |
| |
| @Resource(name = "pickups") |
| private List<Pickup> pickups; |
| |
| @Resource(name = "style") |
| private Style style; |
| |
| @Resource(name = "dateCreated") |
| private Date dateCreated; |
| |
| @Resource(name = "guitarStringGuages") |
| private Map<String, Float> guitarStringGuages; |
| |
| @Resource(name = "certificateOfAuthenticity") |
| private File certificateOfAuthenticity; |
| |
| public Date getDateCreated() { |
| return dateCreated; |
| } |
| |
| /** |
| * Gets the guage of the electric guitar strings |
| * used in this guitar. |
| * |
| * @param string |
| * @return |
| */ |
| public float getStringGuage(String string) { |
| return guitarStringGuages.get(string); |
| } |
| |
| public List<Pickup> getPickups() { |
| return pickups; |
| } |
| |
| public Style getStyle() { |
| return style; |
| } |
| |
| public File getCertificateOfAuthenticity() { |
| return certificateOfAuthenticity; |
| } |
| } |
| </code></pre> |
| |
| <p><a name="CustomInjection-TheMETA-INF/env-entries.propertiesfile"></a></p> |
| |
| <h2>The META-INF/env-entries.properties file</h2> |
| |
| <pre><code>guitarStringGuages=E1=0.052\nA=0.042\nD=0.030\nG=0.017\nB=0.013\nE=0.010 |
| certificateOfAuthenticity=/tmp/strat-certificate.txt |
| dateCreated=1962-03-01 |
| pickups=S,S,S |
| style=VINTAGE |
| </code></pre> |
| |
| <p><a name="CustomInjection-TheCustomTypeandEditor"></a></p> |
| |
| <h2>The Custom Type and Editor</h2> |
| |
| <p>Support for java.lang.Enum types is already built-in, but we've decided |
| we'd like to allow abbreviated versions of the enum constants to be usable. |
| We do this by creating a custom PropertyEditor for our Pickup enum like |
| so:</p> |
| |
| <pre><code>public class PickupEditor extends java.beans.PropertyEditorSupport { |
| public void setAsText(String text) throws IllegalArgumentException { |
| text = text.trim(); |
| |
| if (text.equalsIgnoreCase("H")) setValue(Pickup.HUMBUCKER); |
| else if (text.equalsIgnoreCase("S")) setValue(Pickup.SINGLE_COIL); |
| else throw new IllegalStateException("H and S are the only supported Pickup aliases"); |
| } |
| } |
| </code></pre> |
| |
| <p>We cleverly install this PropertyEditor in a static block in the Pickup |
| class that will be executed should someone actually reference the Pickup |
| type.</p> |
| |
| <pre><code>public enum Pickup { |
| |
| HUMBUCKER, |
| SINGLE_COIL; |
| |
| // Here's the little magic where we register the PickupEditor |
| // which knows how to create this object from a string. |
| // You can add any of your own Property Editors in the same way. |
| static { |
| PropertyEditorManager.registerEditor(Pickup.class, PickupEditor.class); |
| } |
| } |
| </code></pre> |
| |
| <p><a name="CustomInjection-TestCase"></a></p> |
| |
| <h1>Test Case</h1> |
| |
| <pre><code>public class StratocasterTest extends TestCase { |
| |
| @EJB |
| private Stratocaster strat; |
| |
| public void test() throws Exception { |
| EJBContainer.createEJBContainer().getContext().bind("inject", this); |
| |
| Date date = DateFormat.getDateInstance(DateFormat.MEDIUM, Locale.US).parse("Mar 1, 1962"); |
| assertEquals("Strat.getDateCreated()", date, strat.getDateCreated()); |
| |
| List<Pickup> pickups = asList(Pickup.SINGLE_COIL, Pickup.SINGLE_COIL, Pickup.SINGLE_COIL); |
| assertEquals("Strat.getPickups()", pickups, strat.getPickups()); |
| |
| assertEquals("Strat.getStyle()", Style.VINTAGE, strat.getStyle()); |
| |
| assertEquals("Strat.getStringGuage(\"E1\")", 0.052F, strat.getStringGuage("E1")); |
| assertEquals("Strat.getStringGuage(\"A\")", 0.042F, strat.getStringGuage("A")); |
| assertEquals("Strat.getStringGuage(\"D\")", 0.030F, strat.getStringGuage("D")); |
| assertEquals("Strat.getStringGuage(\"G\")", 0.017F, strat.getStringGuage("G")); |
| assertEquals("Strat.getStringGuage(\"B\")", 0.013F, strat.getStringGuage("B")); |
| assertEquals("Strat.getStringGuage(\"E\")", 0.010F, strat.getStringGuage("E")); |
| |
| File file = new File("/tmp/strat-certificate.txt"); |
| assertEquals("Strat.getCertificateOfAuthenticity()", file,strat.getCertificateOfAuthenticity()); |
| |
| |
| } |
| } |
| </code></pre> |
| |
| <p><a name="CustomInjection-Runningit"></a></p> |
| |
| <h1>Running it</h1> |
| |
| <p>Running the example is fairly simple. In the "custom-injection" directory of the <a href="openejb:download.html">examples zip</a>, just run:</p> |
| |
| <blockquote> |
| <p>$ mvn clean install</p> |
| </blockquote> |
| |
| <p>Which should create output like the following.</p> |
| |
| <pre><code>------------------------------------------------------- |
| T E S T S |
| ------------------------------------------------------- |
| Running org.superbiz.enventries.StratocasterTest |
| Apache OpenEJB 3.1-SNAPSHOT build: 20080409-12:05 |
| http://tomee.apache.org/ |
| INFO - openejb.home = /Users/dblevins/work/openejb3/examples/custom-injection |
| INFO - openejb.base = /Users/dblevins/work/openejb3/examples/custom-injection |
| 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 - Configuring Service(id=Default JDK 1.3 ProxyFactory, type=ProxyFactory, provider-id=Default JDK 1.3 ProxyFactory) |
| INFO - Found EjbModule in classpath: /Users/dblevins/work/openejb3/examples/custom-injection/target/classes |
| INFO - Configuring app: /Users/dblevins/work/openejb3/examples/custom-injection/target/classes |
| INFO - Configuring Service(id=Default Stateless Container, type=Container, provider-id=Default Stateless Container) |
| INFO - Auto-creating a container for bean StratocasterImpl: Container(type=STATELESS, id=Default Stateless Container) |
| INFO - Loaded Module: /Users/dblevins/work/openejb3/examples/custom-injection/target/classes |
| INFO - Assembling app: /Users/dblevins/work/openejb3/examples/custom-injection/target/classes |
| INFO - Jndi(name=StratocasterImplLocal) --> Ejb(deployment-id=StratocasterImpl) |
| INFO - Created Ejb(deployment-id=StratocasterImpl, ejb-name=StratocasterImpl, container=Default Stateless Container) |
| INFO - Deployed Application(path=/Users/dblevins/work/openejb3/examples/custom-injection/target/classes) |
| Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.705 sec |
| |
| Results : |
| |
| Tests run: 1, Failures: 0, Errors: 0, Skipped: 0 |
| </code></pre> |
| |
| |
| |
| |
| <div id="edit" class="modal hide fade in" style="display: none; "> |
| <div class="modal-header"> |
| <a class="close" data-dismiss="modal">x</a> |
| |
| <h3>Thank you for contributing to the documentation!</h3> |
| </div> |
| <div class="modal-body"> |
| <h4>Any help with the documentation is greatly appreciated.</h4> |
| <p>All edits are reviewed before going live, so feel free to do much more than fix typos or links. If you see a page that could benefit from an entire rewrite, we'd be thrilled to review it. Don't be surprised if we like it so much we ask you for help with other pages :)</p> |
| <small>NOTICE: unless indicated otherwise on the pages in question, all editable content available from apache.org is presumed to be licensed under the Apache License (AL) version 2.0 and hence all submissions to apache.org treated as formal Contributions under the license terms.</small> |
| <!--[if gt IE 6]> |
| <h4>Internet Explorer Users</h4> |
| <p>If you are not an Apache committer, click the Yes link and enter a <i>anonymous</i> for the username and leave the password empty</p> |
| <![endif]--> |
| |
| </div> |
| <div class="modal-footer"> |
| Do you have an Apache ID? |
| <a href="javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))" class="btn">Yes</a> |
| <a href="javascript:void(location.href='https://anonymous:@cms.apache.org/redirect?uri='+escape(location.href))" class="btn">No</a> |
| </div> |
| </div> |
| <script src="./resources/js/bootstrap-modal.js"></script> |
| |
| <footer> |
| <p>Copyright © 1999-2016 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> |
| </footer> |
| |
| </div> <!-- /container --> |
| |
| <!-- Javascript |
| ================================================== --> |
| <!-- Placed at the end of the document so the pages load faster --> |
| <script src="./resources/js/bootstrap-dropdown.js"></script> |
| |
| </body> |
| </html> |
