http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/97bc8884/extensions/mod_injection.html ---------------------------------------------------------------------- diff --git a/extensions/mod_injection.html b/extensions/mod_injection.html deleted file mode 100644 index 21e5bf1..0000000 --- a/extensions/mod_injection.html +++ /dev/null @@ -1,676 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";> - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta charset="utf-8"/> - <title>Apache Tamaya&#8201;&#8212;&#8201;Extension: Injection</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"/> - <meta name="description" content=""/> - <meta name="author" content=""/> - <meta name="keywords" content=""/> - <meta name="generator" content="'JBake '+'${version}"/> - - <!-- Le styles --> - <link href="../css/bootstrap.min.css" rel="stylesheet"/> - <link href="../css/asciidoctor.css" rel="stylesheet"/> - <link href="../css/base.css" rel="stylesheet"/> - <link href="../css/prettify.css" rel="stylesheet"/> - - <!-- HTML5 shim, for IE6-8 support of HTML5 elements --> - <!--[if lt IE 9]> - <script src="../js/html5shiv.min.js"></script> - <![endif]--> - - <!-- Fav and touch icons from ASF --> - <link rel="shortcut icon" href="../favicon.ico"/> - <link rel="apple-touch-icon" sizes="57x57" href="../favicons/apple-touch-icon-57x57.png"/> - <link rel="apple-touch-icon" sizes="60x60" href="../favicons/apple-touch-icon-60x60.png"/> - <link rel="apple-touch-icon" sizes="72x72" href="../favicons/apple-touch-icon-72x72.png"/> - <link rel="apple-touch-icon" sizes="76x76" href="../favicons/apple-touch-icon-76x76.png"/> - <link rel="apple-touch-icon" sizes="114x114" href="../favicons/apple-touch-icon-114x114.png"/> - <link rel="apple-touch-icon" sizes="120x120" href="../favicons/apple-touch-icon-120x120.png"/> - <link rel="apple-touch-icon" sizes="144x144" href="../favicons/apple-touch-icon-144x144.png"/> - <link rel="apple-touch-icon" sizes="152x152" href="../favicons/apple-touch-icon-152x152.png"/> - <link rel="apple-touch-icon" sizes="180x180" href="../favicons/apple-touch-icon-180x180.png"/> - <link rel="icon" type="image/png" href="../favicons/favicon-32x32.png" sizes="32x32"/> - <link rel="icon" type="image/png" href="../favicons/favicon-194x194.png" sizes="194x194"/> - <link rel="icon" type="image/png" href="../favicons/favicon-96x96.png" sizes="96x96"/> - <link rel="icon" type="image/png" href="../favicons/android-chrome-192x192.png" sizes="192x192"/> - <link rel="icon" type="image/png" href="../favicons/favicon-16x16.png" sizes="16x16"/> - <link rel="manifest" href="../favicons/manifest.json"/> - <link rel="shortcut icon" href="../favicons/favicon.ico"/> - <meta name="msapplication-TileColor" content="#603cba"/> - <meta name="msapplication-TileImage" content="../favicons/mstile-144x144.png"/> - <meta name="msapplication-config" content="../favicons/browserconfig.xml"/> - <meta name="theme-color" content="#303284"/> - </head> - <body onload="prettyPrint()"> - <div id="wrap"> - <div> - - <!-- Fixed navbar --> - <div class="navbar navbar-default navbar-fixed-top" role="navigation"> - <div class="container"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="../">Apache Tamaya (incubating)</a> - </div> - <div class="navbar-collapse collapse"> - <ul class="nav navbar-nav"> - <li><a href="../index.html">Home</a></li> - <li><a href="../quickstart.html">Quickstart</a></li> - <li><a href="../index.html">Documentation</a></li> - <li><a href="..//apidocs/index.html">API</a></li> - <li><a href="../index.html">Development</a></li> - <li><a href="../index.html">Releases</a></li> - <li><a href="../about.html">About</a></li> - <li><a href="../sitemap.xml">Sitemap</a></li> - <li><a href="../feed.xml">Subscribe</a></li> -<!-- - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li><a href="#">Action</a></li> - <li><a href="#">Another action</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li class="dropdown-header">Nav header</li> - <li><a href="#">Separated link</a></li> - <li><a href="#">One more separated link</a></li> - </ul> - </li> ---> - </ul> - </div><!--/.nav-collapse --> - </div> - </div> - - </div> - <div class="container"> - - <div class="page-header"> - <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: Injection</h1> - </div> - - <p><em>2016-10-31</em></p> - - <p><div id="preamble"> -<div class="sectionbody"> -<!-- toc disabled --> -</div> -</div> -<div class="sect1"> -<h2 id="Core">Tamaya Injection (Extension Module)</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_overview">Overview</h3> -<div class="paragraph"> -<p>Tamaya Injection is an extension module. Refer to the <a href="modules.html">extensions documentation</a> for further details -about modules.</p> -</div> -<div class="paragraph"> -<p>Tamaya Injection provides functionality for injecting configured values into beans, or creating configuration -template instances.</p> -</div> -<div class="paragraph"> -<p>Inversion of Control (aka IoC/the Hollywood Principle) has proven to be very useful and effective in avoiding boilerplate -code. In Java there are different frameworks available that all provide IoC mechanisms. Unfortunately IoC is not a -built-in language feature. So for a portable solution that works also in Java SE Tamaya itself has to provide the -according injection services. This module adds this functionality to Tamaya.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 7, so it can be used with Java 7 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>Basically Tamaya’s injection API is deployed as API artifact:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> - <groupId>org.apache.tamaya.ext</groupId> - <artifactId>tamaya-injection-api</artifactId> - <version>{tamayaVersion}</version> -</dependency></code></pre> -</div> -</div> -<div class="paragraph"> -<p>To use injection with Java SE you must add the corresponding dependency to your module:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> - <groupId>org.apache.tamaya.ext</groupId> - <artifactId>tamaya-injection</artifactId> - <version>{tamayaVersion}</version> -</dependency></code></pre> -</div> -</div> -<div class="paragraph"> -<p>Similarly there are other injection implementations available, targetig platforms such as</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>Spring, Spring Boot</p> -</li> -<li> -<p>Java EE/CDI</p> -</li> -<li> -<p>OSGI, Apache Felix/Apache Karaf</p> -</li> -</ul> -</div> -</div> -<div class="sect2"> -<h3 id="_core_concepts">Core Concepts</h3> -<div class="paragraph"> -<p>Basically you annotate fields or methods in your beans with @Config to enable configuration injection. Tamaya -additionally defines further annotations that allo you to define additional aspects such as default values, custom -converters etc. The following example illustrates the basic functionality: -code snippet:</p> -</div> -<div class="listingblock"> -<div class="title">Annotated Example Class</div> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">package foo.bar; - -public class ConfiguredClass{ - - // resolved by default, using property name, class and package name: foo.bar.ConfiguredClass.testProperty - private String testProperty; - - // Trying to resolve mutiple keys, with a default value, if none could be resolved - @Config({"a.b.c.key1","a.b.legacyKey",area1.key2"}, defaultValue="The current \\${JAVA_HOME} env property is ${env:JAVA_HOME}.") - String value1; - - // Typical case - @Config("a.b.c.key2") - private int value2; - - // resolved by default as foo.bar.ConfiguredClass.accessUrl - // Using a (default) String -> URL converter - @Config(defaultValue="http://127.0.0.1:8080/res/api/v1/info.json";) - private URL accessUrl; - - // Config injection disabled for this property - @NoConfig - private Integer int1; - - // Overriding the String -> BigDecimal converter with a custom implementation. - @Config("BD") - @WithPropertyConverter(MyBigDecimalRoundingAdapter.class) - private BigDecimal bigNumber; - - ... -}</code></pre> -</div> -</div> -<div class="paragraph"> -<p>When configuring data or configuration classes it is also possible to auto-inject the fields identified. For activating -this feature a class must be annotated with @ConfigAutoInject:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">. An autoinjected bean class --------------------------------------------- -package a.b;</code></pre> -</div> -</div> -<div class="paragraph"> -<p>@ConfigAutoInject -public final class Tenant{ - private int id; - private String name; - private String description; - @NoConfig // prevents auto injection for this field - private String id2;</p> -</div> -<div class="literalblock"> -<div class="content"> -<pre> public int getId(){ - return id; - } - public String getName(){ - return name; - } - public String getDescription(){ - return description; - } -}</pre> -</div> -</div> -<div class="listingblock"> -<div class="content"> -<pre>These examples do not show all possibilities provided. Configuring instance of these -class using Tamaya is very simple: Just pass the instance to Tamaya to let -Tamaya inject the configuration (or throw a +ConfigException+, if this is not possible): - -[source,java] -.Configuring the +ConfiguredClass+ Instance</pre> -</div> -</div> -<div class="paragraph"> -<p>ConfiguredClass classInstance = new ConfiguredClass(); -ConfigurationInjector.configure(configuredClass);</p> -</div> -<div class="paragraph"> -<p>Tenant tenant = new Tenant(); -ConfigurationInjector.configure(tenant);</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre>NOTE: Configuration injection works similarly, when used with other integration modules, e.g. when Tamaya is used -with CDI, Spring or within an OSGI container. For further details refer also to the corresponding integration module's -documentation. - - -=== The Annotations in detail -==== The ConfigurationInjector - -The +ConfigurationInjector+ interface provides methods that allow any kind of instances to be configured -by passing the instances to +T ConfigurationInjector.getInstance().configure(T);+. The classes passed -hereby must not be annotated with +@Config+ for being configurable. By default Tamaya -tries to determine configuration for each property of an instance passed, using the following resolution policy: - -Given a class +a.b.MyClass+ and a field +myField+ it would try to look up the following keys: -[source, listing]</pre> -</div> -</div> -<div class="paragraph"> -<p>a.b.MyClass.myField -a.b.MyClass.my-field -MyClass.myField -MyClass.my-field -myField -my-field</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre>So given the following properties: - -[source, properties]</pre> -</div> -</div> -<div class="paragraph"> -<p>a.b.Tenant.id=1234 -Tenant.description=Any kind of tenant. -name=<unnamed></p> -</div> -<div class="listingblock"> -<div class="content"> -<pre>==== Accessing ConfiguredItemSupplier instances - -In many cases you want to create a supplier that simply creates instances that are correctly configured as defined -by the current context. This can be done using +Suppliers+: - -[source, java]</pre> -</div> -</div> -<div class="paragraph"> -<p>ConfiguredItemSupplier<Tenant> configuredTenantSupplier = ConfigurationInjector.getInstance().getConfiguredSupplier( - new ConfiguredItemSupplier<Tenant>(){ - public Tenant get(){ - return new Tenant(); - } -});</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre>With Java 8 it's even more simpler: - -[source, java]</pre> -</div> -</div> -<div class="paragraph"> -<p>ConfiguredItemSupplier<Tenant> configuredTenantSupplier = ConfigurationInjector.getInstance().getConfiguredSupplier( - Tenant::new);</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre>Hereby this annotation can be used in multiple ways and combined with other annotations such as +@DefaultValue+, -+@WithLoadPolicy+, +@WithConfigOperator+, +@WithPropertyConverter+. - -==== Minimal Example - -To illustrate the mechanism below the most simple variant of a configured class is given: - -[source,java] -.Most simple configured class</pre> -</div> -</div> -<div class="paragraph"> -<p>pubic class ConfiguredItem{ - @Config - private String aValue; -}</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre>When this class is configured, e.g. by passing it to +ConfigurationInjector.getInstance().configure(Object)+, -the following is happening: - -* The current valid +Configuration+ is evaluated by calling +Configuration cfg = ConfigurationProvider.getConfiguration();+ -* The current property value (String) is evaluated by calling +cfg.get("aValue");+ for each possible key (mutliple - keys are possible). -* if not successful, an error is thrown (+ConfigException+) -* On success, since no type conversion is involved, the value is injected. - -==== Using @DefaultValue - -In the next example we explicitly define the property value: -[source,java]</pre> -</div> -</div> -<div class="paragraph"> -<p>pubic class ConfiguredItem{</p> -</div> -<div class="literalblock"> -<div class="content"> -<pre> @Config({"aValue", "a.b.value","a.b.deprecated.value"}, defaultValue="${env:java.version}") - private String aValue; -}</pre> -</div> -</div> -<div class="listingblock"> -<div class="content"> -<pre>==== Inject a DynamicValue Property - -Within this example we evaluate a dynamic value. This mechanism allows you to listen for configuration changes and to -commit new values exactly, when convenient for you. - -[source,java]</pre> -</div> -</div> -<div class="paragraph"> -<p>pubic class ConfiguredItem{</p> -</div> -<div class="literalblock"> -<div class="content"> -<pre> @Config({"aValue", "a.b.value","a.b.deprecated.value"}, defaultValue="${env:java.version}") - private DynamicValue aValue; -}</pre> -</div> -</div> -<div class="listingblock"> -<div class="content"> -<pre>The +DynamicValue+ provides you the following functionality: - -[source,java]</pre> -</div> -</div> -<div class="paragraph"> -<p>public interface DynamicValue<T> {</p> -</div> -<div class="literalblock"> -<div class="content"> -<pre>enum UpdatePolicy{ - IMMEDIATE, - EXPLCIT, - NEVER, - LOG_AND_DISCARD -}</pre> -</div> -</div> -<div class="literalblock"> -<div class="content"> -<pre>T get(); -T getNewValue(); -T evaluateValue(); -T commitAndGet(); -void commit(); -void discard(); -boolean updateValue();</pre> -</div> -</div> -<div class="literalblock"> -<div class="content"> -<pre>void setUpdatePolicy(UpdatePolicy updatePolicy); -UpdatePolicy getUpdatePolicy(); -void addListener(PropertyChangeListener l); -void removeListener(PropertyChangeListener l);</pre> -</div> -</div> -<div class="literalblock"> -<div class="content"> -<pre>boolean isPresent(); -T orElse(T other); -T orElseGet(ConfiguredItemSupplier<? extends T> other); -<X extends Throwable> T orElseThrow(ConfiguredItemSupplier<? extends X> exceptionSupplier) throws X;</pre> -</div> -</div> -<div class="paragraph"> -<p>}</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre>Summarizing this class looks somehow similar to the new +Optional+ class added with Java 8. It provides -a wrapper class around a configured instance. Additionally this class provides functionality that gives -active control, to manage a configured value based on a ++LoadingPolicy+: - -* +IMMEDEATE+ means that when the configuration system detects a change on the underlying value, the new value - is automatically applied without any further notice. -* +EXPLICIT+ means that a new configuration value is signalled by setting the +newValue+ property. if +getNewValue()+ - returns a non null value, the new value can be applied by calling +commit()+. You can always access the newest value, - hereby implicitly applying it, by accessing it via +commitAndGet()+. Also it is possible ti ignore a change by calling - +discard()+. -* +NEVER+ means the configured value is evaluated once and never updated. All changes are silently discarded. -* +LOG_AND_DISCARD+ similar to +NEVER+, but changes are logged before they are discarded. - -Summarizing a +DynamicValue+ allows you - -* to reload actively updates of configured values. -* update implicitly or explicitly all changes on the value. -* add listeners that observe changes of a certain value. - -Dynamic values also allow on-the-fly reevaluation of the value by calling +evaluateValue()+. Hereby the value of the -instance is not changed. - - -==== Ommitting Injection using @NoConfig - -Adding the @NoConfig annotation prevents a field or method to be auto-injected from -configuration. This is especially useful, if a type is annotated as @ConfigAutoInject with auto-confiuration -turned on as follows: - -[source,java]</pre> -</div> -</div> -<div class="paragraph"> -<p>@ConfigAutoInject -pubic class ConfiguredItem{</p> -</div> -<div class="literalblock"> -<div class="content"> -<pre>@NoConfig -private transient int sum;</pre> -</div> -</div> -<div class="literalblock"> -<div class="content"> -<pre> private String a; - private String b; - Private String c; -}</pre> -</div> -</div> -<div class="listingblock"> -<div class="content"> -<pre>In this case the fields +a,b,c+ are configured, whereas the field +sum+ is ignored regarding -configuration. - -==== Adding custom operators using @WithConfigOperator - -The @WithConfigOperator annotation allows you define a class of type +ConfigOperator+, to being applied -to the final +Configuration+, BEFORE the value is injected. This can be used for various use cases, e.g. -filtering or validating the visible properties for a certain use case. - -[source,java]</pre> -</div> -</div> -<div class="paragraph"> -<p>@WithConfigOperator(MyConfigView.class) -pubic class ConfiguredItem{</p> -</div> -<div class="literalblock"> -<div class="content"> -<pre>@Config -private String a;</pre> -</div> -</div> -<div class="paragraph"> -<p>}</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre>==== Adding custom property converters using @WithPropertyConverter - -The @WithPropertyConverter annotation allows you to define a class of type +PropertyConverter+, to be applied -on a property configured to convert the String value to the expected injected type. This can be used for -various use cases, e.g. adding custom formats, config models, decryption. - -[source,java]</pre> -</div> -</div> -<div class="paragraph"> -<p>pubic class ConfiguredItem{</p> -</div> -<div class="literalblock"> -<div class="content"> -<pre>@WithPropertyConverter(MyPropertyConverter.class) -@Config -private String a;</pre> -</div> -</div> -<div class="paragraph"> -<p>}</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre>==== Defining the loading policy to be applied to configured values using @WithLoadPolicy - -The @WithLoadPolicy annotation allows to define the loading behaviour to be applied. The +LoadPolicy+ -enum hereby defines the various loading modes. - -[source,java]</pre> -</div> -</div> -<div class="paragraph"> -<p>@WithLoadPolicy(LoadPolicy.NEVER) -pubic class BootTimeStableConfig{</p> -</div> -<div class="literalblock"> -<div class="content"> -<pre>@WithPropertyConverter(MyPropertyConverter.class) -@Config -private String a;</pre> -</div> -</div> -<div class="paragraph"> -<p>}</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre>=== Configuration Events - -Similar to CDI Tamaya publishes Configuration events, when instances were configured. It depends on the effective -event backend in use, if and how events are published: - -* when you have the CDI extension active events are published using the default CDI event mechanism. -* in all other scenarios events are delegated to the +tamaya-events+ module, if available, -* if no event delegation is available no events are published. - -The event published is very simple: - -[source,java]</pre> -</div> -</div> -<div class="paragraph"> -<p>public interface ConfiguredType { - Class getType(); - String getName(); - public Collection<ConfiguredField> getConfiguredFields(); - Collection<ConfiguredMethod> getConfiguredMethods(); - void configure(Object instance, Configuration config); -}</p> -</div> -<div class="paragraph"> -<p>public interface ConfiguredField { - Class<?> getType(); - Collection<String> getConfiguredKeys(); - String getName(); - String getSignature(); - Field getAnnotatedField(); - void configure(Object instance, Configuration config); -}</p> -</div> -<div class="paragraph"> -<p>public interface ConfiguredMethod { - Collection<String> getConfiguredKeys(); - Class<?>[] getParameterTypes(); - Method getAnnotatedMethod(); - String getName(); - String getSignature(); - void configure(Object instance, Configuration config); -}</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre></pre> -</div> -</div> -</div> -</div> -</div></p> - - <hr /> - </div> - </div> - <div> - <div id="push"></div> - - <div id="footer"> - <div class="container"> - <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> - | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> - </p> - <p> - <b>Disclaimer</b> - Apache Tamaya (incubating) is an effort undergoing - incubation at - The Apache Software Foundation (ASF), sponsored by - the name of Apache Incubator. Incubation is required of - all newly accepted projects until a further review indicates - that the infrastructure, communications, and decision making - process have stabilized in a manner consistent with other - successful ASF projects. While incubation status is not - necessarily a reflection of the completeness or stability of - the code, it does indicate that the project has yet to - be fully endorsed by the ASF.<br /> - <a href="http://incubator.apache.org/guides/website.html"; style="border:0px;" target="_target"><img class="incubator-logo" src="../logos/egg-logo2.png"/></a> - </p> - </div> - </div> - - <!-- Le javascript - ================================================== --> - <!-- Placed at the end of the document so the pages load faster --> - <script src="../js/jquery-1.11.1.min.js"></script> - <script src="../js/bootstrap.min.js"></script> - <script src="../js/prettify.js"></script> - - </div> - </body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/97bc8884/extensions/mod_jodatime.html ---------------------------------------------------------------------- diff --git a/extensions/mod_jodatime.html b/extensions/mod_jodatime.html deleted file mode 100644 index a4fe20d..0000000 --- a/extensions/mod_jodatime.html +++ /dev/null @@ -1,200 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";> - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta charset="utf-8"/> - <title>Apache Tamaya&#8201;&#8212;&#8201;Extension: JodaTime</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"/> - <meta name="description" content=""/> - <meta name="author" content=""/> - <meta name="keywords" content=""/> - <meta name="generator" content="'JBake '+'${version}"/> - - <!-- Le styles --> - <link href="../css/bootstrap.min.css" rel="stylesheet"/> - <link href="../css/asciidoctor.css" rel="stylesheet"/> - <link href="../css/base.css" rel="stylesheet"/> - <link href="../css/prettify.css" rel="stylesheet"/> - - <!-- HTML5 shim, for IE6-8 support of HTML5 elements --> - <!--[if lt IE 9]> - <script src="../js/html5shiv.min.js"></script> - <![endif]--> - - <!-- Fav and touch icons from ASF --> - <link rel="shortcut icon" href="../favicon.ico"/> - <link rel="apple-touch-icon" sizes="57x57" href="../favicons/apple-touch-icon-57x57.png"/> - <link rel="apple-touch-icon" sizes="60x60" href="../favicons/apple-touch-icon-60x60.png"/> - <link rel="apple-touch-icon" sizes="72x72" href="../favicons/apple-touch-icon-72x72.png"/> - <link rel="apple-touch-icon" sizes="76x76" href="../favicons/apple-touch-icon-76x76.png"/> - <link rel="apple-touch-icon" sizes="114x114" href="../favicons/apple-touch-icon-114x114.png"/> - <link rel="apple-touch-icon" sizes="120x120" href="../favicons/apple-touch-icon-120x120.png"/> - <link rel="apple-touch-icon" sizes="144x144" href="../favicons/apple-touch-icon-144x144.png"/> - <link rel="apple-touch-icon" sizes="152x152" href="../favicons/apple-touch-icon-152x152.png"/> - <link rel="apple-touch-icon" sizes="180x180" href="../favicons/apple-touch-icon-180x180.png"/> - <link rel="icon" type="image/png" href="../favicons/favicon-32x32.png" sizes="32x32"/> - <link rel="icon" type="image/png" href="../favicons/favicon-194x194.png" sizes="194x194"/> - <link rel="icon" type="image/png" href="../favicons/favicon-96x96.png" sizes="96x96"/> - <link rel="icon" type="image/png" href="../favicons/android-chrome-192x192.png" sizes="192x192"/> - <link rel="icon" type="image/png" href="../favicons/favicon-16x16.png" sizes="16x16"/> - <link rel="manifest" href="../favicons/manifest.json"/> - <link rel="shortcut icon" href="../favicons/favicon.ico"/> - <meta name="msapplication-TileColor" content="#603cba"/> - <meta name="msapplication-TileImage" content="../favicons/mstile-144x144.png"/> - <meta name="msapplication-config" content="../favicons/browserconfig.xml"/> - <meta name="theme-color" content="#303284"/> - </head> - <body onload="prettyPrint()"> - <div id="wrap"> - <div> - - <!-- Fixed navbar --> - <div class="navbar navbar-default navbar-fixed-top" role="navigation"> - <div class="container"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="../">Apache Tamaya (incubating)</a> - </div> - <div class="navbar-collapse collapse"> - <ul class="nav navbar-nav"> - <li><a href="../index.html">Home</a></li> - <li><a href="../quickstart.html">Quickstart</a></li> - <li><a href="../index.html">Documentation</a></li> - <li><a href="..//apidocs/index.html">API</a></li> - <li><a href="../index.html">Development</a></li> - <li><a href="../index.html">Releases</a></li> - <li><a href="../about.html">About</a></li> - <li><a href="../sitemap.xml">Sitemap</a></li> - <li><a href="../feed.xml">Subscribe</a></li> -<!-- - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li><a href="#">Action</a></li> - <li><a href="#">Another action</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li class="dropdown-header">Nav header</li> - <li><a href="#">Separated link</a></li> - <li><a href="#">One more separated link</a></li> - </ul> - </li> ---> - </ul> - </div><!--/.nav-collapse --> - </div> - </div> - - </div> - <div class="container"> - - <div class="page-header"> - <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: JodaTime</h1> - </div> - - <p><em>2016-10-31</em></p> - - <p><div id="preamble"> -<div class="sectionbody"> -<!-- toc disabled --> -</div> -</div> -<div class="sect1"> -<h2 id="Core">Tamaya JodaTime (Extension Module)</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_overview">Overview</h3> -<div class="paragraph"> -<p>Tamaya JodaTime is an extension module to support the usage of <a href="http://www.joda.org/joda-time/";>Joda-Time</a> -in conjunction with Tamaya. Tamaya JodaTime defines some additional property -converters to retrieve Joda-Time types from a given configuration.</p> -</div> -<div class="paragraph"> -<p>Refer to the <a href="modules.html">extensions documentation</a> for further details -about modules.</p> -</div> -<div class="paragraph"> -<p>tools to locate resources in your classpath or file system based on descriptive -ant-styled resource patterns. To use this module add the following dependency:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-listing" data-lang="listing"><dependency> - <grooupId>org.apache.tamaya.ext</groupId> - <artifactId>tamaya-jodatime</artifactId> - <version>{tamayaVersion}</version> -</dependency></code></pre> -</div> -</div> -<div class="paragraph"> -<p>After adding this dependency to your project you can retrieve -Joda-Time based values directly from a given configuration.</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">Configuration configuration = ConfigurationProvider.getConfiguration(); - -DateTime pit = configuration.get("pointInTime", DateTime.class)</code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_specifying_date_and_time_values">Specifying date and time values</h3> -<div class="paragraph"> -<p>To be written.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_specifing_periods_and_durations">Specifing periods and durations</h3> -<div class="paragraph"> -<p>To be written.</p> -</div> -</div> -</div> -</div></p> - - <hr /> - </div> - </div> - <div> - <div id="push"></div> - - <div id="footer"> - <div class="container"> - <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> - | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> - </p> - <p> - <b>Disclaimer</b> - Apache Tamaya (incubating) is an effort undergoing - incubation at - The Apache Software Foundation (ASF), sponsored by - the name of Apache Incubator. Incubation is required of - all newly accepted projects until a further review indicates - that the infrastructure, communications, and decision making - process have stabilized in a manner consistent with other - successful ASF projects. While incubation status is not - necessarily a reflection of the completeness or stability of - the code, it does indicate that the project has yet to - be fully endorsed by the ASF.<br /> - <a href="http://incubator.apache.org/guides/website.html"; style="border:0px;" target="_target"><img class="incubator-logo" src="../logos/egg-logo2.png"/></a> - </p> - </div> - </div> - - <!-- Le javascript - ================================================== --> - <!-- Placed at the end of the document so the pages load faster --> - <script src="../js/jquery-1.11.1.min.js"></script> - <script src="../js/bootstrap.min.js"></script> - <script src="../js/prettify.js"></script> - - </div> - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/97bc8884/extensions/mod_json.html ---------------------------------------------------------------------- diff --git a/extensions/mod_json.html b/extensions/mod_json.html deleted file mode 100644 index ee8fd48..0000000 --- a/extensions/mod_json.html +++ /dev/null @@ -1,211 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";> - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta charset="utf-8"/> - <title>Apache Tamaya&#8201;&#8212;&#8201;Extension: Builder</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"/> - <meta name="description" content=""/> - <meta name="author" content=""/> - <meta name="keywords" content=""/> - <meta name="generator" content="'JBake '+'${version}"/> - - <!-- Le styles --> - <link href="../css/bootstrap.min.css" rel="stylesheet"/> - <link href="../css/asciidoctor.css" rel="stylesheet"/> - <link href="../css/base.css" rel="stylesheet"/> - <link href="../css/prettify.css" rel="stylesheet"/> - - <!-- HTML5 shim, for IE6-8 support of HTML5 elements --> - <!--[if lt IE 9]> - <script src="../js/html5shiv.min.js"></script> - <![endif]--> - - <!-- Fav and touch icons from ASF --> - <link rel="shortcut icon" href="../favicon.ico"/> - <link rel="apple-touch-icon" sizes="57x57" href="../favicons/apple-touch-icon-57x57.png"/> - <link rel="apple-touch-icon" sizes="60x60" href="../favicons/apple-touch-icon-60x60.png"/> - <link rel="apple-touch-icon" sizes="72x72" href="../favicons/apple-touch-icon-72x72.png"/> - <link rel="apple-touch-icon" sizes="76x76" href="../favicons/apple-touch-icon-76x76.png"/> - <link rel="apple-touch-icon" sizes="114x114" href="../favicons/apple-touch-icon-114x114.png"/> - <link rel="apple-touch-icon" sizes="120x120" href="../favicons/apple-touch-icon-120x120.png"/> - <link rel="apple-touch-icon" sizes="144x144" href="../favicons/apple-touch-icon-144x144.png"/> - <link rel="apple-touch-icon" sizes="152x152" href="../favicons/apple-touch-icon-152x152.png"/> - <link rel="apple-touch-icon" sizes="180x180" href="../favicons/apple-touch-icon-180x180.png"/> - <link rel="icon" type="image/png" href="../favicons/favicon-32x32.png" sizes="32x32"/> - <link rel="icon" type="image/png" href="../favicons/favicon-194x194.png" sizes="194x194"/> - <link rel="icon" type="image/png" href="../favicons/favicon-96x96.png" sizes="96x96"/> - <link rel="icon" type="image/png" href="../favicons/android-chrome-192x192.png" sizes="192x192"/> - <link rel="icon" type="image/png" href="../favicons/favicon-16x16.png" sizes="16x16"/> - <link rel="manifest" href="../favicons/manifest.json"/> - <link rel="shortcut icon" href="../favicons/favicon.ico"/> - <meta name="msapplication-TileColor" content="#603cba"/> - <meta name="msapplication-TileImage" content="../favicons/mstile-144x144.png"/> - <meta name="msapplication-config" content="../favicons/browserconfig.xml"/> - <meta name="theme-color" content="#303284"/> - </head> - <body onload="prettyPrint()"> - <div id="wrap"> - <div> - - <!-- Fixed navbar --> - <div class="navbar navbar-default navbar-fixed-top" role="navigation"> - <div class="container"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="../">Apache Tamaya (incubating)</a> - </div> - <div class="navbar-collapse collapse"> - <ul class="nav navbar-nav"> - <li><a href="../index.html">Home</a></li> - <li><a href="../quickstart.html">Quickstart</a></li> - <li><a href="../index.html">Documentation</a></li> - <li><a href="..//apidocs/index.html">API</a></li> - <li><a href="../index.html">Development</a></li> - <li><a href="../index.html">Releases</a></li> - <li><a href="../about.html">About</a></li> - <li><a href="../sitemap.xml">Sitemap</a></li> - <li><a href="../feed.xml">Subscribe</a></li> -<!-- - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li><a href="#">Action</a></li> - <li><a href="#">Another action</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li class="dropdown-header">Nav header</li> - <li><a href="#">Separated link</a></li> - <li><a href="#">One more separated link</a></li> - </ul> - </li> ---> - </ul> - </div><!--/.nav-collapse --> - </div> - </div> - - </div> - <div class="container"> - - <div class="page-header"> - <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: Builder</h1> - </div> - - <p><em>2016-10-31</em></p> - - <p><div id="preamble"> -<div class="sectionbody"> -<!-- toc disabled --> -</div> -</div> -<div class="sect1"> -<h2 id="BuilderCore">Tamaya JSON (Extension Module)</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_overview">Overview</h3> -<div class="paragraph"> -<p>The Tamaya json module provides support for reading configuration using the JSON format:</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 7, so it will not run on Java 7 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To benefit from configuration builder support you only must add the corresponding dependency to your module:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> - <groupId>org.apache.tamaya.ext</groupId> - <artifactId>tamaya-json</artifactId> - <version>{tamayaVersion}</version> -</dependency></code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_reading_configuration_in_json">Reading configuration in JSON</h3> -<div class="paragraph"> -<p>For reading JSON based onfiguration most easily a JSONFormat can be provided:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">ConfigurationData dataRead = ConfigurationFormats.readConfig( - getClassLoader().getResource("myFileConfig.json"), new JSONFormat()));</code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_examples">Examples</h3> -<div class="paragraph"> -<p>The JSON module adds instances of ConfigurationFormat so JSON configuration can be read and mapped to the -according property maps. E.g. the following file is a simple and correct JSON configuration:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-listing" data-lang="listing">{ - "a" : "A", - "b" : "B", - "c" : "C", - "d" : { - "o" : "O", - "p" : "P" - } -}</code></pre> -</div> -</div> -</div> -</div> -</div></p> - - <hr /> - </div> - </div> - <div> - <div id="push"></div> - - <div id="footer"> - <div class="container"> - <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> - | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> - </p> - <p> - <b>Disclaimer</b> - Apache Tamaya (incubating) is an effort undergoing - incubation at - The Apache Software Foundation (ASF), sponsored by - the name of Apache Incubator. Incubation is required of - all newly accepted projects until a further review indicates - that the infrastructure, communications, and decision making - process have stabilized in a manner consistent with other - successful ASF projects. While incubation status is not - necessarily a reflection of the completeness or stability of - the code, it does indicate that the project has yet to - be fully endorsed by the ASF.<br /> - <a href="http://incubator.apache.org/guides/website.html"; style="border:0px;" target="_target"><img class="incubator-logo" src="../logos/egg-logo2.png"/></a> - </p> - </div> - </div> - - <!-- Le javascript - ================================================== --> - <!-- Placed at the end of the document so the pages load faster --> - <script src="../js/jquery-1.11.1.min.js"></script> - <script src="../js/bootstrap.min.js"></script> - <script src="../js/prettify.js"></script> - - </div> - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/97bc8884/extensions/mod_management.html ---------------------------------------------------------------------- diff --git a/extensions/mod_management.html b/extensions/mod_management.html deleted file mode 100644 index eccc0c7..0000000 --- a/extensions/mod_management.html +++ /dev/null @@ -1,274 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";> - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta charset="utf-8"/> - <title>Apache Tamaya&#8201;&#8212;&#8201;Extension: JMX Management Access</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"/> - <meta name="description" content=""/> - <meta name="author" content=""/> - <meta name="keywords" content=""/> - <meta name="generator" content="'JBake '+'${version}"/> - - <!-- Le styles --> - <link href="../css/bootstrap.min.css" rel="stylesheet"/> - <link href="../css/asciidoctor.css" rel="stylesheet"/> - <link href="../css/base.css" rel="stylesheet"/> - <link href="../css/prettify.css" rel="stylesheet"/> - - <!-- HTML5 shim, for IE6-8 support of HTML5 elements --> - <!--[if lt IE 9]> - <script src="../js/html5shiv.min.js"></script> - <![endif]--> - - <!-- Fav and touch icons from ASF --> - <link rel="shortcut icon" href="../favicon.ico"/> - <link rel="apple-touch-icon" sizes="57x57" href="../favicons/apple-touch-icon-57x57.png"/> - <link rel="apple-touch-icon" sizes="60x60" href="../favicons/apple-touch-icon-60x60.png"/> - <link rel="apple-touch-icon" sizes="72x72" href="../favicons/apple-touch-icon-72x72.png"/> - <link rel="apple-touch-icon" sizes="76x76" href="../favicons/apple-touch-icon-76x76.png"/> - <link rel="apple-touch-icon" sizes="114x114" href="../favicons/apple-touch-icon-114x114.png"/> - <link rel="apple-touch-icon" sizes="120x120" href="../favicons/apple-touch-icon-120x120.png"/> - <link rel="apple-touch-icon" sizes="144x144" href="../favicons/apple-touch-icon-144x144.png"/> - <link rel="apple-touch-icon" sizes="152x152" href="../favicons/apple-touch-icon-152x152.png"/> - <link rel="apple-touch-icon" sizes="180x180" href="../favicons/apple-touch-icon-180x180.png"/> - <link rel="icon" type="image/png" href="../favicons/favicon-32x32.png" sizes="32x32"/> - <link rel="icon" type="image/png" href="../favicons/favicon-194x194.png" sizes="194x194"/> - <link rel="icon" type="image/png" href="../favicons/favicon-96x96.png" sizes="96x96"/> - <link rel="icon" type="image/png" href="../favicons/android-chrome-192x192.png" sizes="192x192"/> - <link rel="icon" type="image/png" href="../favicons/favicon-16x16.png" sizes="16x16"/> - <link rel="manifest" href="../favicons/manifest.json"/> - <link rel="shortcut icon" href="../favicons/favicon.ico"/> - <meta name="msapplication-TileColor" content="#603cba"/> - <meta name="msapplication-TileImage" content="../favicons/mstile-144x144.png"/> - <meta name="msapplication-config" content="../favicons/browserconfig.xml"/> - <meta name="theme-color" content="#303284"/> - </head> - <body onload="prettyPrint()"> - <div id="wrap"> - <div> - - <!-- Fixed navbar --> - <div class="navbar navbar-default navbar-fixed-top" role="navigation"> - <div class="container"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="../">Apache Tamaya (incubating)</a> - </div> - <div class="navbar-collapse collapse"> - <ul class="nav navbar-nav"> - <li><a href="../index.html">Home</a></li> - <li><a href="../quickstart.html">Quickstart</a></li> - <li><a href="../index.html">Documentation</a></li> - <li><a href="..//apidocs/index.html">API</a></li> - <li><a href="../index.html">Development</a></li> - <li><a href="../index.html">Releases</a></li> - <li><a href="../about.html">About</a></li> - <li><a href="../sitemap.xml">Sitemap</a></li> - <li><a href="../feed.xml">Subscribe</a></li> -<!-- - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li><a href="#">Action</a></li> - <li><a href="#">Another action</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li class="dropdown-header">Nav header</li> - <li><a href="#">Separated link</a></li> - <li><a href="#">One more separated link</a></li> - </ul> - </li> ---> - </ul> - </div><!--/.nav-collapse --> - </div> - </div> - - </div> - <div class="container"> - - <div class="page-header"> - <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: JMX Management Access</h1> - </div> - - <p><em>2016-10-31</em></p> - - <p><div id="preamble"> -<div class="sectionbody"> -<!-- toc disabled --> -</div> -</div> -<div class="sect1"> -<h2 id="ExtModel">Tamaya Management (JMX Support) (Extension Module)</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_overview">Overview</h3> -<div class="paragraph"> -<p>The Tamaya management module provides support for registering a JMX management bean for accessing configuration.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 7, so it will not run on Java 7 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To benefit from configuration builder support you only must add the corresponding dependency to your module:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> - <groupId>org.apache.tamaya.ext</groupId> - <artifactId>tamaya-management</artifactId> - <version>{tamayaVersion}</version> -</dependency></code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_the_managedconfigmbean_bean">The ManagedConfigMBean bean</h3> -<div class="paragraph"> -<p>The management model defines the MBean of type ManagedConfigMBean as follows:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">public interface ManagedConfigMBean { - String getJsonConfigurationInfo(); - String getXmlConfigurationInfo(); - Map<String, String> getConfiguration(); - Map<String, String> getSection(String area, boolean recursive); - Set<String> getSections(); - Set<String> getTransitiveSections(); - boolean isSectionExisting(String area); - default boolean isSectionEmpty(String area); -}</code></pre> -</div> -</div> -<div class="ulist"> -<ul> -<li> -<p>getJsonConfigurationInfo,getXmlConfigurationInfo return a JSON or XML representation of the -current configuration.</p> -</li> -<li> -<p>getConfiguration access the current configuration properties.</p> -</li> -<li> -<p>getSection allows to extract all entries below a certain subkey. With <em>recursive</em> the query -will not only return direct children, but also recursively walk down all subsection of the -given section key.</p> -</li> -<li> -<p>getSections returns all current known section names.</p> -</li> -<li> -<p>getTransitiveSections return all sections, but also adds all transitive subsection as single -entries to the set as well.</p> -</li> -<li> -<p>isSectionExisting and isSectionEmpty allow for quering if entries are present under the given -section keys.</p> -</li> -</ul> -</div> -</div> -<div class="sect2"> -<h3 id="_registering_the_managedconfigmbean">Registering the ManagedConfigMBean</h3> -<div class="paragraph"> -<p>For registering the current ManagedConfigMBean instance to the current MBean platform server, the -following static methods are available:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">public final class ConfigManagementSupport{ - - private JMXSupport(){} - - public static ObjectName registerMBean(); - public static ObjectName registerMBean(String context); - public static ObjectName unregisterMBean(); - public static ObjectName unregisterMBean(String context); -}</code></pre> -</div> -</div> -<div class="ulist"> -<ul> -<li> -<p>registerMBean creates a new ManagedConfigMBean instance using the ServiceContextManager -and registers it. Optionally an additional <em>context</em> parameter can be passed, which allows -to register the management bean for different classloaders, e.g. for different -ears.</p> -</li> -<li> -<p>unregisterMBean does the oppsite than registering obviously.</p> -</li> -</ul> -</div> -<div class="admonitionblock note"> -<table> -<tr> -<td class="icon"> -<div class="title">Note</div> -</td> -<td class="content"> -The instance of ManagedConfigMBean to be created and registered is evaluated by use og the - ServiceContextManager. So you can replace the bean implementation by registering your - overriding implementation using the current ServiceContext (by default using - java.util.ServiceLoader and @Priority annotation. -</td> -</tr> -</table> -</div> -</div> -</div> -</div></p> - - <hr /> - </div> - </div> - <div> - <div id="push"></div> - - <div id="footer"> - <div class="container"> - <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> - | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> - </p> - <p> - <b>Disclaimer</b> - Apache Tamaya (incubating) is an effort undergoing - incubation at - The Apache Software Foundation (ASF), sponsored by - the name of Apache Incubator. Incubation is required of - all newly accepted projects until a further review indicates - that the infrastructure, communications, and decision making - process have stabilized in a manner consistent with other - successful ASF projects. While incubation status is not - necessarily a reflection of the completeness or stability of - the code, it does indicate that the project has yet to - be fully endorsed by the ASF.<br /> - <a href="http://incubator.apache.org/guides/website.html"; style="border:0px;" target="_target"><img class="incubator-logo" src="../logos/egg-logo2.png"/></a> - </p> - </div> - </div> - - <!-- Le javascript - ================================================== --> - <!-- Placed at the end of the document so the pages load faster --> - <script src="../js/jquery-1.11.1.min.js"></script> - <script src="../js/bootstrap.min.js"></script> - <script src="../js/prettify.js"></script> - - </div> - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/97bc8884/extensions/mod_metamodel-staged.html ---------------------------------------------------------------------- diff --git a/extensions/mod_metamodel-staged.html b/extensions/mod_metamodel-staged.html deleted file mode 100644 index 3666895..0000000 --- a/extensions/mod_metamodel-staged.html +++ /dev/null @@ -1,229 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";> - -<html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta charset="utf-8"/> - <title>Apache Tamaya&#8201;&#8212;&#8201;Extension: Staged PropertySources</title> - <meta name="viewport" content="width=device-width, initial-scale=1.0"/> - <meta name="description" content=""/> - <meta name="author" content=""/> - <meta name="keywords" content=""/> - <meta name="generator" content="'JBake '+'${version}"/> - - <!-- Le styles --> - <link href="../css/bootstrap.min.css" rel="stylesheet"/> - <link href="../css/asciidoctor.css" rel="stylesheet"/> - <link href="../css/base.css" rel="stylesheet"/> - <link href="../css/prettify.css" rel="stylesheet"/> - - <!-- HTML5 shim, for IE6-8 support of HTML5 elements --> - <!--[if lt IE 9]> - <script src="../js/html5shiv.min.js"></script> - <![endif]--> - - <!-- Fav and touch icons from ASF --> - <link rel="shortcut icon" href="../favicon.ico"/> - <link rel="apple-touch-icon" sizes="57x57" href="../favicons/apple-touch-icon-57x57.png"/> - <link rel="apple-touch-icon" sizes="60x60" href="../favicons/apple-touch-icon-60x60.png"/> - <link rel="apple-touch-icon" sizes="72x72" href="../favicons/apple-touch-icon-72x72.png"/> - <link rel="apple-touch-icon" sizes="76x76" href="../favicons/apple-touch-icon-76x76.png"/> - <link rel="apple-touch-icon" sizes="114x114" href="../favicons/apple-touch-icon-114x114.png"/> - <link rel="apple-touch-icon" sizes="120x120" href="../favicons/apple-touch-icon-120x120.png"/> - <link rel="apple-touch-icon" sizes="144x144" href="../favicons/apple-touch-icon-144x144.png"/> - <link rel="apple-touch-icon" sizes="152x152" href="../favicons/apple-touch-icon-152x152.png"/> - <link rel="apple-touch-icon" sizes="180x180" href="../favicons/apple-touch-icon-180x180.png"/> - <link rel="icon" type="image/png" href="../favicons/favicon-32x32.png" sizes="32x32"/> - <link rel="icon" type="image/png" href="../favicons/favicon-194x194.png" sizes="194x194"/> - <link rel="icon" type="image/png" href="../favicons/favicon-96x96.png" sizes="96x96"/> - <link rel="icon" type="image/png" href="../favicons/android-chrome-192x192.png" sizes="192x192"/> - <link rel="icon" type="image/png" href="../favicons/favicon-16x16.png" sizes="16x16"/> - <link rel="manifest" href="../favicons/manifest.json"/> - <link rel="shortcut icon" href="../favicons/favicon.ico"/> - <meta name="msapplication-TileColor" content="#603cba"/> - <meta name="msapplication-TileImage" content="../favicons/mstile-144x144.png"/> - <meta name="msapplication-config" content="../favicons/browserconfig.xml"/> - <meta name="theme-color" content="#303284"/> - </head> - <body onload="prettyPrint()"> - <div id="wrap"> - <div> - - <!-- Fixed navbar --> - <div class="navbar navbar-default navbar-fixed-top" role="navigation"> - <div class="container"> - <div class="navbar-header"> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <a class="navbar-brand" href="../">Apache Tamaya (incubating)</a> - </div> - <div class="navbar-collapse collapse"> - <ul class="nav navbar-nav"> - <li><a href="../index.html">Home</a></li> - <li><a href="../quickstart.html">Quickstart</a></li> - <li><a href="../index.html">Documentation</a></li> - <li><a href="..//apidocs/index.html">API</a></li> - <li><a href="../index.html">Development</a></li> - <li><a href="../index.html">Releases</a></li> - <li><a href="../about.html">About</a></li> - <li><a href="../sitemap.xml">Sitemap</a></li> - <li><a href="../feed.xml">Subscribe</a></li> -<!-- - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a> - <ul class="dropdown-menu"> - <li><a href="#">Action</a></li> - <li><a href="#">Another action</a></li> - <li><a href="#">Something else here</a></li> - <li class="divider"></li> - <li class="dropdown-header">Nav header</li> - <li><a href="#">Separated link</a></li> - <li><a href="#">One more separated link</a></li> - </ul> - </li> ---> - </ul> - </div><!--/.nav-collapse --> - </div> - </div> - - </div> - <div class="container"> - - <div class="page-header"> - <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: Staged PropertySources</h1> - </div> - - <p><em>2016-10-31</em></p> - - <p><div id="preamble"> -<div class="sectionbody"> -<!-- toc disabled --> -</div> -</div> -<div class="sect1"> -<h2 id="Remote">Tamaya Metamodel: Staged PropertySources (Extension Module)</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_overview">Overview</h3> -<div class="paragraph"> -<p>The Tamaya Staged PropertySources extension provides a base class and default implementation for loading -multistaged configuration easily from a common configuration location.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 7, so it will not run on Java 7 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To benefit from Tamaya CDI integration you only must add the corresponding dependency to your module:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> - <groupId>org.apache.tamaya.ext.metamodels</groupId> - <artifactId>tamaya-metamodel.staged</artifactId> - <version>{tamayaVersion}</version> -</dependency></code></pre> -</div> -</div> -<div class="paragraph"> -<p>The component will not register any components. The component basically provides the following options:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>Use it as default configuration extension. Hereby you should define your stages in use by setting the -env.STAGE system property with the stages to be loaded in order of precedence (most significant last), -e.g. sys-env,DEFAULTS,TEST,DEVELOPMENT. _Additionally_ you must register -+org.apache.tamaya.staged.StagedConfigPropertiesProvider as in</p> -</li> -</ul> -</div> -<div class="listingblock"> -<div class="content"> -<pre>META-INF -|_service - |_org.apache.tamaya.spi.PropertySourceProvider</pre> -</div> -</div> -<div class="paragraph"> -<p>Tamaya will then load .properties files from System.getenv(), -classpath:DEFAULTS.properties, classpath:TEST.properties and -classpath:DEVELOPMENT.properties</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>For more advanced requirements, such as alternate locations, patterns or formats, you can also extend one of the -provided classes (org.apache.tamaya.staged.StagedConfigPropertiesProvider,</p> -<div class="ulist"> -<ul> -<li> -<p>BaseStagedPropertySourceProvider). Extending provides features such as:</p> -</li> -<li> -<p>Defining a prefix for all entries provided/loaded.</p> -</li> -<li> -<p>Using alternate locations or formats.</p> -</li> -<li> -<p>Defining the ordinals used.</p> -</li> -</ul> -</div> -</li> -</ul> -</div> -</div> -</div> -</div></p> - - <hr /> - </div> - </div> - <div> - <div id="push"></div> - - <div id="footer"> - <div class="container"> - <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> - | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> - </p> - <p> - <b>Disclaimer</b> - Apache Tamaya (incubating) is an effort undergoing - incubation at - The Apache Software Foundation (ASF), sponsored by - the name of Apache Incubator. Incubation is required of - all newly accepted projects until a further review indicates - that the infrastructure, communications, and decision making - process have stabilized in a manner consistent with other - successful ASF projects. While incubation status is not - necessarily a reflection of the completeness or stability of - the code, it does indicate that the project has yet to - be fully endorsed by the ASF.<br /> - <a href="http://incubator.apache.org/guides/website.html"; style="border:0px;" target="_target"><img class="incubator-logo" src="../logos/egg-logo2.png"/></a> - </p> - </div> - </div> - - <!-- Le javascript - ================================================== --> - <!-- Placed at the end of the document so the pages load faster --> - <script src="../js/jquery-1.11.1.min.js"></script> - <script src="../js/bootstrap.min.js"></script> - <script src="../js/prettify.js"></script> - - </div> - </body> -</html>
