KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > excalibur > monitor > ActiveMonitor


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6  
7  Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  
9  Redistribution and use in source and binary forms, with or without modifica-
10  tion, are permitted provided that the following conditions are met:
11  
12  1. Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14  
15  2. Redistributions in binary form must reproduce the above copyright notice,
16     this list of conditions and the following disclaimer in the documentation
17     and/or other materials provided with the distribution.
18  
19  3. The end-user documentation included with the redistribution, if any, must
20     include the following acknowledgment: "This product includes software
21     developed by the Apache Software Foundation (http://www.apache.org/)."
22     Alternately, this acknowledgment may appear in the software itself, if
23     and wherever such third-party acknowledgments normally appear.
24  
25  4. The names "Jakarta", "Avalon", "Excalibur" and "Apache Software Foundation"
26     must not be used to endorse or promote products derived from this software
27     without prior written permission. For written permission, please contact
28     apache@apache.org.
29  
30  5. Products derived from this software may not be called "Apache", nor may
31     "Apache" appear in their name, without prior written permission of the
32     Apache Software Foundation.
33  
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45  This software consists of voluntary contributions made by many individuals
46  on behalf of the Apache Software Foundation. For more information on the
47  Apache Software Foundation, please see <http://www.apache.org/>.
48  
49 */
50 package org.apache.avalon.excalibur.monitor;
51
52 import org.apache.avalon.framework.activity.Startable;
53 import org.apache.avalon.framework.configuration.Configurable;
54 import org.apache.avalon.framework.configuration.Configuration;
55 import org.apache.avalon.framework.configuration.ConfigurationException;
56 import org.apache.avalon.framework.logger.LogEnabled;
57 import org.apache.avalon.framework.logger.Logger;
58 import org.apache.avalon.framework.thread.ThreadSafe;
59
60 /**
61  * The ActiveMonitor is used to actively check a set of resources to see if they have
62  * changed. It will be implemented as a Component, that can be retrieved from
63  * the ComponentLocator. It defaults to checking every 1 minute. The configuration
64  * looks like this:
65  *
66  * <pre>
67  * &lt;active-monitor&gt;
68  * &lt;thread priority="<i>5</i>" frequency="<i>60000</i>"/&gt;
69  * &lt;init-resources&gt;
70  * &lt;-- This entry can be repeated for every resource you want to register immediately --&gt;
71  *
72  * &lt;resource key="<i>file:./myfile.html</i>" class="<i>org.apache.avalon.excalibur.monitor.FileResource</i>"/&gt;
73  * &lt;/init-resources&gt;
74  * &lt;/active-monitor&gt;
75  * </pre>
76  *
77  * @avalon.component
78  * @avalon.service type=org.apache.avalon.excalibur.monitor.Monitor
79  * @x-avalon.info name=active-monitor
80  * @x-avalon.lifestyle type=singleton
81  *
82  * @author <a HREF="mailto:bloritsch@apache.org">Berin Loritsch</a>
83  * @version $Id: ActiveMonitor.java,v 1.20 2003/05/23 17:41:04 bloritsch Exp $
84  */
85 public class ActiveMonitor
86     extends org.apache.avalon.excalibur.monitor.impl.ActiveMonitor
87     implements LogEnabled, Configurable, Startable, ThreadSafe
88 {
89     private Logger m_logger;
90
91     public void enableLogging( final Logger logger )
92     {
93         m_logger = logger;
94     }
95
96     /**
97      * Configure the ActiveMonitor.
98      */
99     public final void configure( final Configuration config )
100         throws ConfigurationException
101     {
102         final Configuration thread = config.getChild( "thread" );
103         final long frequency =
104             thread.getAttributeAsLong( "frequency", 1000L * 60L );
105         final int priority =
106             thread.getAttributeAsInteger( "priority", Thread.MIN_PRIORITY );
107
108         setFrequency( frequency );
109         setPriority( priority );
110
111         if( m_logger.isDebugEnabled() )
112         {
113             m_logger.debug( "Active monitor will sample all resources every " +
114                             frequency + " milliseconds with a thread priority of " +
115                             priority + "(Minimum = " + Thread.MIN_PRIORITY +
116                             ", Normal = " + Thread.NORM_PRIORITY +
117                             ", Maximum = " + Thread.MAX_PRIORITY + ")." );
118         }
119
120         final Configuration[] resourcesConfig =
121             config.getChild( "init-resources" ).getChildren( "resource" );
122         final Resource[] resources =
123             MonitorUtil.configureResources( resourcesConfig, m_logger );
124         addResources( resources );
125     }
126 }
127
Popular Tags