001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/startup/LifecycleListenerRule.java,v 1.1 2001/10/17 00:44:02 craigmcc Exp $
003: * $Revision: 1.1 $
004: * $Date: 2001/10/17 00:44:02 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999-2001 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: */
061:
062: package org.apache.catalina.startup;
063:
064: import org.apache.catalina.Lifecycle;
065: import org.apache.catalina.LifecycleListener;
066: import org.apache.commons.digester.Digester;
067: import org.apache.commons.digester.Rule;
068: import org.xml.sax.Attributes;
069:
070: /**
071: * <p>Rule that creates a new <code>LifecycleListener</code> instance,
072: * and associates it with the top object on the stack (which must
073: * implement <code>LifecycleListener</code>).</p>
074: */
075:
076: public class LifecycleListenerRule extends Rule {
077:
078: // ----------------------------------------------------------- Constructors
079:
080: /**
081: * Construct a new instance of this Rule.
082: *
083: * @param digester Digester we are associated with
084: * @param listenerClass Default name of the LifecycleListener
085: * implementation class to be created
086: * @param attributeName Name of the attribute that optionally
087: * includes an override name of the LifecycleListener class
088: */
089: public LifecycleListenerRule(Digester digester,
090: String listenerClass, String attributeName) {
091:
092: super (digester);
093: this .listenerClass = listenerClass;
094: this .attributeName = attributeName;
095:
096: }
097:
098: // ----------------------------------------------------- Instance Variables
099:
100: /**
101: * The attribute name of an attribute that can override the
102: * implementation class name.
103: */
104: private String attributeName;
105:
106: /**
107: * The name of the <code>LifecycleListener</code> implementation class.
108: */
109: private String listenerClass;
110:
111: // --------------------------------------------------------- Public Methods
112:
113: /**
114: * Handle the beginning of an XML element.
115: *
116: * @param attributes The attributes of this element
117: *
118: * @exception Exception if a processing error occurs
119: */
120: public void begin(Attributes attributes) throws Exception {
121:
122: // Instantiate a new LifecyleListener implementation object
123: String className = listenerClass;
124: if (attributeName != null) {
125: String value = attributes.getValue(attributeName);
126: if (value != null)
127: className = value;
128: }
129: Class clazz = Class.forName(className);
130: LifecycleListener listener = (LifecycleListener) clazz
131: .newInstance();
132:
133: // Add this LifecycleListener to our associated component
134: Lifecycle lifecycle = (Lifecycle) digester.peek();
135: lifecycle.addLifecycleListener(listener);
136:
137: }
138:
139: }
|