tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cos...@apache.org
Subject cvs commit: jakarta-tomcat/src/share/org/apache/tomcat/modules/config ProfileLoader.java
Date Tue, 27 Feb 2001 17:16:52 GMT
costin      01/02/27 09:16:51

  Added:       src/share/org/apache/tomcat/modules/config
                        ProfileLoader.java
  Log:
  Initial version of ProfileLoader.
  
  It's a very simple class - it will read a profile description ( the
  config attribute ) and store the set of modules and their config.
  
  When a context is loaded with a propery "profile" matching the profile
  name, all the modules will be added to the context.
  
  For example:
   <ProfileLoader config="conf/profile.xml" name="foo" />
  
   ...
  
   <Context profile="foo" ... />
  
  The profile has 2 roles:
  - simplified config ( you don't have to specify Jdbc auth + specific logger
  options for each module )
  
  - ( later ) allow groups of contexts to share some classes ( i.e. form a
  hierarchy of class loaders ) - this is very important for inter-context
  communication, without requiring libs shared by few apps to be
  forced in the CLASSPATH ( at global level ).
  
  Revision  Changes    Path
  1.1                  jakarta-tomcat/src/share/org/apache/tomcat/modules/config/ProfileLoader.java
  
  Index: ProfileLoader.java
  ===================================================================
  /*
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 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 org.apache.tomcat.modules.config;
  
  import java.beans.*;
  import java.io.*;
  import java.lang.reflect.*;
  import java.util.Hashtable;
  import java.util.*;
  import java.net.*;
  import org.apache.tomcat.util.res.StringManager;
  import org.apache.tomcat.util.io.FileUtil;
  import org.apache.tomcat.util.xml.*;
  import org.apache.tomcat.core.*;
  import org.apache.tomcat.modules.server.*;
  import org.apache.tomcat.util.log.*;
  import org.xml.sax.*;
  
  /**
   * This module can be used to specify groups of modules and
   * add them automcatically to all web applications declared as 
   * belonging to the profile.
   *
   * ( not implemented ) A profile can also declare a set of jars
   * that will be shared by all the apps belonging to that profile.
   * This allows apps to share objects and attributes.
   * 
   * @author Costin Manolache
   */
  public class ProfileLoader extends BaseInterceptor {
      Hashtable profiles=new Hashtable();
      
      public ProfileLoader() {
      }
  
      // -------------------- Properties --------------------
      String configFile=null;
      static final String DEFAULT_CONFIG="conf/profile.xml";
  
      public void setConfig( String s ) {
  	configFile=s;
      }
  
      public void addProfile( Profile p ) {
  	String name=p.getName();
  	if( debug > -1 ) log ( "Adding " + name );
  	if( name==null ) return;
  	profiles.put( name, p );
      }
  
      // -------------------- Contexts --------------------
      /** Adjust paths for a context - make the base and all loggers
       *  point to canonical paths.
       */
      public void addContext( ContextManager cm, Context ctx)
  	throws TomcatException
      {
  	String ctxProfile=ctx.getProperty("profile");
  	if( ctxProfile==null ) ctxProfile="default";
  
  	Profile p=(Profile)profiles.get( ctxProfile );
  	if( p==null ) {
  	    log( "Can't find profile " + ctxProfile );
  	    p=(Profile)profiles.get("default");
  	}
  
  	if( p==null ) throw new TomcatException( "Can't load profile");
  	Enumeration en=p.getModules();
  	while( en.hasMoreElements()) {
  	    BaseInterceptor bi=(BaseInterceptor)en.nextElement();
  	    log( ctx + " " + bi );
  	    ctx.addInterceptor( bi );
  	}
      }
      
  
      // -------------------- Reade config and init --------------------
      /**
       *  Read the profiles.
       */
      public void addInterceptor(ContextManager cm, Context ctx,
  			       BaseInterceptor module)
  	throws TomcatException
      {
  	if( this != module ) return;
  
  	XmlMapper xh=new XmlMapper();
  	xh.setDebug( debug );
  
  	addProfileRules( xh );
  	addTagRules( cm, xh );
  	
  	if (configFile == null)
  	    configFile=DEFAULT_CONFIG;
  	
          File f=new File(configFile);
          if ( !f.isAbsolute())
  	    f=new File( cm.getHome(), File.separator + configFile);
  
  	if( f.exists() ){
  	    try {
  		xh.readXml(f, this );
  	    } catch( Exception ex ) {
  		ex.printStackTrace();
  		throw new TomcatException(ex);
  	    }
          }
      }
  
      // -------------------- Xml reading details --------------------
  
      public void addTagRules( ContextManager cm, XmlMapper xh )
  	throws TomcatException
      {
  	Hashtable modules=(Hashtable)cm.getNote("modules");
  	if( modules==null) return;
  	Enumeration keys=modules.keys();
  	while( keys.hasMoreElements() ) {
  	    String name=(String)keys.nextElement();
  	    String classN=(String)modules.get( name );
  
  	    String tag="Profile" + "/" + name;
  	    xh.addRule(  tag ,
  			 xh.objectCreate( classN, null ));
  	    xh.addRule( tag ,
  			xh.setProperties());
  	    xh.addRule( tag, new XmlAction() {
  		    public void end(SaxContext ctx ) throws Exception {
  			BaseInterceptor obj=(BaseInterceptor)
  			    ctx.currentObject();
  			Profile parent=(Profile)
  			    ctx.previousObject();
  
  			parent.addModule( obj );
  		    }
  		});
  	}
      }
  
      public  void addProfileRules( XmlMapper xh ) {
  	xh.addRule( "Profile", new XmlAction() {
  		public void start(SaxContext ctx ) throws Exception {
  		    Profile p=new Profile();
  		    AttributeList attributes = ctx.getCurrentAttributes();
  		    p.setName( attributes.getValue("name"));
  		    ctx.pushObject( p );
  		}
  		public void end(SaxContext ctx ) {
  		    ProfileLoader parent=(ProfileLoader)
  			ctx.previousObject();
  		    Profile obj=(Profile)
  			ctx.currentObject();
  		    System.out.println("XXX " + obj.getName());
  		    parent.addProfile( obj );
  
  		}
  		public void cleanup( SaxContext ctx ) {
  		    ctx.popObject();
  		}
  	    });
      }
  }
  
  class Profile {
      String name;
      Vector modules=new Vector();
      
      public Profile() {};
  
      public String getName() {
  	return name;
      }
  	
      public void setName( String s ) {
  	name=s;
      }
  
      public Enumeration getModules() {
  	return modules.elements();
      }
      
      public void addModule(BaseInterceptor bi) {
  	modules.addElement( bi );
      }
  
  }
  
  
  

Mime
View raw message