epugh       2003/11/02 13:52:39

  Added:       src/java/org/apache/turbine/services/avaloncomponent
                        MerlinComponentService.java
  Log:
  Merlin based Component Service interface.
  
  Revision  Changes    Path
  1.1                  
jakarta-turbine-2/src/java/org/apache/turbine/services/avaloncomponent/MerlinComponentService.java
  
  Index: MerlinComponentService.java
  ===================================================================
  package org.apache.turbine.services.avaloncomponent;
  
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2001-2003 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 acknowledgment:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The names "Apache" and "Apache Software Foundation" and
   *    "Apache Turbine" must not be used to endorse or promote products
   *    derived from this software without prior written permission. For
   *    written permission, please contact [EMAIL PROTECTED]
   *
   * 5. Products derived from this software may not be called "Apache",
   *    "Apache Turbine", nor may "Apache" appear in their name, without
   *    prior written permission of the Apache Software Foundation.
   *
   * 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/>.
   */
  
  import org.apache.turbine.services.Service;
  
  /**
   * This service allows access to avalon components.
   *
   * @author <a href="mailto:[EMAIL PROTECTED]">Quinton McCombs</a>
   * @author <a href="mailto:[EMAIL PROTECTED]">Henning P. Schmiedehausen</a>
   * @version $Id: MerlinComponentService.java,v 1.1 2003/11/02 21:52:39 epugh Exp $
   */
  public interface MerlinComponentService
          extends Service
  {
      /** The publically visible name of the service */
      String SERVICE_NAME = "MerlinComponentService";
  
      /** property specifing file name of the component block files path */
      String BLOCK_CONFIG_KEY = "block.path";
  
      /** property specifing file name of the default path for block files */
      String BLOCK_CONFIG_PATH = "/WEB-INF/conf/merlin";
  
        /** property specifing key for finding the kernal file */
        String KERNAL_CONFIG_KEY = "kernel";
  
        /** property specifing default file name for kernal */
        String KERNAL_CONFIG_PATH = "/WEB-INF/conf/merlin/kernel.xml";
        
  
      /** property for the Components to look up */
      String COMPONENT_LOOKUP_KEY = "lookup";
  
      /** Key used in the context for defining the application root */
      String COMPONENT_APP_ROOT = "componentAppRoot";
  
      /**
       * Returns an instance of the named component
       *
       * @param roleName Name of the role the component fills.
       * @return an instance of the named component
       * @throws Exception generic exception
       */
      public Object lookup(String path) throws Exception;
  
      /**
       * Releases the component
       *
       * @param source. The path to the handler for this component
       * For example, if the component is a java.sql.Connection
       * object sourced from the "/turbine-merlin/datasource" 
       * component, the call would be :-
       * release("/turbine-merlin/datasource", conn);
       * @param component the component to release
       */
      public void release(Object component);
  
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to