Java tutorial
/* * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/mbeans/GlobalResourcesLifecycleListener.java,v 1.3 2002/02/03 00:56:57 craigmcc Exp $ * $Revision: 1.3 $ * $Date: 2002/02/03 00:56:57 $ * * ==================================================================== * * The Apache Software License, Version 1.1 * * Copyright (c) 2002 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, if * any, must include the following acknowlegement: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowlegement may appear in the software itself, * if and wherever such third-party acknowlegements normally appear. * * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software * Foundation" must not be used to endorse or promote products derived * from this software without prior written permission. For written * permission, please contact apache@apache.org. * * 5. Products derived from this software may not be called "Apache" * nor may "Apache" appear in their names without prior written * permission of the Apache Group. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * <http://www.apache.org/>. * * [Additional notices, if required by prior licensing conditions] * */ package catalina.mbeans; import java.util.Iterator; import javax.naming.Binding; import javax.naming.Context; import javax.naming.InitialContext; import javax.naming.NamingEnumeration; import javax.naming.NamingException; import org.apache.catalina.Group; import org.apache.catalina.Lifecycle; import org.apache.catalina.LifecycleEvent; import org.apache.catalina.LifecycleListener; import org.apache.catalina.Role; import org.apache.catalina.User; import org.apache.catalina.UserDatabase; import org.apache.commons.modeler.Registry; /** * Implementation of <code>LifecycleListener</code> that instantiates the * set of MBeans associated with global JNDI resources that are subject to * management. * * @author Craig R. McClanahan * @version $Revision: 1.3 $ $Date: 2002/02/03 00:56:57 $ * @since 4.1 */ public class GlobalResourcesLifecycleListener implements LifecycleListener { // ----------------------------------------------------- Instance Variables /** * The owning Catalina component that we are attached to. */ protected Lifecycle component = null; /** * The configuration information registry for our managed beans. */ protected static Registry registry = MBeanUtils.createRegistry(); // ------------------------------------------------------------- Properties /** * The debugging detail level for this component. */ protected int debug = 0; public int getDebug() { return (this.debug); } public void setDebug(int debug) { this.debug = debug; } // ---------------------------------------------- LifecycleListener Methods /** * Primary entry point for startup and shutdown events. * * @param event The event that has occurred */ public void lifecycleEvent(LifecycleEvent event) { if (Lifecycle.START_EVENT.equals(event.getType())) { component = event.getLifecycle(); createMBeans(); } else if (Lifecycle.STOP_EVENT.equals(event.getType())) { destroyMBeans(); component = null; } } // ------------------------------------------------------ Protected Methods /** * Create the MBeans for the interesting global JNDI resources. */ protected void createMBeans() { // Look up our global naming context Context context = null; try { context = (Context) (new InitialContext()).lookup("java:/"); } catch (NamingException e) { e.printStackTrace(); throw new IllegalStateException("No global naming context defined for server"); } // Recurse through the defined global JNDI resources context try { createMBeans("", context); } catch (NamingException e) { log("Exception processing Global JNDI Resources", e); } } /** * Create the MBeans for the interesting global JNDI resources in * the specified naming context. * * @param prefix Prefix for complete object name paths * @param context Context to be scanned * * @exception NamingException if a JNDI exception occurs */ protected void createMBeans(String prefix, Context context) throws NamingException { if (debug >= 1) { log("Creating MBeans for Global JNDI Resources in Context '" + prefix + "'"); } NamingEnumeration bindings = context.listBindings(""); while (bindings.hasMore()) { Binding binding = (Binding) bindings.next(); String name = prefix + binding.getName(); Object value = context.lookup(binding.getName()); if (debug >= 2) { log("Checking resource " + name); } if (value instanceof Context) { createMBeans(name + "/", (Context) value); } else if (value instanceof UserDatabase) { try { createMBeans(name, (UserDatabase) value); } catch (Exception e) { log("Exception creating UserDatabase MBeans for " + name, e); } } } } /** * Create the MBeans for the specified UserDatabase and its contents. * * @param name Complete resource name of this UserDatabase * @param database The UserDatabase to be processed * * @exception Exception if an exception occurs while creating MBeans */ protected void createMBeans(String name, UserDatabase database) throws Exception { // Create the MBean for the UserDatabase itself if (debug >= 2) { log("Creating UserDatabase MBeans for resource " + name); log("Database=" + database); } if (MBeanUtils.createMBean(database) == null) { throw new IllegalArgumentException("Cannot create UserDatabase MBean for resource " + name); } // Create the MBeans for each defined Role Iterator roles = database.getRoles(); while (roles.hasNext()) { Role role = (Role) roles.next(); if (debug >= 3) { log(" Creating Role MBean for role " + role); } if (MBeanUtils.createMBean(role) == null) { throw new IllegalArgumentException("Cannot create Role MBean for role " + role); } } // Create the MBeans for each defined Group Iterator groups = database.getGroups(); while (groups.hasNext()) { Group group = (Group) groups.next(); if (debug >= 3) { log(" Creating Group MBean for group " + group); } if (MBeanUtils.createMBean(group) == null) { throw new IllegalArgumentException("Cannot create Group MBean for group " + group); } } // Create the MBeans for each defined User Iterator users = database.getUsers(); while (users.hasNext()) { User user = (User) users.next(); if (debug >= 3) { log(" Creating User MBean for user " + user); } if (MBeanUtils.createMBean(user) == null) { throw new IllegalArgumentException("Cannot create User MBean for user " + user); } } } /** * Destroy the MBeans for the interesting global JNDI resources. */ protected void destroyMBeans() { if (debug >= 1) { log("Destroying MBeans for Global JNDI Resources"); } } /** * The destination for log messages. */ protected java.io.PrintStream stream = System.out; /** * Log a message. * * @param message The message to be logged */ protected void log(String message) { /* if (stream == System.out) { try { stream = new java.io.PrintStream (new java.io.FileOutputStream("grll.log")); } catch (Throwable t) { ; } } */ stream.print("GlobalResourcesLifecycleListener: "); stream.println(message); } /** * Log a message and associated exception. * * @param message The message to be logged * @param throwable The exception to be logged */ protected void log(String message, Throwable throwable) { log(message); throwable.printStackTrace(stream); } }