blob: 438b490665e4249a7c59b8e050095e90f32a7b47 [file] [log] [blame]
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<document>
<properties>
<title>Fulcrum YAAFI Avalon Container Reconfiguration Service</title>
<author email="siegfried.goeschl@it20one.at">Siegfried Goeschl</author>
</properties>
<body>
<section name="Overview">
<p>
This service uses a background thread to monitor a list of configuration
files. A resource is loaded by using a resource name and an InputStreamLocator.
The a SHA-1 hashcode is derived and compared to the previous hashcode.
If a change is detected either the whole container or a list of
services are reconfigured. This service allows reconfiguration
support without using client/server communication.
</p>
</section>
<section name="Configuration">
<subsection name="Role Configuration">
<source>
<![CDATA[
<role
name="org.apache.fulcrum.yaafi.service.reconfiguration.ReconfigurationService"
shorthand="ReconfigurationService"
default-class="org.apache.fulcrum.yaafi.service.reconfiguration.ReconfigurationServiceImpl"
early-init="true"
description="Monitors configuration files to reconfigure YAAFI"
/>
]]>
</source>
</subsection>
<subsection name="Example Component Configuration">
<p>
The following configuration checks every 5 seconds
if the files have changed. Changing "TestComponentConfig"
triggers the reconfiguration of the container whereas a change
of "TestParameters.properties" would reconfigure the two
listed services.
</p>
<source>
<![CDATA[
<ReconfigurationService interval="5000">
<entry>
<location>./src/test/TestComponentConfig.xml</location>
</entry>
<entry>
<location>./src/test/TestParameters.properties</location>
<services>
<service name="org.apache.fulcrum.yaafi.TestComponent"/>
<service name="org.apache.fulcrum.yaafi.service.systemproperty.SystemPropertyService"/>
</services>
</entry>
</ReconfigurationService>
]]>
</source>
</subsection>
</section>
</body>
</document>