donaldp 02/05/18 19:35:26
Modified: src/java/org/apache/avalon/phoenix/components/application
AppLifecycleHelper.java Resources.properties
DefaultApplication.java
Log:
Refactor AppLifecycleHelper to use the new "generic"
infrastructure.
Much of functionality in helper has been factored out into
other classes.
Revision Changes Path
1.2 +42 -451
jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components/application/AppLifecycleHelper.java
Index: AppLifecycleHelper.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components/application/AppLifecycleHelper.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AppLifecycleHelper.java 18 May 2002 23:41:08 -0000 1.1
+++ AppLifecycleHelper.java 19 May 2002 02:35:26 -0000 1.2
@@ -9,41 +9,19 @@
import org.apache.avalon.excalibur.i18n.ResourceManager;
import org.apache.avalon.excalibur.i18n.Resources;
-import org.apache.avalon.framework.CascadingException;
-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.Component;
-import org.apache.avalon.framework.component.ComponentManager;
-import org.apache.avalon.framework.component.Composable;
-import org.apache.avalon.framework.component.DefaultComponentManager;
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.Contextualizable;
+import org.apache.avalon.framework.container.ContainerUtil;
import org.apache.avalon.framework.logger.AbstractLogEnabled;
import org.apache.avalon.framework.logger.LogEnabled;
-import org.apache.avalon.framework.logger.LogKitLogger;
-import org.apache.avalon.framework.logger.Loggable;
import org.apache.avalon.framework.logger.Logger;
-import org.apache.avalon.framework.parameters.Parameterizable;
-import org.apache.avalon.framework.parameters.Parameters;
-import org.apache.avalon.framework.service.DefaultServiceManager;
-import org.apache.avalon.framework.service.ServiceManager;
-import org.apache.avalon.framework.service.Serviceable;
-import org.apache.avalon.phoenix.ApplicationEvent;
import org.apache.avalon.phoenix.ApplicationListener;
-import org.apache.avalon.phoenix.BlockContext;
-import org.apache.avalon.phoenix.BlockEvent;
import org.apache.avalon.phoenix.BlockListener;
-import org.apache.avalon.framework.container.ContainerUtil;
+import org.apache.avalon.phoenix.components.lifecycle.LifecycleHelper;
import org.apache.avalon.phoenix.components.lifecycle.State;
import org.apache.avalon.phoenix.interfaces.Application;
import org.apache.avalon.phoenix.interfaces.ApplicationContext;
import org.apache.avalon.phoenix.metadata.BlockListenerMetaData;
-import org.apache.avalon.phoenix.metadata.BlockMetaData;
-import org.apache.avalon.phoenix.metadata.DependencyMetaData;
-import org.apache.avalon.phoenix.metainfo.ServiceDescriptor;
/**
* This is a class to help an Application manage lifecycle of
@@ -59,33 +37,10 @@
private static final Resources REZ =
ResourceManager.getPackageResources( AppLifecycleHelper.class );
- //Constants to designate stages
- private static final int STAGE_CREATE = 0;
- private static final int STAGE_LOGGER = 1;
- private static final int STAGE_CONTEXT = 2;
- private static final int STAGE_COMPOSE = 3;
- private static final int STAGE_CONFIG = 4;
- private static final int STAGE_PARAMETER = 5;
- private static final int STAGE_INIT = 6;
- private static final int STAGE_START = 7;
- private static final int STAGE_STOP = 8;
- private static final int STAGE_DISPOSE = 9;
- private static final int STAGE_DESTROY = 10;
-
- //Constants to designate type of component
- private static final int TYPE_BLOCK = 0;
- private static final int TYPE_LISTENER = 1;
-
///Frame in which block executes
private ApplicationContext m_context;
/**
- * The Application which this phase is associated with.
- * Required to build a ComponentManager.
- */
- private Application m_application;
-
- /**
* Object to support notification of BlockListeners.
*/
private BlockListenerSupport m_blockListenerSupport = new
BlockListenerSupport();
@@ -96,6 +51,19 @@
private ApplicationListenerSupport m_applicationListenerSupport =
new ApplicationListenerSupport();
+ private final LifecycleHelper m_lifecycleHelper = new LifecycleHelper();
+ private final ExportHelper m_exportHelper = new ExportHelper();
+
+ /**
+ * ResourceAccessor for blocks.
+ */
+ private final BlockAccessor m_blockAccessor;
+
+ /**
+ * ResourceAccessor for listeners.
+ */
+ private ListenerAccessor m_listenerAccessor;
+
/**
* Construct helper object for specified application,
* in specified frame.
@@ -104,10 +72,18 @@
* @param context the ApplicationContext in which this helper operates
*/
protected AppLifecycleHelper( final Application application,
- final ApplicationContext context )
+ final ApplicationContext context )
{
- m_application = application;
m_context = context;
+ m_blockAccessor = new BlockAccessor( context, application );
+ m_listenerAccessor = new ListenerAccessor( context );
+ }
+
+ public void enableLogging( Logger logger )
+ {
+ super.enableLogging( logger );
+ setupLogger( m_lifecycleHelper );
+ setupLogger( m_exportHelper );
}
/**
@@ -123,25 +99,22 @@
throws Exception
{
final String name = metaData.getName();
-
- final ClassLoader classLoader = m_context.getClassLoader();
- final Class clazz = classLoader.loadClass( metaData.getClassname() );
- final BlockListener listener = (BlockListener)clazz.newInstance();
+ final Object listener = m_listenerAccessor.createObject( metaData );
if( listener instanceof LogEnabled )
{
- final Logger logger = new LogKitLogger( m_context.getLogger(
name ) );
+ final Logger logger = m_listenerAccessor.createLogger( metaData
);
ContainerUtil.enableLogging( listener, logger );
}
if( listener instanceof Configurable )
{
- final Configuration configuration = getConfiguration( name,
TYPE_LISTENER );
+ final Configuration configuration =
m_listenerAccessor.createConfiguration( metaData );
ContainerUtil.configure( listener, configuration );
}
// As ApplicationListners are BlockListeners then this is applicable
for all
- m_blockListenerSupport.addBlockListener( listener );
+ m_blockListenerSupport.addBlockListener( (BlockListener)listener );
// However onky ApplicationListners can avail of block events.
if( listener instanceof ApplicationListener )
@@ -159,29 +132,9 @@
}
}
- public void applicationStarting( ApplicationEvent appEvent ) throws
Exception
+ ApplicationListenerSupport getAppListenerSupport()
{
- m_applicationListenerSupport.applicationStarting( appEvent );
- }
-
- public void applicationStarted()
- {
- m_applicationListenerSupport.applicationStarted();
- }
-
- public void applicationStopping()
- {
- m_applicationListenerSupport.applicationStopping();
- }
-
- public void applicationStopped()
- {
- m_applicationListenerSupport.applicationStopped();
- }
-
- public void applicationFailure( Exception causeOfFailure )
- {
- m_applicationListenerSupport.applicationFailure( causeOfFailure );
+ return m_applicationListenerSupport;
}
/**
@@ -199,117 +152,13 @@
public void startup( final BlockEntry entry )
throws Exception
{
- final BlockMetaData metaData = entry.getMetaData();
- final String name = metaData.getName();
-
- //The number of stage currently at
- //(Used in constructing error messages)
- int stage = 0;
+ final Object block =
+ m_lifecycleHelper.startup( entry, m_blockAccessor );
- try
- {
- //Creation stage
- stage = STAGE_CREATE;
- notice( name, stage );
- final Object block = createBlock( metaData );
-
- //LogEnabled stage
- stage = STAGE_LOGGER;
- setupLogging( name, block, stage );
-
- //Contextualize stage
- stage = STAGE_CONTEXT;
- if( block instanceof Contextualizable )
- {
- notice( name, stage );
- final BlockContext context = createBlockContext( name );
- ContainerUtil.contextualize( block, context );
- }
-
- //Composition stage
- stage = STAGE_COMPOSE;
- if( block instanceof Composable )
- {
- notice( name, stage );
- final ComponentManager componentManager =
createComponentManager( metaData );
- ContainerUtil.compose( block, componentManager );
- }
- else if( block instanceof Serviceable )
- {
- notice( name, stage );
- final ServiceManager manager = createServiceManager(
metaData );
- ContainerUtil.service( block, manager );
- }
-
- //Configuring stage
- stage = STAGE_CONFIG;
- if( block instanceof Configurable )
- {
- notice( name, stage );
- final Configuration configuration = getConfiguration( name,
TYPE_BLOCK );
- ContainerUtil.configure( block, configuration );
- }
-
- //Parameterizing stage
- stage = STAGE_PARAMETER;
- if( block instanceof Parameterizable )
- {
- notice( name, stage );
- final Parameters parameters =
- Parameters.fromConfiguration( getConfiguration( name,
TYPE_BLOCK ) );
- parameters.makeReadOnly();
- ContainerUtil.parameterize( block, parameters );
- }
-
- //Initialize stage
- stage = STAGE_INIT;
- if( block instanceof Initializable )
- {
- notice( name, stage );
- ContainerUtil.initialize( block );
- }
-
- //Start stage
- stage = STAGE_START;
- if( block instanceof Startable )
- {
- notice( name, stage );
- ContainerUtil.start( block );
- }
-
- entry.setState( State.STARTED );
- entry.setObject( block );
-
- exportBlock( metaData, block );
-
- final Object proxy = entry.getProxy();
- final BlockEvent event =
- new BlockEvent( name, proxy, metaData.getBlockInfo() );
- m_blockListenerSupport.blockAdded( event );
- }
- catch( final Throwable t )
- {
- entry.setState( State.FAILED );
- fail( name, stage, t );
- }
- }
+ m_exportHelper.exportBlock( m_context, entry.getMetaData(), block );
- private void setupLogging( final String name,
- final Object block,
- int stage )
- throws Exception
- {
- if( block instanceof Loggable )
- {
- notice( name, stage );
- ( (Loggable)block ).setLogger( m_context.getLogger( name ) );
- }
- else if( block instanceof LogEnabled )
- {
- notice( name, stage );
- final Logger logger = new LogKitLogger( m_context.getLogger(
name ) );
- ContainerUtil.enableLogging( block, logger );
- }
+ entry.setObject( block );
+ m_blockListenerSupport.fireBlockAddedEvent( entry );
}
/**
@@ -323,277 +172,19 @@
*/
public void shutdown( final BlockEntry entry )
{
- final BlockMetaData metaData = entry.getMetaData();
- final String name = metaData.getName();
-
- final BlockEvent event =
- new BlockEvent( name, entry.getProxy(), metaData.getBlockInfo()
);
- m_blockListenerSupport.blockRemoved( event );
-
- final Object block = entry.getObject();
+ m_blockListenerSupport.fireBlockRemovedEvent( entry );
//Remove block from Management system
- unexportBlock( metaData, block );
-
- //Invalidate entry. This will invalidate
- //and null out Proxy object aswell as nulling out
- //block property
- entry.invalidate();
-
- //Stoppable stage
- if( block instanceof Startable )
- {
- notice( name, STAGE_STOP );
- try
- {
- entry.setState( State.STOPPING );
- ContainerUtil.stop( block );
- entry.setState( State.STOPPED );
- }
- catch( final Throwable t )
- {
- entry.setState( State.FAILED );
- safeFail( name, STAGE_STOP, t );
- }
- }
+ m_exportHelper.unexportBlock( m_context, entry.getMetaData(),
entry.getObject() );
- //Disposable stage
- if( block instanceof Disposable )
- {
- notice( name, STAGE_DISPOSE );
- try
- {
- entry.setState( State.DESTROYING );
- ContainerUtil.dispose( block );
- }
- catch( final Throwable t )
- {
- entry.setState( State.FAILED );
- safeFail( name, STAGE_DISPOSE, t );
- }
- }
-
- notice( name, STAGE_DESTROY );
- entry.setState( State.DESTROYED );
- }
-
- /**
- * Export the services of block, declared to be management
- * services, into management system.
- */
- private void exportBlock( final BlockMetaData metaData,
- final Object block )
- throws CascadingException
- {
- final ServiceDescriptor[] services =
metaData.getBlockInfo().getManagementAccessPoints();
- final String name = metaData.getName();
- final ClassLoader classLoader = block.getClass().getClassLoader();
-
- for( int i = 0; i < services.length; i++ )
- {
- final ServiceDescriptor service = services[ i ];
- try
- {
- final Class clazz = classLoader.loadClass( service.getName()
);
- m_context.exportObject( name, clazz, block );
- }
- catch( final Exception e )
- {
- final String reason = e.toString();
- final String message =
- REZ.getString( "export.error", name, service.getName(),
reason );
- getLogger().error( message );
- throw new CascadingException( message, e );
- }
- }
- }
-
- /**
- * Unxport the services of block, declared to be management
- * services, into management system.
- */
- private void unexportBlock( final BlockMetaData metaData,
- final Object block )
- {
- final ServiceDescriptor[] services =
metaData.getBlockInfo().getManagementAccessPoints();
- final String name = metaData.getName();
- final ClassLoader classLoader = block.getClass().getClassLoader();
-
- for( int i = 0; i < services.length; i++ )
- {
- final ServiceDescriptor service = services[ i ];
- try
- {
- final Class clazz = classLoader.loadClass( service.getName()
);
- m_context.unexportObject( name, clazz );
- }
- catch( final Exception e )
- {
- final String reason = e.toString();
- final String message =
- REZ.getString( "unexport.error", name,
service.getName(), reason );
- getLogger().error( message );
- }
- }
- }
-
- /**
- * Utility method to create a <code>Block</code> object
- * from specified BlockMetaData.
- *
- * @param metaData the BlockMetaData
- * @return the newly created Block object
- * @throws Exception if an error occurs
- */
- private Object createBlock( final BlockMetaData metaData )
- throws Exception
- {
- final ClassLoader classLoader = m_context.getClassLoader();
- final Class clazz = classLoader.loadClass( metaData.getClassname() );
- return clazz.newInstance();
- }
-
- /**
- * Create a BlockContext object for Block with specified name.
- *
- * @param name the name of Block
- * @return the created BlockContext
- */
- private BlockContext createBlockContext( final String name )
- {
- return new DefaultBlockContext( name, m_context );
- }
-
- /**
- * Retrieve a configuration for specified component.
- * If the configuration is missing then a exception
- * is raised with an appropraite error message.
- *
- * @param name the name of component
- * @return the Configuration object
- * @throws ConfigurationException if an error occurs
- */
- private Configuration getConfiguration( final String name, final int
type )
- throws ConfigurationException
- {
try
{
- return m_context.getConfiguration( name );
+ m_lifecycleHelper.shutdown( entry );
}
- catch( final ConfigurationException ce )
+ finally
{
- //Note that this shouldn't ever happen once we
- //create a Config validator
- final String message =
- REZ.getString( "missing-configuration", new Integer( type ),
name );
- throw new ConfigurationException( message, ce );
+ entry.setObject( null );
+ entry.setState( State.DESTROYED );
}
- }
-
- /**
- * Create a <code>ComponentManager</code> object for a
- * specific <code>Block</code>. This requires that for
- * each dependency a reference to providing <code>Block</code>
- * is aaqiured from the Application and placing it in
- * <code>ComponentManager</code> under the correct name.
- *
- * @param metaData the BlockMetaData representing block
- * @return the created ComponentManager
- */
- private ComponentManager createComponentManager( final BlockMetaData
metaData )
- throws Exception
- {
- final DefaultComponentManager componentManager = new
DefaultComponentManager();
- final DependencyMetaData[] roles = metaData.getDependencies();
-
- for( int i = 0; i < roles.length; i++ )
- {
- final DependencyMetaData role = roles[ i ];
- final Object dependency = m_application.getBlock( role.getName()
);
- if( dependency instanceof Component )
- {
- componentManager.put( role.getRole(), (Component)dependency
);
- }
- else
- {
- final String message =
- REZ.getString( "lifecycle.nota-component.error",
- metaData.getName(),
- role.getRole(),
- role.getName() );
- throw new Exception( message );
- }
- }
-
- return componentManager;
- }
-
- private ServiceManager createServiceManager( final BlockMetaData
metaData )
- {
- final DefaultServiceManager manager = new DefaultServiceManager();
- final DependencyMetaData[] roles = metaData.getDependencies();
-
- for( int i = 0; i < roles.length; i++ )
- {
- final DependencyMetaData role = roles[ i ];
- final Object dependency = m_application.getBlock( role.getName()
);
- manager.put( role.getRole(), dependency );
- }
-
- return manager;
- }
-
- /**
- * Utility method to report that a lifecycle stage is about to be
processed.
- *
- * @param name the name of block that caused failure
- * @param stage the stage
- */
- private void notice( final String name, final int stage )
- {
- if( getLogger().isDebugEnabled() )
- {
- final String message =
- REZ.getString( "lifecycle-stage.notice", name, new Integer(
stage ) );
- getLogger().debug( message );
- }
- }
-
- /**
- * Utility method to report that there was an error processing
- * specified lifecycle stage.
- *
- * @param name the name of block that caused failure
- * @param stage the stage
- * @param t the exception thrown
- */
- private void safeFail( final String name, final int stage, final
Throwable t )
- {
- //final String reason = t.getMessage();
- final String reason = t.toString();
- final String message =
- REZ.getString( "lifecycle-fail.error", name, new Integer( stage
), reason );
- getLogger().error( message );
- }
-
- /**
- * Utility method to report that there was an error processing
- * specified lifecycle stage. It will also rethrow an exception
- * with a better error message.
- *
- * @param name the name of block that caused failure
- * @param stage the stage
- * @param t the exception thrown
- * @throws Exception containing error
- */
- private void fail( final String name, final int stage, final Throwable t
)
- throws Exception
- {
- //final String reason = t.getMessage();
- final String reason = t.toString();
- final String message =
- REZ.getString( "lifecycle-fail.error", name, new Integer( stage
), reason );
- getLogger().error( message );
- throw new CascadingException( message, t );
}
}
1.23 +2 -1
jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components/application/Resources.properties
Index: Resources.properties
===================================================================
RCS file:
/home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components/application/Resources.properties,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- Resources.properties 18 May 2002 23:41:08 -0000 1.22
+++ Resources.properties 19 May 2002 02:35:26 -0000 1.23
@@ -5,7 +5,8 @@
processed-block=Processed Block named "{0}" through phase "{1}".
blocks-processing={0} Blocks to process for phase "{1}". Order of processing
= {2}.
-missing-configuration={0,choice,0#Block|1#BlockListener} named "{1}"
implements Configurable, but has no corresponding in config.xml
+missing-listener-configuration=Listener named "{1}" implements Configurable,
but has no corresponding in config.xml
+missing-block-configuration=Listener named "{1}" implements Configurable,
but has no corresponding in config.xml
lifecycle-stage.notice=Block named "{0}" is passing through the
{1,choice,0#Creation|1#Logger
initialization|2#Contextualization|3#Composing|4#Configuration|5#Parameterizing|6#Initialization|7#Starting|8#Stopping|9#Disposing|10#Destruction}
stage.
1.19 +6 -8
jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components/application/DefaultApplication.java
Index: DefaultApplication.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components/application/DefaultApplication.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- DefaultApplication.java 18 May 2002 23:41:08 -0000 1.18
+++ DefaultApplication.java 19 May 2002 02:35:26 -0000 1.19
@@ -16,7 +16,6 @@
import org.apache.avalon.framework.activity.Initializable;
import org.apache.avalon.framework.activity.Startable;
import org.apache.avalon.framework.activity.Disposable;
-import org.apache.avalon.phoenix.ApplicationEvent;
import org.apache.avalon.phoenix.interfaces.Application;
import org.apache.avalon.phoenix.interfaces.ApplicationContext;
import org.apache.avalon.phoenix.interfaces.ApplicationException;
@@ -343,14 +342,13 @@
if( PHASE_STARTUP == name )
{
//... for startup, so indicate to applicable listeners
- final ApplicationEvent event =
- new ApplicationEvent( m_sarMetaData.getName(), m_sarMetaData
);
- m_lifecycle.applicationStarting( event );
+ m_lifecycle.getAppListenerSupport().
+ fireApplicationStartingEvent( m_sarMetaData );
}
else
{
//... for shutdown, so indicate to applicable listeners
- m_lifecycle.applicationStopping();
+ m_lifecycle.getAppListenerSupport().applicationStopping();
}
//Process blocks, one by one.
@@ -383,7 +381,7 @@
final String message =
REZ.getString( "app.error.run-phase", name, block,
e.getMessage() );
getLogger().error( message, e );
- m_lifecycle.applicationFailure( e );
+ m_lifecycle.getAppListenerSupport().applicationFailure( e );
throw e;
}
@@ -399,12 +397,12 @@
if( PHASE_STARTUP == name )
{
//... for startup, so indicate to applicable listeners
- m_lifecycle.applicationStarted();
+ m_lifecycle.getAppListenerSupport().applicationStarted();
}
else
{
//... for shutdown, so indicate to applicable listeners
- m_lifecycle.applicationStopped();
+ m_lifecycle.getAppListenerSupport().applicationStopped();
}
}
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
