http://git-wip-us.apache.org/repos/asf/polygene-website/blob/538baaf6/content/java/develop/library-alarm.html ---------------------------------------------------------------------- diff --git a/content/java/develop/library-alarm.html b/content/java/develop/library-alarm.html index 1531269..dc66b03 100644 --- a/content/java/develop/library-alarm.html +++ b/content/java/develop/library-alarm.html @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html xmlns="http://www.w3.org/1999/xhtml";><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Alarms</title><link rel="stylesheet" type="text/css" href="css/style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="" /><link rel="up" href="libraries.html" title="Libraries" /><link rel="prev" href="scripting.html" title="Scripting" /><link rel="next" href="library-circuitbreaker.html" title="Circuit Breaker" /> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html xmlns="http://www.w3.org/1999/xhtml";><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Alarms</title><link rel="stylesheet" type="text/css" href="css/style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="" /><link rel="up" href="libraries.html" title="Libraries" /><link rel="prev" href="scripting.html" title="Scripting" /><link rel="next" href="library-circuitbreaker.html" title="Circuit Breaker" /> <!-- favicon --> @@ -66,7 +66,7 @@ })(); </script> - </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="logo"><a href="index.html"><img src="images/logo-standard.png" /></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl><dt><span class="section"><a href="index.html#home">Polygeneâ¢</a></span></dt><dt><span class="section"><a href="intro.html">Introduction</a></span></dt><dt><span class="section"><a href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a href="samples.html">Samples</a></span></dt><dt><span class="section"><a href="core.html">Core</a></span></dt><dt><span class="section"><span xmlns="" href="libraries.html">Libraries</span></span></dt><dt><span class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a href="tools.html">Tools</a></span></dt><dt><span class="section"><a href="glossary.ht ml">Glossary </a></span></dt></dl></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="sub-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl><dt><span class="section"><a href="libraries.html#_overview_5">Overview</a></span></dt><dt><span class="section"><a href="scripting.html">Scripting</a></span></dt><dt><span class="section"><span xmlns="" href="library-alarm.html">Alarms</span></span></dt><dt><span class="section"><a href="library-circuitbreaker.html">Circuit Breaker</a></span></dt><dt><span class="section"><a href="library-constraints.html">Constraints</a></span></dt><dt><span class="section"><a href="library-fileconfig.html">FileConfig</a></span></dt><dt><span class="section"><a href="library-http.html">HTTP</a></span></dt><dt><span class="section"><a href="library-invocation-cache.html">Invocation Cache</a></span></dt><dt><span class="section"><a href="library-jmx.html">JMX</a></span></dt><dt><span class="section"><a href="library-locking.html"> Locking</a></span></dt><dt><span class="section"><a href="library-logging.html">Logging</a></span></dt><dt><span class="section"><a href="library-osgi.html">OSGi</a></span></dt><dt><span class="section"><a href="library-rdf.html">RDF</a></span></dt><dt><span class="section"><a href="library-rest-client.html">ReST Client</a></span></dt><dt><span class="section"><a href="library-rest-client-primer.html">ReST - HATEOAS Primer</a></span></dt><dt><span class="section"><a href="library-rest-common.html">ReST Common</a></span></dt><dt><span class="section"><a href="library-rest-server.html">ReST Server</a></span></dt><dt><span class="section"><a href="library-restlet.html">Restlet Support</a></span></dt><dt><span class="section"><a href="library-servlet.html">Servlet</a></span></dt><dt><span class="section"><a href="library-shiro.html">Shiro Security</a></span></dt><dt><span class="section"><a href="library-shiro-web.html">Shiro Web Security</a></span></dt><dt><span class="section"><a href ="library-spring.html">Spring Integration</a></span></dt><dt><span class="section"><a href="library-sql.html">SQL</a></span></dt><dt><span class="section"><a href="library-uid.html">UID</a></span></dt><dt><span class="section"><a href="library-uowfile.html">UoWFile</a></span></dt></dl></div></div><div class="section" title="Alarms"><div class="titlepage"><div><div><h3 class="title"><a id="library-alarm"></a>Alarms</h3></div></div></div><p class="remark"><em><span class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p class="devstatus-docs-brief">docs</p><p class="devstatus-tests-some">tests</p><p>The process control and industrial automation industry has for decades been struggling with a large number of unreliable + </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="logo"><a href="index.html"><img src="images/logo-standard.png" style="width:80%;height:80%; padding-top:20px;" /></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl class="toc"><dt><span class="section"><a href="index.html#home">Polygeneâ¢</a></span></dt><dt><span class="section"><a href="intro.html">Introduction</a></span></dt><dt><span class="section"><a href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a href="samples.html">Samples</a></span></dt><dt><span class="section"><a href="core.html">Core</a></span></dt><dt><span class="section"><span xmlns="" href="libraries.html">Libraries</span></span></dt><dt><span class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a href="tools.html">Tools</ a></span></dt><dt><span class="section"><a href="glossary.html">Glossary </a></span></dt></dl></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="sub-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl class="toc"><dt><span class="section"><a href="libraries.html#_overview_5">Overview</a></span></dt><dt><span class="section"><a href="scripting.html">Scripting</a></span></dt><dt><span class="section"><span xmlns="" href="library-alarm.html">Alarms</span></span></dt><dt><span class="section"><a href="library-circuitbreaker.html">Circuit Breaker</a></span></dt><dt><span class="section"><a href="library-constraints.html">Constraints</a></span></dt><dt><span class="section"><a href="library-fileconfig.html">FileConfig</a></span></dt><dt><span class="section"><a href="library-http.html">HTTP</a></span></dt><dt><span class="section"><a href="library-invocation-cache.html">Invocation Cache</a></span></dt><dt><span class="section"><a href="library-jmx.html">JMX< /a></span></dt><dt><span class="section"><a href="library-locking.html">Locking</a></span></dt><dt><span class="section"><a href="library-logging.html">Logging</a></span></dt><dt><span class="section"><a href="library-osgi.html">OSGi</a></span></dt><dt><span class="section"><a href="library-rdf.html">RDF</a></span></dt><dt><span class="section"><a href="library-rest-client.html">ReST Client</a></span></dt><dt><span class="section"><a href="library-rest-client-primer.html">ReST - HATEOAS Primer</a></span></dt><dt><span class="section"><a href="library-rest-common.html">ReST Common</a></span></dt><dt><span class="section"><a href="library-rest-server.html">ReST Server</a></span></dt><dt><span class="section"><a href="library-servlet.html">Servlet</a></span></dt><dt><span class="section"><a href="library-shiro.html">Shiro Security</a></span></dt><dt><span class="section"><a href="library-shiro-web.html">Shiro Web Security</a></span></dt><dt><span class="section"><a href="library-spring .html">Spring Integration</a></span></dt><dt><span class="section"><a href="library-sql.html">SQL</a></span></dt><dt><span class="section"><a href="library-uid.html">UID</a></span></dt><dt><span class="section"><a href="library-uowfile.html">UoWFile</a></span></dt></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="library-alarm"></a>Alarms</h3></div></div></div><p class="remark"><em><span class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p class="devstatus-docs-brief">docs</p><p class="devstatus-tests-some">tests</p><p>The process control and industrial automation industry has for decades been struggling with a large number of unreliable data points, such as sensors, fuses and potentially malfunctioning valves and actuators. This industry quickly developed the concept of <span class="strong"><strong>Alarm Point</strong></span> as an abstraction for indication that something is not working correctly. These <span class="emphasis"><em>Alarm Points</em></span> could then be grouped and aggregated, along a well-defined set of rules, to provide human operators a @@ -74,14 +74,14 @@ clear view of what is going on in a plant.</p><p>The enterprise software has alw donât. Very little thought has been spent on what happens when many independent systems interact and what the consequences are to other systems when one fails. The <span class="emphasis"><em>Alarm Point</em></span> concepts becomes a natural fit for the enterprise world of today, where <span class="emphasis"><em>Alarm Points</em></span> allows for fine-grained notification and view into the health of one or more -systems.</p><p>In Polygene, we are building upon this powerful abstraction, from decades of field experience.</p><div class="table"><a id="idm229754764944"></a><p class="title"><strong>Table 23. Artifact</strong></p><div class="table-contents"><table summary="Artifact" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group ID</th><th align="left" valign="top">Artifact ID</th><th align="left" valign="top">Version</th></tr></thead><tbody><tr><td align="left" valign="top"><p>org.apache.polygene.libraries</p></td><td align="left" valign="top"><p>org.apache.polygene.library.alarm</p></td><td align="left" valign="top"><p>3.1.0-SNAPSHOT</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section" title="Overview"><div class="titlepage"><div><div><h4 class="title"><a id="_overview_6"></a>Overview</h4></div></div></div><p>An <span class="emphasis"><em>Alarm Point</em></span> is of an <span class="emphasis"><em>Alarm Class</em></span> and of an <span class="emphasis"><em>Alarm Category</em></span>. The <span class="emphasis"><em>Alarm Class</em></span> defines the <span class="strong"><strong>severity</strong></span> of the +systems.</p><p>In Polygene, we are building upon this powerful abstraction, from decades of field experience.</p><div class="table"><a id="idm4465"></a><p class="title"><strong>Table 23. Artifact</strong></p><div class="table-contents"><table class="table" summary="Artifact" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group ID</th><th align="left" valign="top">Artifact ID</th><th align="left" valign="top">Version</th></tr></thead><tbody><tr><td align="left" valign="top"><p>org.apache.polygene.libraries</p></td><td align="left" valign="top"><p>org.apache.polygene.library.alarm</p></td><td align="left" valign="top"><p>0</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_overview_6"></a>Overview</h4></div></div></div><p>An <span class="emphasis"><em>Alarm Point</em></span> is of an <span class="emph asis"><em>Alarm Class</em></span> and of an <span class="emphasis"><em>Alarm Category</em></span>. The <span class="emphasis"><em>Alarm Class</em></span> defines the <span class="strong"><strong>severity</strong></span> of the <span class="emphasis"><em>Alarm Point</em></span> and the <span class="emphasis"><em>Alarm Category</em></span> defines which <span class="strong"><strong>part</strong></span> of the system it belongs to. <span class="emphasis"><em>Alarm Category</em></span> can be extended by the developer, and the package contains the <span class="emphasis"><em>SimpleAlarmCategory</em></span> as an example, where a Description property has been added.</p><p>An <span class="emphasis"><em>Alarm Point</em></span> also has a <span class="emphasis"><em>System Name</em></span>, which should be the subsystem or application name.</p><p><span class="emphasis"><em>Alarm Points</em></span> are <span class="strong"><strong>triggered</strong></span> and an <span class="emphasis"><em>Alarm Trigger</em></span> may cause the <span class="emphasis"><em>Alarm Status</em></span> to change. IF, and only if, the <span class="emphasis"><em>Alarm Status</em></span> changes, and <span class="emphasis"><em>Alarm Event</em></span> is generated. The <span class="emphasis"><em>Alarm Model</em></span> used for an <span class="emphasis"><em>Alarm Point</em></span> defines which -<span class="emphasis"><em>Alarm Status</em></span>, <span class="emphasis"><em>Alarm Trigger</em></span> and <span class="emphasis"><em>Alarm Event</em></span> that are possible.</p><p><span class="emphasis"><em>Alarm Points</em></span> may also have user-defined properties. These are primarily used for reporting and auditing.</p></div><div class="section" title="Alarm Point"><div class="titlepage"><div><div><h4 class="title"><a id="_alarm_point"></a>Alarm Point</h4></div></div></div><p>The <span class="emphasis"><em>Alarm Point</em></span> is the central API for applications. <span class="emphasis"><em>Alarm Points</em></span> are entities and normally dormant on in the +<span class="emphasis"><em>Alarm Status</em></span>, <span class="emphasis"><em>Alarm Trigger</em></span> and <span class="emphasis"><em>Alarm Event</em></span> that are possible.</p><p><span class="emphasis"><em>Alarm Points</em></span> may also have user-defined properties. These are primarily used for reporting and auditing.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_alarm_point"></a>Alarm Point</h4></div></div></div><p>The <span class="emphasis"><em>Alarm Point</em></span> is the central API for applications. <span class="emphasis"><em>Alarm Points</em></span> are entities and normally dormant on in the Entity Store. The <span class="emphasis"><em>Alarm Point</em></span> is a small workflow state-machine, and the <span class="emphasis"><em>Alarm Model</em></span> associated with the <span class="emphasis"><em>Alarm -Point</em></span> defines the workflow.</p></div><div class="section" title="Alarm Event"><div class="titlepage"><div><div><h4 class="title"><a id="_alarm_event"></a>Alarm Event</h4></div></div></div></div><div class="section" title="Alarm Class"><div class="titlepage"><div><div><h4 class="title"><a id="_alarm_class"></a>Alarm Class</h4></div></div></div></div><div class="section" title="Alarm Category"><div class="titlepage"><div><div><h4 class="title"><a id="_alarm_category"></a>Alarm Category</h4></div></div></div></div><div class="section" title="Alarm Proxy"><div class="titlepage"><div><div><h4 class="title"><a id="_alarm_proxy"></a>Alarm Proxy</h4></div></div></div><p>Sometimes it is much more convenient to hold on to Alarm Points all the time, instead of reviving them from the Entity +Point</em></span> defines the workflow.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_alarm_event"></a>Alarm Event</h4></div></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_alarm_class"></a>Alarm Class</h4></div></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_alarm_category"></a>Alarm Category</h4></div></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_alarm_proxy"></a>Alarm Proxy</h4></div></div></div><p>Sometimes it is much more convenient to hold on to Alarm Points all the time, instead of reviving them from the Entity Store every time they are to be modified. Therefor, there is a convenience class available who does all the grunt work, called the <span class="emphasis"><em>Alarm Proxy</em></span>. By creating an <span class="emphasis"><em>Alarm Proxy</em></span>, all the UnitOfWork handling is done for you. You still need to provide an <span class="emphasis"><em>Identity</em></span> of the Alarm, which must survive restarts. The code could look something like this;</p><pre class="programlisting brush: java">@Service @@ -102,10 +102,10 @@ public void assemble( ModuleAssembly module ) [...snip...] myAlarmPoint.activate(); -</pre></div><div class="section" title="Alarm Models"><div class="titlepage"><div><div><h4 class="title"><a id="_alarm_models"></a>Alarm Models</h4></div></div></div><p>The Polygene⢠Alarm library comes with 3 <span class="emphasis"><em>Alarm Models</em></span> which should be sufficient for most uses. These are based on decades -of experience from the industrial automation industry and user feedback.</p></div><div class="section" title="Simple Alarm Model"><div class="titlepage"><div><div><h4 class="title"><a id="_simple_alarm_model"></a>Simple Alarm Model</h4></div></div></div><p>The <span class="emphasis"><em>Simple Alarm Model</em></span> is the most basic one, with only two <span class="emphasis"><em>Alarm Status</em></span>, <span class="strong"><strong><span class="emphasis"><em>Normal</em></span></strong></span> and <span class="strong"><strong><span class="emphasis"><em>Activated</em></span></strong></span>. The only +</pre></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_alarm_models"></a>Alarm Models</h4></div></div></div><p>The Polygene⢠Alarm library comes with 3 <span class="emphasis"><em>Alarm Models</em></span> which should be sufficient for most uses. These are based on decades +of experience from the industrial automation industry and user feedback.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_simple_alarm_model"></a>Simple Alarm Model</h4></div></div></div><p>The <span class="emphasis"><em>Simple Alarm Model</em></span> is the most basic one, with only two <span class="emphasis"><em>Alarm Status</em></span>, <span class="strong"><strong><span class="emphasis"><em>Normal</em></span></strong></span> and <span class="strong"><strong><span class="emphasis"><em>Activated</em></span></strong></span>. The only <span class="emphasis"><em>Alarm Triggers</em></span> are <span class="emphasis"><em>activate</em></span> and <span class="emphasis"><em>deactivate</em></span>, where <span class="emphasis"><em>activate</em></span> on a <span class="emphasis"><em>Normal</em></span> status will bring it to <span class="emphasis"><em>Activated</em></span> -status and an <span class="emphasis"><em>Activated Alarm Event</em></span> is generated.</p><div class="informaltable"><table border="1" width="80%"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /><col class="col_4" /><col class="col_5" /></colgroup><thead><tr><th align="left" valign="top"> <span class="strong"><strong>Old Status</strong></span> </th><th align="left" valign="top"> <span class="strong"><strong>Trigger</strong></span> </th><th align="left" valign="top"> <span class="strong"><strong>Event</strong></span> </th><th align="left" valign="top"> <span class="strong"><strong>New Status</strong></span> </th><th align="left" valign="top"> </th></tr></thead><tbody></tbody></table></div></div><div class="section" title="Standard Alarm Model"><div class="titlepage"><div><div><h4 class="title"><a id="_standard_alarm_model"></a>Standard Alarm Model</h4></div></div></div></div><div class="section" title="Extended Alarm Model"><div class="titlepage"><div><div ><h4 class="title"><a id="_extended_alarm_model"></a>Extended Alarm >Model</h4></div></div></div></div></div><div xmlns="" >xmlns:exsl="http://exslt.org/common"; class="footer"><p> +status and an <span class="emphasis"><em>Activated Alarm Event</em></span> is generated.</p><div class="informaltable"><table class="informaltable" border="1" width="80%"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /><col class="col_4" /><col class="col_5" /></colgroup><thead><tr><th align="left" valign="top"> <span class="strong"><strong>Old Status</strong></span> </th><th align="left" valign="top"> <span class="strong"><strong>Trigger</strong></span> </th><th align="left" valign="top"> <span class="strong"><strong>Event</strong></span> </th><th align="left" valign="top"> <span class="strong"><strong>New Status</strong></span> </th><th align="left" valign="top"> </th></tr></thead><tbody></tbody></table></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_standard_alarm_model"></a>Standard Alarm Model</h4></div></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_extended_ alarm_model"></a>Extended Alarm Model</h4></div></div></div></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="footer"><p> Copyright © 2015 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/"; target="_blank">Apache License, Version 2.0</a>. <br /><small> Apache Polygene, Polygene, Apache, the Apache feather logo, and the Apache Polygene project logo are trademarks of The Apache Software Foundation.<br />
http://git-wip-us.apache.org/repos/asf/polygene-website/blob/538baaf6/content/java/develop/library-circuitbreaker.html ---------------------------------------------------------------------- diff --git a/content/java/develop/library-circuitbreaker.html b/content/java/develop/library-circuitbreaker.html index ec0ce49..0015c9b 100644 --- a/content/java/develop/library-circuitbreaker.html +++ b/content/java/develop/library-circuitbreaker.html @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html xmlns="http://www.w3.org/1999/xhtml";><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Circuit Breaker</title><link rel="stylesheet" type="text/css" href="css/style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="" /><link rel="up" href="libraries.html" title="Libraries" /><link rel="prev" href="library-alarm.html" title="Alarms" /><link rel="next" href="library-constraints.html" title="Constraints" /> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html xmlns="http://www.w3.org/1999/xhtml";><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Circuit Breaker</title><link rel="stylesheet" type="text/css" href="css/style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="" /><link rel="up" href="libraries.html" title="Libraries" /><link rel="prev" href="library-alarm.html" title="Alarms" /><link rel="next" href="library-constraints.html" title="Constraints" /> <!-- favicon --> @@ -66,7 +66,7 @@ })(); </script> - </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="logo"><a href="index.html"><img src="images/logo-standard.png" /></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl><dt><span class="section"><a href="index.html#home">Polygeneâ¢</a></span></dt><dt><span class="section"><a href="intro.html">Introduction</a></span></dt><dt><span class="section"><a href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a href="samples.html">Samples</a></span></dt><dt><span class="section"><a href="core.html">Core</a></span></dt><dt><span class="section"><span xmlns="" href="libraries.html">Libraries</span></span></dt><dt><span class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a href="tools.html">Tools</a></span></dt><dt><span class="section"><a href="glossary.ht ml">Glossary </a></span></dt></dl></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="sub-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl><dt><span class="section"><a href="libraries.html#_overview_5">Overview</a></span></dt><dt><span class="section"><a href="scripting.html">Scripting</a></span></dt><dt><span class="section"><a href="library-alarm.html">Alarms</a></span></dt><dt><span class="section"><span xmlns="" href="library-circuitbreaker.html">Circuit Breaker</span></span></dt><dt><span class="section"><a href="library-constraints.html">Constraints</a></span></dt><dt><span class="section"><a href="library-fileconfig.html">FileConfig</a></span></dt><dt><span class="section"><a href="library-http.html">HTTP</a></span></dt><dt><span class="section"><a href="library-invocation-cache.html">Invocation Cache</a></span></dt><dt><span class="section"><a href="library-jmx.html">JMX</a></span></dt><dt><span class="section"><a href="library-locking.html"> Locking</a></span></dt><dt><span class="section"><a href="library-logging.html">Logging</a></span></dt><dt><span class="section"><a href="library-osgi.html">OSGi</a></span></dt><dt><span class="section"><a href="library-rdf.html">RDF</a></span></dt><dt><span class="section"><a href="library-rest-client.html">ReST Client</a></span></dt><dt><span class="section"><a href="library-rest-client-primer.html">ReST - HATEOAS Primer</a></span></dt><dt><span class="section"><a href="library-rest-common.html">ReST Common</a></span></dt><dt><span class="section"><a href="library-rest-server.html">ReST Server</a></span></dt><dt><span class="section"><a href="library-restlet.html">Restlet Support</a></span></dt><dt><span class="section"><a href="library-servlet.html">Servlet</a></span></dt><dt><span class="section"><a href="library-shiro.html">Shiro Security</a></span></dt><dt><span class="section"><a href="library-shiro-web.html">Shiro Web Security</a></span></dt><dt><span class="section"><a href ="library-spring.html">Spring Integration</a></span></dt><dt><span class="section"><a href="library-sql.html">SQL</a></span></dt><dt><span class="section"><a href="library-uid.html">UID</a></span></dt><dt><span class="section"><a href="library-uowfile.html">UoWFile</a></span></dt></dl></div></div><div class="section" title="Circuit Breaker"><div class="titlepage"><div><div><h3 class="title"><a id="library-circuitbreaker"></a>Circuit Breaker</h3></div></div></div><p class="remark"><em><span class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p class="devstatus-docs-good">docs</p><p class="devstatus-tests-good">tests</p><p>The Circuit Breaker library provides a way to guard your application + </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="logo"><a href="index.html"><img src="images/logo-standard.png" style="width:80%;height:80%; padding-top:20px;" /></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl class="toc"><dt><span class="section"><a href="index.html#home">Polygeneâ¢</a></span></dt><dt><span class="section"><a href="intro.html">Introduction</a></span></dt><dt><span class="section"><a href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a href="samples.html">Samples</a></span></dt><dt><span class="section"><a href="core.html">Core</a></span></dt><dt><span class="section"><span xmlns="" href="libraries.html">Libraries</span></span></dt><dt><span class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a href="tools.html">Tools</ a></span></dt><dt><span class="section"><a href="glossary.html">Glossary </a></span></dt></dl></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="sub-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl class="toc"><dt><span class="section"><a href="libraries.html#_overview_5">Overview</a></span></dt><dt><span class="section"><a href="scripting.html">Scripting</a></span></dt><dt><span class="section"><a href="library-alarm.html">Alarms</a></span></dt><dt><span class="section"><span xmlns="" href="library-circuitbreaker.html">Circuit Breaker</span></span></dt><dt><span class="section"><a href="library-constraints.html">Constraints</a></span></dt><dt><span class="section"><a href="library-fileconfig.html">FileConfig</a></span></dt><dt><span class="section"><a href="library-http.html">HTTP</a></span></dt><dt><span class="section"><a href="library-invocation-cache.html">Invocation Cache</a></span></dt><dt><span class="section"><a href="library-jmx.html">JMX< /a></span></dt><dt><span class="section"><a href="library-locking.html">Locking</a></span></dt><dt><span class="section"><a href="library-logging.html">Logging</a></span></dt><dt><span class="section"><a href="library-osgi.html">OSGi</a></span></dt><dt><span class="section"><a href="library-rdf.html">RDF</a></span></dt><dt><span class="section"><a href="library-rest-client.html">ReST Client</a></span></dt><dt><span class="section"><a href="library-rest-client-primer.html">ReST - HATEOAS Primer</a></span></dt><dt><span class="section"><a href="library-rest-common.html">ReST Common</a></span></dt><dt><span class="section"><a href="library-rest-server.html">ReST Server</a></span></dt><dt><span class="section"><a href="library-servlet.html">Servlet</a></span></dt><dt><span class="section"><a href="library-shiro.html">Shiro Security</a></span></dt><dt><span class="section"><a href="library-shiro-web.html">Shiro Web Security</a></span></dt><dt><span class="section"><a href="library-spring .html">Spring Integration</a></span></dt><dt><span class="section"><a href="library-sql.html">SQL</a></span></dt><dt><span class="section"><a href="library-uid.html">UID</a></span></dt><dt><span class="section"><a href="library-uowfile.html">UoWFile</a></span></dt></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="library-circuitbreaker"></a>Circuit Breaker</h3></div></div></div><p class="remark"><em><span class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p class="devstatus-docs-good">docs</p><p class="devstatus-tests-good">tests</p><p>The Circuit Breaker library provides a way to guard your application against faulty external systems (e.g. mail servers being down, web services being down).</p><p>Thereâs a couple of differences between this implementation and others seen on the net, but weâve also heavily borrowed from others. The @@ -91,7 +91,7 @@ tripping it should be possible to expose this to other Polygene⢠services. There is a standard implementation of the Availability interface that delegates to a circuit breaker and the Enabled configuration flag, which is what weâd suspect will be used in most cases where external systems -are invoked.</p><div class="table"><a id="idm229754694272"></a><p class="title"><strong>Table 24. Artifact</strong></p><div class="table-contents"><table summary="Artifact" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group ID</th><th align="left" valign="top">Artifact ID</th><th align="left" valign="top">Version</th></tr></thead><tbody><tr><td align="left" valign="top"><p>org.apache.polygene.libraries</p></td><td align="left" valign="top"><p>org.apache.polygene.library.circuitbreaker</p></td><td align="left" valign="top"><p>3.1.0-SNAPSHOT</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section" title="Direct usage"><div class="titlepage"><div><div><h4 class="title"><a id="_direct_usage"></a>Direct usage</h4></div></div></div><p>The CircuitBreaker can be used directly, even without using anything else from the Polygene⢠SDK.</p><p>Here is a code snippet that demonstrate how to create a CircuitBreaker and how it behave:</p><pre class="programlisting brush: java">// Create a CircuitBreaker with a threshold of 3, a 250ms timeout, allowing IllegalArgumentExceptions +are invoked.</p><div class="table"><a id="idm4590"></a><p class="title"><strong>Table 24. Artifact</strong></p><div class="table-contents"><table class="table" summary="Artifact" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group ID</th><th align="left" valign="top">Artifact ID</th><th align="left" valign="top">Version</th></tr></thead><tbody><tr><td align="left" valign="top"><p>org.apache.polygene.libraries</p></td><td align="left" valign="top"><p>org.apache.polygene.library.circuitbreaker</p></td><td align="left" valign="top"><p>0</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_direct_usage"></a>Direct usage</h4></div></div></div><p>The CircuitBreaker can be used directly, even without using anything else from the Polygene⢠SDK.</p><p>Here is a code snippet that demonstrate how to create a CircuitBreaker and how it behave:</p><pre class="programlisting brush: java">// Create a CircuitBreaker with a threshold of 3, a 250ms timeout, allowing IllegalArgumentExceptions CircuitBreaker cb = new CircuitBreaker( 3, 250, CircuitBreakers.in( IllegalArgumentException.class ) ); [...snip...] @@ -125,8 +125,8 @@ cb.throwable( new IOException() ); // CircuitBreaker is back on -</pre></div><div class="section" title="Service Circuit Breaker"><div class="titlepage"><div><div><h4 class="title"><a id="_service_circuit_breaker"></a>Service Circuit Breaker</h4></div></div></div><p>As a facility you can make your Services extends <code class="literal">AbstractBreakOnThrowable</code>, set them a <code class="literal">CircuitBreaker</code> as -<code class="literal">MetaInfo</code> during assembly and annotate methods with <code class="literal">@BreaksCircuitOnThrowable</code>. Doing this will :</p><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem"> +</pre></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_service_circuit_breaker"></a>Service Circuit Breaker</h4></div></div></div><p>As a facility you can make your Services extends <code class="literal">AbstractBreakOnThrowable</code>, set them a <code class="literal">CircuitBreaker</code> as +<code class="literal">MetaInfo</code> during assembly and annotate methods with <code class="literal">@BreaksCircuitOnThrowable</code>. Doing this will :</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> add a circuit breaker accessor to the Service (<code class="literal">CircuitBreaker getCircuitBreaker()</code>) ; </li><li class="listitem"> allow exposition of the circuit breaker in JMX ; @@ -153,7 +153,7 @@ public interface TestService } </pre><p>Remember to annotate methods which when they throw throwables should cause circuit breakers to trip and go back on -invocation success with the <code class="literal">@BreaksCircuitOnThrowable</code> annotation.</p><div class="section" title="Exposing Service Circuit Breakers in JMX"><div class="titlepage"><div><div><h5 class="title"><a id="_exposing_service_circuit_breakers_in_jmx"></a>Exposing Service Circuit Breakers in JMX</h5></div></div></div><p>To expose their circuit breaker in JMX, your Services using one must implement the <code class="literal">ServiceCircuitBreaker</code> interface. +invocation success with the <code class="literal">@BreaksCircuitOnThrowable</code> annotation.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a id="_exposing_service_circuit_breakers_in_jmx"></a>Exposing Service Circuit Breakers in JMX</h5></div></div></div><p>To expose their circuit breaker in JMX, your Services using one must implement the <code class="literal">ServiceCircuitBreaker</code> interface. Note that if you already extends <code class="literal">AbstractBreakOnThrowable</code> you donât need to do anything else as it already extends <code class="literal">ServiceCircuitBreaker</code>.</p><p>Here is how it goes:</p><pre class="programlisting brush: java">public void assemble( ModuleAssembly module ) throws AssemblyException @@ -167,7 +167,7 @@ Note that if you already extends <code class="literal">AbstractBreakOnThrowable< module.services( CircuitBreakerManagement.class ). instantiateOnStartup(); } -</pre></div></div><div class="section" title="Interactive sample"><div class="titlepage"><div><div><h4 class="title"><a id="_interactive_sample"></a>Interactive sample</h4></div></div></div><p>From the sources you can run the <code class="literal">runCircuitBreakerSample</code> Gradle task to run a +</pre></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_interactive_sample"></a>Interactive sample</h4></div></div></div><p>From the sources you can run the <code class="literal">runCircuitBreakerSample</code> Gradle task to run a simple interactive example. Youâll need a MBean client to connect to the sample, VisualVM with its MBean plugin does the job. See <a class="xref" href="build-system.html" title="Polygene⢠Build System">Build System</a> if you need some guidance.</p></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="footer"><p> http://git-wip-us.apache.org/repos/asf/polygene-website/blob/538baaf6/content/java/develop/library-constraints.html ---------------------------------------------------------------------- diff --git a/content/java/develop/library-constraints.html b/content/java/develop/library-constraints.html index 98c0504..4351369 100644 --- a/content/java/develop/library-constraints.html +++ b/content/java/develop/library-constraints.html @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html xmlns="http://www.w3.org/1999/xhtml";><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Constraints</title><link rel="stylesheet" type="text/css" href="css/style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="" /><link rel="up" href="libraries.html" title="Libraries" /><link rel="prev" href="library-circuitbreaker.html" title="Circuit Breaker" /><link rel="next" href="library-fileconfig.html" title="FileConfig" /> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html xmlns="http://www.w3.org/1999/xhtml";><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Constraints</title><link rel="stylesheet" type="text/css" href="css/style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="" /><link rel="up" href="libraries.html" title="Libraries" /><link rel="prev" href="library-circuitbreaker.html" title="Circuit Breaker" /><link rel="next" href="library-fileconfig.html" title="FileConfig" /> <!-- favicon --> @@ -66,10 +66,10 @@ })(); </script> - </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="logo"><a href="index.html"><img src="images/logo-standard.png" /></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl><dt><span class="section"><a href="index.html#home">Polygeneâ¢</a></span></dt><dt><span class="section"><a href="intro.html">Introduction</a></span></dt><dt><span class="section"><a href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a href="samples.html">Samples</a></span></dt><dt><span class="section"><a href="core.html">Core</a></span></dt><dt><span class="section"><span xmlns="" href="libraries.html">Libraries</span></span></dt><dt><span class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a href="tools.html">Tools</a></span></dt><dt><span class="section"><a href="glossary.ht ml">Glossary </a></span></dt></dl></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="sub-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl><dt><span class="section"><a href="libraries.html#_overview_5">Overview</a></span></dt><dt><span class="section"><a href="scripting.html">Scripting</a></span></dt><dt><span class="section"><a href="library-alarm.html">Alarms</a></span></dt><dt><span class="section"><a href="library-circuitbreaker.html">Circuit Breaker</a></span></dt><dt><span class="section"><span xmlns="" href="library-constraints.html">Constraints</span></span></dt><dt><span class="section"><a href="library-fileconfig.html">FileConfig</a></span></dt><dt><span class="section"><a href="library-http.html">HTTP</a></span></dt><dt><span class="section"><a href="library-invocation-cache.html">Invocation Cache</a></span></dt><dt><span class="section"><a href="library-jmx.html">JMX</a></span></dt><dt><span class="section"><a href="library-locking.html"> Locking</a></span></dt><dt><span class="section"><a href="library-logging.html">Logging</a></span></dt><dt><span class="section"><a href="library-osgi.html">OSGi</a></span></dt><dt><span class="section"><a href="library-rdf.html">RDF</a></span></dt><dt><span class="section"><a href="library-rest-client.html">ReST Client</a></span></dt><dt><span class="section"><a href="library-rest-client-primer.html">ReST - HATEOAS Primer</a></span></dt><dt><span class="section"><a href="library-rest-common.html">ReST Common</a></span></dt><dt><span class="section"><a href="library-rest-server.html">ReST Server</a></span></dt><dt><span class="section"><a href="library-restlet.html">Restlet Support</a></span></dt><dt><span class="section"><a href="library-servlet.html">Servlet</a></span></dt><dt><span class="section"><a href="library-shiro.html">Shiro Security</a></span></dt><dt><span class="section"><a href="library-shiro-web.html">Shiro Web Security</a></span></dt><dt><span class="section"><a href ="library-spring.html">Spring Integration</a></span></dt><dt><span class="section"><a href="library-sql.html">SQL</a></span></dt><dt><span class="section"><a href="library-uid.html">UID</a></span></dt><dt><span class="section"><a href="library-uowfile.html">UoWFile</a></span></dt></dl></div></div><div class="section" title="Constraints"><div class="titlepage"><div><div><h3 class="title"><a id="library-constraints"></a>Constraints</h3></div></div></div><p class="remark"><em><span class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p class="devstatus-docs-good">docs</p><p class="devstatus-tests-good">tests</p><p>The Constraints library provide a bunch of often used Constraints based on the + </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="logo"><a href="index.html"><img src="images/logo-standard.png" style="width:80%;height:80%; padding-top:20px;" /></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl class="toc"><dt><span class="section"><a href="index.html#home">Polygeneâ¢</a></span></dt><dt><span class="section"><a href="intro.html">Introduction</a></span></dt><dt><span class="section"><a href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a href="samples.html">Samples</a></span></dt><dt><span class="section"><a href="core.html">Core</a></span></dt><dt><span class="section"><span xmlns="" href="libraries.html">Libraries</span></span></dt><dt><span class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a href="tools.html">Tools</ a></span></dt><dt><span class="section"><a href="glossary.html">Glossary </a></span></dt></dl></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="sub-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl class="toc"><dt><span class="section"><a href="libraries.html#_overview_5">Overview</a></span></dt><dt><span class="section"><a href="scripting.html">Scripting</a></span></dt><dt><span class="section"><a href="library-alarm.html">Alarms</a></span></dt><dt><span class="section"><a href="library-circuitbreaker.html">Circuit Breaker</a></span></dt><dt><span class="section"><span xmlns="" href="library-constraints.html">Constraints</span></span></dt><dt><span class="section"><a href="library-fileconfig.html">FileConfig</a></span></dt><dt><span class="section"><a href="library-http.html">HTTP</a></span></dt><dt><span class="section"><a href="library-invocation-cache.html">Invocation Cache</a></span></dt><dt><span class="section"><a href="library-jmx.html">JMX< /a></span></dt><dt><span class="section"><a href="library-locking.html">Locking</a></span></dt><dt><span class="section"><a href="library-logging.html">Logging</a></span></dt><dt><span class="section"><a href="library-osgi.html">OSGi</a></span></dt><dt><span class="section"><a href="library-rdf.html">RDF</a></span></dt><dt><span class="section"><a href="library-rest-client.html">ReST Client</a></span></dt><dt><span class="section"><a href="library-rest-client-primer.html">ReST - HATEOAS Primer</a></span></dt><dt><span class="section"><a href="library-rest-common.html">ReST Common</a></span></dt><dt><span class="section"><a href="library-rest-server.html">ReST Server</a></span></dt><dt><span class="section"><a href="library-servlet.html">Servlet</a></span></dt><dt><span class="section"><a href="library-shiro.html">Shiro Security</a></span></dt><dt><span class="section"><a href="library-shiro-web.html">Shiro Web Security</a></span></dt><dt><span class="section"><a href="library-spring .html">Spring Integration</a></span></dt><dt><span class="section"><a href="library-sql.html">SQL</a></span></dt><dt><span class="section"><a href="library-uid.html">UID</a></span></dt><dt><span class="section"><a href="library-uowfile.html">UoWFile</a></span></dt></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="library-constraints"></a>Constraints</h3></div></div></div><p class="remark"><em><span class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p class="devstatus-docs-good">docs</p><p class="devstatus-tests-good">tests</p><p>The Constraints library provide a bunch of often used Constraints based on the Polygene⢠Constraints api described in <a class="xref" href="glossary.html#def-constraint">Constraint</a>.</p><p>Remember that you are not limited to constraints presents in this library, you are encouraged to write your own constraints. See <a class="xref" href="howto-create-constraint.html" title="Create a Constraint">Create a Constraint</a> -or take a look at this library source code to learn how to write your own.</p><div class="table"><a id="idm229754650720"></a><p class="title"><strong>Table 25. Artifact</strong></p><div class="table-contents"><table summary="Artifact" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group ID</th><th align="left" valign="top">Artifact ID</th><th align="left" valign="top">Version</th></tr></thead><tbody><tr><td align="left" valign="top"><p>org.apache.polygene.libraries</p></td><td align="left" valign="top"><p>org.apache.polygene.library.constraints</p></td><td align="left" valign="top"><p>3.1.0-SNAPSHOT</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section" title="Usage"><div class="titlepage"><div><div><h4 class="title"><a id="_usage_3"></a>Usage</h4></div></div></div><p>You can use theses constraints on Properties or on method arguments. +or take a look at this library source code to learn how to write your own.</p><div class="table"><a id="idm4657"></a><p class="title"><strong>Table 25. Artifact</strong></p><div class="table-contents"><table class="table" summary="Artifact" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group ID</th><th align="left" valign="top">Artifact ID</th><th align="left" valign="top">Version</th></tr></thead><tbody><tr><td align="left" valign="top"><p>org.apache.polygene.libraries</p></td><td align="left" valign="top"><p>org.apache.polygene.library.constraints</p></td><td align="left" valign="top"><p>0</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_usage_3"></a>Usage</h4></div></div></div><p>You can use theses constraints on Properties or on method arguments. Here are some examples:</p><pre class="programlisting brush: java">import org.apache.polygene.library.constraints.annotation.*; [...snip...] http://git-wip-us.apache.org/repos/asf/polygene-website/blob/538baaf6/content/java/develop/library-fileconfig.html ---------------------------------------------------------------------- diff --git a/content/java/develop/library-fileconfig.html b/content/java/develop/library-fileconfig.html index 99d9c1c..ce25428 100644 --- a/content/java/develop/library-fileconfig.html +++ b/content/java/develop/library-fileconfig.html @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html xmlns="http://www.w3.org/1999/xhtml";><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>FileConfig</title><link rel="stylesheet" type="text/css" href="css/style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="" /><link rel="up" href="libraries.html" title="Libraries" /><link rel="prev" href="library-constraints.html" title="Constraints" /><link rel="next" href="library-http.html" title="HTTP" /> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html xmlns="http://www.w3.org/1999/xhtml";><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>FileConfig</title><link rel="stylesheet" type="text/css" href="css/style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="" /><link rel="up" href="libraries.html" title="Libraries" /><link rel="prev" href="library-constraints.html" title="Constraints" /><link rel="next" href="library-http.html" title="HTTP" /> <!-- favicon --> @@ -66,7 +66,7 @@ })(); </script> - </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="logo"><a href="index.html"><img src="images/logo-standard.png" /></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl><dt><span class="section"><a href="index.html#home">Polygeneâ¢</a></span></dt><dt><span class="section"><a href="intro.html">Introduction</a></span></dt><dt><span class="section"><a href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a href="samples.html">Samples</a></span></dt><dt><span class="section"><a href="core.html">Core</a></span></dt><dt><span class="section"><span xmlns="" href="libraries.html">Libraries</span></span></dt><dt><span class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a href="tools.html">Tools</a></span></dt><dt><span class="section"><a href="glossary.ht ml">Glossary </a></span></dt></dl></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="sub-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl><dt><span class="section"><a href="libraries.html#_overview_5">Overview</a></span></dt><dt><span class="section"><a href="scripting.html">Scripting</a></span></dt><dt><span class="section"><a href="library-alarm.html">Alarms</a></span></dt><dt><span class="section"><a href="library-circuitbreaker.html">Circuit Breaker</a></span></dt><dt><span class="section"><a href="library-constraints.html">Constraints</a></span></dt><dt><span class="section"><span xmlns="" href="library-fileconfig.html">FileConfig</span></span></dt><dt><span class="section"><a href="library-http.html">HTTP</a></span></dt><dt><span class="section"><a href="library-invocation-cache.html">Invocation Cache</a></span></dt><dt><span class="section"><a href="library-jmx.html">JMX</a></span></dt><dt><span class="section"><a href="library-locking.html"> Locking</a></span></dt><dt><span class="section"><a href="library-logging.html">Logging</a></span></dt><dt><span class="section"><a href="library-osgi.html">OSGi</a></span></dt><dt><span class="section"><a href="library-rdf.html">RDF</a></span></dt><dt><span class="section"><a href="library-rest-client.html">ReST Client</a></span></dt><dt><span class="section"><a href="library-rest-client-primer.html">ReST - HATEOAS Primer</a></span></dt><dt><span class="section"><a href="library-rest-common.html">ReST Common</a></span></dt><dt><span class="section"><a href="library-rest-server.html">ReST Server</a></span></dt><dt><span class="section"><a href="library-restlet.html">Restlet Support</a></span></dt><dt><span class="section"><a href="library-servlet.html">Servlet</a></span></dt><dt><span class="section"><a href="library-shiro.html">Shiro Security</a></span></dt><dt><span class="section"><a href="library-shiro-web.html">Shiro Web Security</a></span></dt><dt><span class="section"><a href ="library-spring.html">Spring Integration</a></span></dt><dt><span class="section"><a href="library-sql.html">SQL</a></span></dt><dt><span class="section"><a href="library-uid.html">UID</a></span></dt><dt><span class="section"><a href="library-uowfile.html">UoWFile</a></span></dt></dl></div></div><div class="section" title="FileConfig"><div class="titlepage"><div><div><h3 class="title"><a id="library-fileconfig"></a>FileConfig</h3></div></div></div><p class="remark"><em><span class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p class="devstatus-docs-good">docs</p><p class="devstatus-tests-good">tests</p><p>The FileConfig library provide a service for accessing application-specific directories.</p><p>A lot of the Polygene⢠Libraries and Extensions make use of this library to locate files.</p><div class="table"><a id="idm229754630832"></a><p class="title"><strong>Table 26. Artifact</strong></p><div class="table-contents"><table summary="Artifact" border="1"> <colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group ID</th><th align="left" valign="top">Artifact ID</th><th align="left" valign="top">Version</th></tr></thead><tbody><tr><td align="left" valign="top"><p>org.apache.polygene.libraries</p></td><td align="left" valign="top"><p>org.apache.polygene.library.fileconfig</p></td><td align="left" valign="top"><p>3.1.0-SNAPSHOT</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section" title="Usage"><div class="titlepage"><div><div><h4 class="title"><a id="_usage_4"></a>Usage</h4></div></div></div><pre class="programlisting brush: java">public interface FileConfiguration + </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="logo"><a href="index.html"><img src="images/logo-standard.png" style="width:80%;height:80%; padding-top:20px;" /></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl class="toc"><dt><span class="section"><a href="index.html#home">Polygeneâ¢</a></span></dt><dt><span class="section"><a href="intro.html">Introduction</a></span></dt><dt><span class="section"><a href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a href="samples.html">Samples</a></span></dt><dt><span class="section"><a href="core.html">Core</a></span></dt><dt><span class="section"><span xmlns="" href="libraries.html">Libraries</span></span></dt><dt><span class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a href="tools.html">Tools</ a></span></dt><dt><span class="section"><a href="glossary.html">Glossary </a></span></dt></dl></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="sub-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl class="toc"><dt><span class="section"><a href="libraries.html#_overview_5">Overview</a></span></dt><dt><span class="section"><a href="scripting.html">Scripting</a></span></dt><dt><span class="section"><a href="library-alarm.html">Alarms</a></span></dt><dt><span class="section"><a href="library-circuitbreaker.html">Circuit Breaker</a></span></dt><dt><span class="section"><a href="library-constraints.html">Constraints</a></span></dt><dt><span class="section"><span xmlns="" href="library-fileconfig.html">FileConfig</span></span></dt><dt><span class="section"><a href="library-http.html">HTTP</a></span></dt><dt><span class="section"><a href="library-invocation-cache.html">Invocation Cache</a></span></dt><dt><span class="section"><a href="library-jmx.html">JMX< /a></span></dt><dt><span class="section"><a href="library-locking.html">Locking</a></span></dt><dt><span class="section"><a href="library-logging.html">Logging</a></span></dt><dt><span class="section"><a href="library-osgi.html">OSGi</a></span></dt><dt><span class="section"><a href="library-rdf.html">RDF</a></span></dt><dt><span class="section"><a href="library-rest-client.html">ReST Client</a></span></dt><dt><span class="section"><a href="library-rest-client-primer.html">ReST - HATEOAS Primer</a></span></dt><dt><span class="section"><a href="library-rest-common.html">ReST Common</a></span></dt><dt><span class="section"><a href="library-rest-server.html">ReST Server</a></span></dt><dt><span class="section"><a href="library-servlet.html">Servlet</a></span></dt><dt><span class="section"><a href="library-shiro.html">Shiro Security</a></span></dt><dt><span class="section"><a href="library-shiro-web.html">Shiro Web Security</a></span></dt><dt><span class="section"><a href="library-spring .html">Spring Integration</a></span></dt><dt><span class="section"><a href="library-sql.html">SQL</a></span></dt><dt><span class="section"><a href="library-uid.html">UID</a></span></dt><dt><span class="section"><a href="library-uowfile.html">UoWFile</a></span></dt></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="library-fileconfig"></a>FileConfig</h3></div></div></div><p class="remark"><em><span class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p class="devstatus-docs-good">docs</p><p class="devstatus-tests-good">tests</p><p>The FileConfig library provide a service for accessing application-specific directories.</p><p>A lot of the Polygene⢠Libraries and Extensions make use of this library to locate files.</p><div class="table"><a id="idm4688"></a><p class="title"><strong>Table 26. Artifact</strong></p><div class="table-contents"><table class="table" summary="Artifact" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group ID</th><th align="left" valign="top">Artifact ID</th><th align="left" valign="top">Version</th></tr></thead><tbody><tr><td align="left" valign="top"><p>org.apache.polygene.libraries</p></td><td align="left" valign="top"><p>org.apache.polygene.library.fileconfig</p></td><td align="left" valign="top"><p>0</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_usage_4"></a>Usage</h4></div></div></div><pre class="programlisting brush: java">public interface FileConfiguration { [...snip...] http://git-wip-us.apache.org/repos/asf/polygene-website/blob/538baaf6/content/java/develop/library-http.html ---------------------------------------------------------------------- diff --git a/content/java/develop/library-http.html b/content/java/develop/library-http.html index cfcf2a0..b8c3403 100644 --- a/content/java/develop/library-http.html +++ b/content/java/develop/library-http.html @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html xmlns="http://www.w3.org/1999/xhtml";><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>HTTP</title><link rel="stylesheet" type="text/css" href="css/style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="" /><link rel="up" href="libraries.html" title="Libraries" /><link rel="prev" href="library-fileconfig.html" title="FileConfig" /><link rel="next" href="library-invocation-cache.html" title="Invocation Cache" /> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html xmlns="http://www.w3.org/1999/xhtml";><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>HTTP</title><link rel="stylesheet" type="text/css" href="css/style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="" /><link rel="up" href="libraries.html" title="Libraries" /><link rel="prev" href="library-fileconfig.html" title="FileConfig" /><link rel="next" href="library-invocation-cache.html" title="Invocation Cache" /> <!-- favicon --> @@ -66,23 +66,23 @@ })(); </script> - </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="logo"><a href="index.html"><img src="images/logo-standard.png" /></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl><dt><span class="section"><a href="index.html#home">Polygeneâ¢</a></span></dt><dt><span class="section"><a href="intro.html">Introduction</a></span></dt><dt><span class="section"><a href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a href="samples.html">Samples</a></span></dt><dt><span class="section"><a href="core.html">Core</a></span></dt><dt><span class="section"><span xmlns="" href="libraries.html">Libraries</span></span></dt><dt><span class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a href="tools.html">Tools</a></span></dt><dt><span class="section"><a href="glossary.ht ml">Glossary </a></span></dt></dl></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="sub-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl><dt><span class="section"><a href="libraries.html#_overview_5">Overview</a></span></dt><dt><span class="section"><a href="scripting.html">Scripting</a></span></dt><dt><span class="section"><a href="library-alarm.html">Alarms</a></span></dt><dt><span class="section"><a href="library-circuitbreaker.html">Circuit Breaker</a></span></dt><dt><span class="section"><a href="library-constraints.html">Constraints</a></span></dt><dt><span class="section"><a href="library-fileconfig.html">FileConfig</a></span></dt><dt><span class="section"><span xmlns="" href="library-http.html">HTTP</span></span></dt><dt><span class="section"><a href="library-invocation-cache.html">Invocation Cache</a></span></dt><dt><span class="section"><a href="library-jmx.html">JMX</a></span></dt><dt><span class="section"><a href="library-locking.html"> Locking</a></span></dt><dt><span class="section"><a href="library-logging.html">Logging</a></span></dt><dt><span class="section"><a href="library-osgi.html">OSGi</a></span></dt><dt><span class="section"><a href="library-rdf.html">RDF</a></span></dt><dt><span class="section"><a href="library-rest-client.html">ReST Client</a></span></dt><dt><span class="section"><a href="library-rest-client-primer.html">ReST - HATEOAS Primer</a></span></dt><dt><span class="section"><a href="library-rest-common.html">ReST Common</a></span></dt><dt><span class="section"><a href="library-rest-server.html">ReST Server</a></span></dt><dt><span class="section"><a href="library-restlet.html">Restlet Support</a></span></dt><dt><span class="section"><a href="library-servlet.html">Servlet</a></span></dt><dt><span class="section"><a href="library-shiro.html">Shiro Security</a></span></dt><dt><span class="section"><a href="library-shiro-web.html">Shiro Web Security</a></span></dt><dt><span class="section"><a href ="library-spring.html">Spring Integration</a></span></dt><dt><span class="section"><a href="library-sql.html">SQL</a></span></dt><dt><span class="section"><a href="library-uid.html">UID</a></span></dt><dt><span class="section"><a href="library-uowfile.html">UoWFile</a></span></dt></dl></div></div><div class="section" title="HTTP"><div class="titlepage"><div><div><h3 class="title"><a id="library-http"></a>HTTP</h3></div></div></div><p class="remark"><em><span class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p class="devstatus-docs-good">docs</p><p class="devstatus-tests-good">tests</p><p>The HTTP library provides a Jetty based embedded HTTP service with support for easy event listeners, servlets and + </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="logo"><a href="index.html"><img src="images/logo-standard.png" style="width:80%;height:80%; padding-top:20px;" /></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl class="toc"><dt><span class="section"><a href="index.html#home">Polygeneâ¢</a></span></dt><dt><span class="section"><a href="intro.html">Introduction</a></span></dt><dt><span class="section"><a href="tutorials.html">Tutorials</a></span></dt><dt><span class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a href="samples.html">Samples</a></span></dt><dt><span class="section"><a href="core.html">Core</a></span></dt><dt><span class="section"><span xmlns="" href="libraries.html">Libraries</span></span></dt><dt><span class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a href="tools.html">Tools</ a></span></dt><dt><span class="section"><a href="glossary.html">Glossary </a></span></dt></dl></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common"; class="sub-nav"><div xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl class="toc"><dt><span class="section"><a href="libraries.html#_overview_5">Overview</a></span></dt><dt><span class="section"><a href="scripting.html">Scripting</a></span></dt><dt><span class="section"><a href="library-alarm.html">Alarms</a></span></dt><dt><span class="section"><a href="library-circuitbreaker.html">Circuit Breaker</a></span></dt><dt><span class="section"><a href="library-constraints.html">Constraints</a></span></dt><dt><span class="section"><a href="library-fileconfig.html">FileConfig</a></span></dt><dt><span class="section"><span xmlns="" href="library-http.html">HTTP</span></span></dt><dt><span class="section"><a href="library-invocation-cache.html">Invocation Cache</a></span></dt><dt><span class="section"><a href="library-jmx.html">JMX< /a></span></dt><dt><span class="section"><a href="library-locking.html">Locking</a></span></dt><dt><span class="section"><a href="library-logging.html">Logging</a></span></dt><dt><span class="section"><a href="library-osgi.html">OSGi</a></span></dt><dt><span class="section"><a href="library-rdf.html">RDF</a></span></dt><dt><span class="section"><a href="library-rest-client.html">ReST Client</a></span></dt><dt><span class="section"><a href="library-rest-client-primer.html">ReST - HATEOAS Primer</a></span></dt><dt><span class="section"><a href="library-rest-common.html">ReST Common</a></span></dt><dt><span class="section"><a href="library-rest-server.html">ReST Server</a></span></dt><dt><span class="section"><a href="library-servlet.html">Servlet</a></span></dt><dt><span class="section"><a href="library-shiro.html">Shiro Security</a></span></dt><dt><span class="section"><a href="library-shiro-web.html">Shiro Web Security</a></span></dt><dt><span class="section"><a href="library-spring .html">Spring Integration</a></span></dt><dt><span class="section"><a href="library-sql.html">SQL</a></span></dt><dt><span class="section"><a href="library-uid.html">UID</a></span></dt><dt><span class="section"><a href="library-uowfile.html">UoWFile</a></span></dt></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="library-http"></a>HTTP</h3></div></div></div><p class="remark"><em><span class="comment"></span></em></p><p class="devstatus-code-stable">code</p><p class="devstatus-docs-good">docs</p><p class="devstatus-tests-good">tests</p><p>The HTTP library provides a Jetty based embedded HTTP service with support for easy event listeners, servlets and filters assembly as Services.</p><p>Itâs an easy way to embedd a servlet container and reuse everything that can be run in it (JAX-*, Restlet, Wicket, -Vaadin, GWT etc..). If instead you want to run a Polygene⢠Application in a servlet container, see <a class="xref" href="library-servlet.html" title="Servlet">Servlet Library</a>.</p><div class="table"><a id="idm229754604752"></a><p class="title"><strong>Table 27. Artifact</strong></p><div class="table-contents"><table summary="Artifact" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group ID</th><th align="left" valign="top">Artifact ID</th><th align="left" valign="top">Version</th></tr></thead><tbody><tr><td align="left" valign="top"><p>org.apache.polygene.libraries</p></td><td align="left" valign="top"><p>org.apache.polygene.library.http</p></td><td align="left" valign="top"><p>3.1.0-SNAPSHOT</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section" title="Create an EventListenerService"><div class="titlepage"><div><div><h4 class="title"><a id="_create_an_eve ntlistenerservice"></a>Create an EventListenerService</h4></div></div></div><p>EventListeners in HttpService are assembled as Services, so one have to declare a ServiceComposite like this:</p><pre class="programlisting brush: java">@Mixins( FooServletContextListener.class ) +Vaadin, GWT etc..). If instead you want to run a Polygene⢠Application in a servlet container, see <a class="xref" href="library-servlet.html" title="Servlet">Servlet Library</a>.</p><div class="table"><a id="idm4727"></a><p class="title"><strong>Table 27. Artifact</strong></p><div class="table-contents"><table class="table" summary="Artifact" border="1"><colgroup><col class="col_1" /><col class="col_2" /><col class="col_3" /></colgroup><thead><tr><th align="left" valign="top">Group ID</th><th align="left" valign="top">Artifact ID</th><th align="left" valign="top">Version</th></tr></thead><tbody><tr><td align="left" valign="top"><p>org.apache.polygene.libraries</p></td><td align="left" valign="top"><p>org.apache.polygene.library.http</p></td><td align="left" valign="top"><p>0</p></td></tr></tbody></table></div></div><br class="table-break" /><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_create_an_eventlistenerservice"></a>Create an EventListener Service</h4></div></div></div><p>EventListeners in HttpService are assembled as Services, so one have to declare a ServiceComposite like this:</p><pre class="programlisting brush: java">@Mixins( FooServletContextListener.class ) public interface FooServletContextListenerService extends ServletContextListener, ServiceComposite { } -</pre></div><div class="section" title="Create a ServletService"><div class="titlepage"><div><div><h4 class="title"><a id="_create_a_servletservice"></a>Create a ServletService</h4></div></div></div><p>Servlets in HttpService are assembled as Services, so one have to declare a ServiceComposite like this:</p><pre class="programlisting brush: java">@Mixins( HelloWorldServlet.class ) +</pre></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_create_a_servletservice"></a>Create a ServletService</h4></div></div></div><p>Servlets in HttpService are assembled as Services, so one have to declare a ServiceComposite like this:</p><pre class="programlisting brush: java">@Mixins( HelloWorldServlet.class ) public interface HelloWorldServletService extends Servlet, ServiceComposite { } -</pre></div><div class="section" title="Create a FilterService"><div class="titlepage"><div><div><h4 class="title"><a id="_create_a_filterservice"></a>Create a FilterService</h4></div></div></div><p>Itâs the same for Filters. As an example here is the bundled UnitOfWorkFilterService declaration:</p><pre class="programlisting brush: java">@Mixins( UnitOfWorkFilter.class ) +</pre></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_create_a_filterservice"></a>Create a FilterService</h4></div></div></div><p>Itâs the same for Filters. As an example here is the bundled UnitOfWorkFilterService declaration:</p><pre class="programlisting brush: java">@Mixins( UnitOfWorkFilter.class ) public interface UnitOfWorkFilterService extends Filter { } -</pre></div><div class="section" title="Jetty Service"><div class="titlepage"><div><div><h4 class="title"><a id="_jetty_service"></a>Jetty Service</h4></div></div></div><div class="section" title="Assembly"><div class="titlepage"><div><div><h5 class="title"><a id="_assembly_3"></a>Assembly</h5></div></div></div><p>The HTTP library provide a JettyServiceAssembler and a fluent API to easily assemble Servlets and Filters.</p><pre class="programlisting brush: java">// Assemble the JettyService +</pre></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_jetty_service"></a>Jetty Service</h4></div></div></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a id="_assembly_3"></a>Assembly</h5></div></div></div><p>The HTTP library provide a JettyServiceAssembler and a fluent API to easily assemble Servlets and Filters.</p><pre class="programlisting brush: java">// Assemble the JettyService new JettyServiceAssembler().withConfig( configModule, Visibility.layer ).assemble( module ); // Set HTTP port as JettyConfiguration default @@ -108,14 +108,14 @@ config.statistics().set( Boolean.TRUE ); // Set statistics default to TRUE in co // Hello world servlet related assembly addServlets( serve( "/hello" ).with( HelloWorldServletService.class ) ).to( module ); -</pre></div><div class="section" title="Configuration"><div class="titlepage"><div><div><h5 class="title"><a id="_configuration"></a>Configuration</h5></div></div></div><p>Underlying Jetty engine configuration is exposed as a Polygene⢠Service Configuration. +</pre></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a id="_configuration"></a>Configuration</h5></div></div></div><p>Underlying Jetty engine configuration is exposed as a Polygene⢠Service Configuration. The only one that is mandatory is the port.</p><p>See org.apache.polygene.library.http.JettyConfiguration for a reference of all available -configuration properties.</p></div></div><div class="section" title="Secure Jetty Service"><div class="titlepage"><div><div><h4 class="title"><a id="_secure_jetty_service"></a>Secure Jetty Service</h4></div></div></div><p>The HTTP library provides a second HttpService that brings SSL support.</p><div class="section" title="Assembly"><div class="titlepage"><div><div><h5 class="title"><a id="_assembly_4"></a>Assembly</h5></div></div></div><p>Simply change from JettyServiceAssembler to SecureJettyServiceAssembler:</p><pre class="programlisting brush: java">new SecureJettyServiceAssembler().withConfig( configModule, Visibility.layer ).assemble( module ); +configuration properties.</p></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a id="_secure_jetty_service"></a>Secure Jetty Service</h4></div></div></div><p>The HTTP library provides a second HttpService that brings SSL support.</p><div class="section"><div class="titlepage"><div><div><h5 class="title"><a id="_assembly_4"></a>Assembly</h5></div></div></div><p>Simply change from JettyServiceAssembler to SecureJettyServiceAssembler:</p><pre class="programlisting brush: java">new SecureJettyServiceAssembler().withConfig( configModule, Visibility.layer ).assemble( module ); [...snip...] addServlets( serve( "/hello" ).with( HelloWorldServletService.class ) ).to( module ); addFilters( filter( "/*" ).through( UnitOfWorkFilterService.class ).on( REQUEST ) ).to( module ); -</pre></div><div class="section" title="Configuration"><div class="titlepage"><div><div><h5 class="title"><a id="_configuration_2"></a>Configuration</h5></div></div></div><p>You must at least configure a KeyStore using the three related properties. All the other +</pre></div><div class="section"><div class="titlepage"><div><div><h5 class="title"><a id="_configuration_2"></a>Configuration</h5></div></div></div><p>You must at least configure a KeyStore using the three related properties. All the other ones have sensible defaults.</p><p>If you want, or need, to do client certificate authentication youâll need to configure at least a "trust store", a KeyStore that contains your trusted trust anchors.</p><p>Here is some code that set HTTP port a well as a KeyStore and a TrustStore as SecureJettyConfiguration default during assembly:</p><pre class="programlisting brush: java">SecureJettyConfiguration config = configModule.forMixin( SecureJettyConfiguration.class ).declareDefaults();
