avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcconn...@apache.org
Subject cvs commit: avalon-sandbox/assembly/src/java/org/apache/avalon/assembly/lifecycle/context DefaultContextManager.xinfo DefaultContextManager.java Contextualization.java DefaultContextualizationService.java
Date Thu, 19 Dec 2002 10:42:24 GMT
mcconnell    2002/12/19 02:42:24

  Modified:    assembly/src/java/org/apache/avalon/assembly/lifecycle/context
                        DefaultContextualizationService.java
  Added:       assembly/src/java/org/apache/avalon/assembly/lifecycle/context
                        DefaultContextManager.xinfo
                        DefaultContextManager.java Contextualization.java
  Log:
  Added support for plugable context phase interface and supporting handler. The contextualization
stage is now indepedent of a particular interface (although the default if the existing Contextualizable
interface).  Clients can define thier own context strategy and eliminate the requirement for
casting a context.
  
  Revision  Changes    Path
  1.6       +30 -4     avalon-sandbox/assembly/src/java/org/apache/avalon/assembly/lifecycle/context/DefaultContextualizationService.java
  
  Index: DefaultContextualizationService.java
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/assembly/src/java/org/apache/avalon/assembly/lifecycle/context/DefaultContextualizationService.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- DefaultContextualizationService.java	17 Dec 2002 09:55:24 -0000	1.5
  +++ DefaultContextualizationService.java	19 Dec 2002 10:42:24 -0000	1.6
  @@ -124,15 +124,16 @@
               throw new NullPointerException( "object" );
           }
   
  +        Appliance provider = appliance.getContextProvider();
   
  -        if( object instanceof Contextualizable )
  +        if(( provider != null ) || (object instanceof Contextualizable ))
           {
               if( getLogger().isDebugEnabled() )
               {
  -                final String message =  
  -                  "[" + appliance.getProfile().getName() + "]";
  +                final String message = appliance.toString();
                   getLogger().debug( message );
               }
  + 
               Context source;
               if( appliance.getDeploymentContext() != null )
               {
  @@ -142,8 +143,33 @@
               {
                   source = context;
               }
  +
               Context standard =
                 createStandardContext( appliance, source );
  +
  +            if( provider != null )
  +            {
  +                if( getLogger().isDebugEnabled() )
  +                {
  +                    final String message = 
  +                      "Activating custom context: " + provider
  +                      + " for appliance: " + appliance;
  +                    getLogger().debug( message );
  +                }
  +
  +                try
  +                {
  +                    Contextualization handler = (Contextualization) provider.access();
  +                    handler.contextualize( object, standard );
  +                    return;
  +                }
  +                catch( Throwable e )
  +                {
  +                    final String error = 
  +                      "Contextualization handler failure in appliance: " + appliance;
  +                    throw new ContextException( error, e );
  +                }
  +            }
   
               try
               {
  
  
  
  1.1                  avalon-sandbox/assembly/src/java/org/apache/avalon/assembly/lifecycle/context/DefaultContextManager.xinfo
  
  Index: DefaultContextManager.xinfo
  ===================================================================
  <?xml version="1.0"?>
  <!DOCTYPE type
        PUBLIC "-//AVALON/Component Type DTD Version 1.0//EN"
               "http://jakarta.apache.org/avalon/dtds/meta/type_1_1.dtd" >
  
  <!--  
  Copyright (C) The Apache Software Foundation. All rights reserved.
  This software is published under the terms of the Apache Software License
  version 1.1, a copy of which has been included with this distribution in
  the LICENSE.txt file.
  
  @author  Avalon Development Team
  @version 1.0 12/03/2001
  -->
  
  <!--
  Definition of the extension type phase support.
  -->
  
  <type>
  
    <info>
      <name>context</name>
    </info>
  
    <!--
    Declaration of the lifecycle support phases that this manager provides. 
    -->
    <extensions>
      <extension type="org.apache.avalon.framework.context.Contextualizable:4.1" phase="CONTEXT"
/>
    </extensions>
  
  </type>
  
  
  
  
  1.1                  avalon-sandbox/assembly/src/java/org/apache/avalon/assembly/lifecycle/context/DefaultContextManager.java
  
  Index: DefaultContextManager.java
  ===================================================================
  /* ==================================================================== 
   * 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 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 "Jakarta", "Avalon", 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 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/>.
   */ 
  
  package org.apache.avalon.assembly.lifecycle.context;
  
  import org.apache.avalon.framework.context.Context;
  import org.apache.avalon.framework.context.ContextException;
  import org.apache.avalon.framework.context.Contextualizable;
  import org.apache.avalon.framework.logger.AbstractLogEnabled;
  import org.apache.avalon.lifecycle.Creator;
  
  import org.apache.avalon.assembly.appliance.Appliance;
  
  /**
   * Definition of an extension handler that handles the Contextualization
   * process. This implementation is provided as a template for alternative
   * context handlers.  The requirements for introduction of an alternative 
   * handler include:
   * <ul>
   * <li>A class implementing the {@link Contextualization} interface.</li>
   * <li>Declaration in the classes xinfo of the extension type where the 
   *       type attribute value is a version interface reference corresponding
   *       to the interface that the target component must implement.</li>
   * <li>Declaration by the target component in it's xinfo atttributes
   *       of the criteria for a custom context handler under the attribute
   *       key "urn:assembly:lifecycle.context.extension" and value 
   *       corresponding to the extension type value. </li>
   * <li>Implementation of the extension type interface by the target 
   *       component.</li>
   * </ul>
   *
   * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
   */
  public class DefaultContextManager implements Contextualization
  {
      //=======================================================================
      // Extension
      //=======================================================================
  
      /**
       * Handle the contextualization stage of a component lifecycle.
       * @param object the object to contextualize
       * @param context the deployment context
       * @exception ContextException if a contextualization error occurs
       */
      public void contextualize( Object object, Context context ) 
        throws ContextException
      {
          if( object instanceof Contextualizable )
          {
              ( (Contextualizable)object ).contextualize( context );
          }
      }
  }
  
  
  
  1.1                  avalon-sandbox/assembly/src/java/org/apache/avalon/assembly/lifecycle/context/Contextualization.java
  
  Index: Contextualization.java
  ===================================================================
  /* ==================================================================== 
   * 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 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 "Jakarta", "Avalon", 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 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/>.
   */ 
  
  package org.apache.avalon.assembly.lifecycle.context;
  
  import org.apache.avalon.assembly.appliance.Appliance;
  import org.apache.avalon.framework.context.Context;
  import org.apache.avalon.framework.context.ContextException;
  
  /**
   * Definition of an extension handler that handles the Contextualize
   * stage of a component lifecycle.
   *
   * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
   */
  public interface Contextualization
  {
      //=======================================================================
      // Extension
      //=======================================================================
  
      /**
       * Handle the contextualization stage of a component lifecycle.
       * @param object the object to contextualize
       * @param context the containement context
       * @exception ContextException if a contextualization error occurs
       */
      void contextualize( Object object, Context context ) 
        throws ContextException;
  }
  
  
  

--
To unsubscribe, e-mail:   <mailto:avalon-cvs-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-cvs-help@jakarta.apache.org>


Mime
View raw message