You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by do...@apache.org on 2002/05/10 12:39:12 UTC
cvs commit: jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components LifecycleUtil.java
donaldp 02/05/10 03:39:10
Added: src/java/org/apache/avalon/phoenix/components
LifecycleUtil.java
Log:
Add a class that helps processing objects through their lifecycle stages. Eventually should move to framework proper but can sit now for the timebeing.
Revision Changes Path
1.1 jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components/LifecycleUtil.java
Index: LifecycleUtil.java
===================================================================
/*
* 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.
*/
package org.apache.avalon.phoenix.components;
import org.apache.avalon.framework.activity.Disposable;
import org.apache.avalon.framework.activity.Initializable;
import org.apache.avalon.framework.activity.Startable;
import org.apache.avalon.framework.component.ComponentException;
import org.apache.avalon.framework.component.ComponentManager;
import org.apache.avalon.framework.component.Composable;
import org.apache.avalon.framework.configuration.Configurable;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
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.LogEnabled;
import org.apache.avalon.framework.logger.Loggable;
import org.apache.avalon.framework.logger.Logger;
import org.apache.avalon.framework.parameters.ParameterException;
import org.apache.avalon.framework.parameters.Parameterizable;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.avalon.framework.service.ServiceException;
import org.apache.avalon.framework.service.ServiceManager;
import org.apache.avalon.framework.service.Serviceable;
/**
* Utility class that makes it easier to transfer
* a component throught it's lifecycle stages.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
* @version $Revision: 1.1 $ $Date: 2002/05/10 10:39:10 $
* @todo Add a MissingResource exception and make all the method
* throw that if supplied resource (logger, context, etc)
* is null.
*/
public final class LifecycleUtil
{
/**
* Private constructor to block instantiation.
*/
private LifecycleUtil()
{
}
/**
* Run specified object through shutdown lifecycle stages
* (Stop and Dispose).
*
* @param object the object to shutdown
* @throws Exception if there is a problem stoppping object
*/
public static void shutdown( final Object object )
throws Exception
{
stop( object );
dispose( object );
}
/**
* Supply specified object with Logger if it implements the
* {@link Loggable} interface.
*
* @param object the object to Start
* @param logger the logger to enable component with. May be null
* in which case the specified object must not implement Loggable.
* @throws Exception if the object is Loggable but Logger is null
* @deprecated Note that this is deprecated as it uses the deprecated
* Loggable interface.
*/
public static void setupLoggable( final Object object,
final org.apache.log.Logger logger )
throws Exception
{
if( object instanceof Loggable )
{
if( null == logger )
{
final String message = "Missing logger";
throw new Exception( message );
}
( (Loggable)object ).setLogger( logger );
}
}
/**
* Supply specified object with ServiceManager if it implements the
* {@link Serviceable} interface.
*
* @param object the object to Start
* @param logger the logger to enable component with. May be null
* in which case the specified object must not implement LogEnabled.
* @throws Exception if the object is LogEnabled but Logger is null
*/
public static void logEnable( final Object object,
final Logger logger )
throws Exception
{
if( object instanceof LogEnabled )
{
if( null == logger )
{
final String message = "Missing logger";
throw new Exception( message );
}
( (LogEnabled)object ).enableLogging( logger );
}
}
/**
* Supply specified object with a Context object if it implements the
* {@link Contextualizable} interface.
*
* @param object the object to contextualize
* @param context the context object to use for object.
* May be null in which case the specified object must not
* implement Contextualizable.
* @throws ContextException if there is a problem contextualizing object,
* or the object is Contextualizable but context is null
*/
public static void contextualize( final Object object,
final Context context )
throws ContextException
{
if( object instanceof Contextualizable )
{
if( null == context )
{
final String message = "Missing context";
throw new ContextException( message );
}
( (Contextualizable)object ).contextualize( context );
}
}
/**
* Supply specified object with ServiceManager if it implements the
* {@link Serviceable} interface.
*
* @param object the object to service
* @param serviceManager the serviceManager object to use for object.
* May be null in which case the specified object must not
* implement Serviceable.
* @throws ServiceException if there is a problem servicing object,
* or the object is Servicable but ServiceManager is null
*/
public static void service( final Object object,
final ServiceManager serviceManager )
throws ServiceException
{
if( object instanceof Serviceable )
{
if( null == serviceManager )
{
final String message = "Missing ServiceManager";
throw new ServiceException( message );
}
( (Serviceable)object ).service( serviceManager );
}
}
/**
* Supply specified object with ComponentManager if it implements the
* {@link Composable} interface.
*
* @param object the object to compose
* @param componentManager the ComponentManager object to use for object.
* May be null in which case the specified object must not
* implement Composable.
* @throws ComponentException if there is a problem composing object,
* or the object is Composable but ComponentManager is null
* @deprecated compose() is no longer the preferred method via
* which components will be supplied with Components. Please
* Use service() from Serviceable instead.
*/
public static void compose( final Object object,
final ComponentManager componentManager )
throws ComponentException
{
if( object instanceof Composable )
{
if( null == componentManager )
{
final String message = "Missing ComponentManager";
throw new ComponentException( message );
}
( (Composable)object ).compose( componentManager );
}
}
/**
* Configure specified object if it implements the
* {@link Configurable} interface.
*
* @param object the object to Start
* @param configuration the configuration object to use during
* configuration. May be null in which case the specified object
* must not implement Configurable
* @throws ConfigurationException if there is a problem Configuring object,
* or the object is Configurable but Configuration is null
*/
public static void configure( final Object object,
final Configuration configuration )
throws ConfigurationException
{
if( object instanceof Configurable )
{
if( null == configuration )
{
final String message = "Missing configuration";
throw new ConfigurationException( message );
}
( (Configurable)object ).configure( configuration );
}
}
/**
* Parameterize specified object if it implements the
* {@link Parameterizable} interface.
*
* @param object the object to Parameterize.
* @param parameters the parameters object to use during Parameterization.
* May be null in which case the specified object must not
* implement Parameterizable.
* @throws ParameterException if there is a problem Parameterizing object,
* or the object is Parameterizable but parameters is null
*/
public static void parameterize( final Object object,
final Parameters parameters )
throws ParameterException
{
if( object instanceof Parameterizable )
{
if( null == parameters )
{
final String message = "Missing parameters";
throw new ParameterException( message );
}
( (Parameterizable)object ).parameterize( parameters );
}
}
/**
* Initialize specified object if it implements the
* {@link Initializable} interface.
*
* @param object the object to Initialize
* @throws Exception if there is a problem Initializing object
*/
public static void initialize( final Object object )
throws Exception
{
if( object instanceof Initializable )
{
( (Initializable)object ).initialize();
}
}
/**
* Start specified object if it implements the
* {@link Startable} interface.
*
* @param object the object to Start
* @throws Exception if there is a problem Starting object
*/
public static void start( final Object object )
throws Exception
{
if( object instanceof Startable )
{
( (Startable)object ).start();
}
}
/**
* Stop specified object if it implements the
* {@link Startable} interface.
*
* @param object the object to stop
* @throws Exception if there is a problem stoppping object
*/
public static void stop( final Object object )
throws Exception
{
if( object instanceof Startable )
{
( (Startable)object ).stop();
}
}
/**
* Dispose specified object if it implements the
* {@link Disposable} interface.
*
* @param object the object to dispose
*/
public static void dispose( final Object object )
{
if( object instanceof Disposable )
{
( (Disposable)object ).dispose();
}
}
}
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>