donaldp 2002/09/09 04:35:16
Added: info/src/java/org/apache/avalon/framework/tools/verifier
ComponentVerifier.java Resources.properties
VerifyException.java
Log:
Move component verifier into info package.
Revision Changes Path
1.1
jakarta-avalon-excalibur/info/src/java/org/apache/avalon/framework/tools/verifier/ComponentVerifier.java
Index: ComponentVerifier.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.framework.tools.verifier;
import java.lang.reflect.Constructor;
import java.lang.reflect.Modifier;
import org.apache.avalon.excalibur.i18n.ResourceManager;
import org.apache.avalon.excalibur.i18n.Resources;
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.activity.Suspendable;
import org.apache.avalon.framework.component.Composable;
import org.apache.avalon.framework.component.Recomposable;
import org.apache.avalon.framework.configuration.Configurable;
import org.apache.avalon.framework.configuration.Reconfigurable;
import org.apache.avalon.framework.context.Contextualizable;
import org.apache.avalon.framework.context.Recontextualizable;
import org.apache.avalon.framework.logger.AbstractLogEnabled;
import org.apache.avalon.framework.logger.LogEnabled;
import org.apache.avalon.framework.parameters.Parameterizable;
import org.apache.avalon.framework.parameters.Reparameterizable;
import org.apache.avalon.framework.service.Serviceable;
/**
* Utility class to help verify that component respects the
* rules of an Avalon component.
*
* @author <a href="mailto:peter at apache.org">Peter Donald</a>
* @version $Revision: 1.1 $ $Date: 2002/09/09 11:35:16 $
*/
public class ComponentVerifier
extends AbstractLogEnabled
{
private static final Resources REZ =
ResourceManager.getPackageResources( ComponentVerifier.class );
private static final Class[] EMPTY_TYPES = new Class[ 0 ];
/**
* The interfaces representing lifecycle stages.
*/
private static final Class[] FRAMEWORK_CLASSES = new Class[]
{
LogEnabled.class,
Contextualizable.class,
Recontextualizable.class,
Composable.class,
Recomposable.class,
Serviceable.class,
Configurable.class,
Reconfigurable.class,
Parameterizable.class,
Reparameterizable.class,
Initializable.class,
Startable.class,
Suspendable.class,
Disposable.class
};
/**
* Verify that the supplied implementation class
* and service classes are valid for a component.
*
* @param name the name of component
* @param implementation the implementation class of component
* @param services the classes representing services
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyComponent( final String name,
final Class implementation,
final Class[] services )
throws VerifyException
{
verifyClass( name, implementation );
verifyLifecycles( name, implementation );
verifyServices( name, services );
verifyImplementsServices( name, implementation, services );
}
/**
* Verify that the supplied implementation implements the specified
* services.
*
* @param name the name of component
* @param implementation the class representign component
* @param services the services that the implementation must provide
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyImplementsServices( final String name,
final Class implementation,
final Class[] services )
throws VerifyException
{
for( int i = 0; i < services.length; i++ )
{
if( !services[ i ].isAssignableFrom( implementation ) )
{
final String message =
REZ.getString( "verifier.noimpl-service.error",
name,
implementation.getName(),
services[ i ].getName() );
throw new VerifyException( message );
}
}
}
/**
* Verify that the supplied class is a valid class for
* a Component.
*
* @param name the name of component
* @param clazz the class representing component
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyClass( final String name,
final Class clazz )
throws VerifyException
{
verifyNoArgConstructor( name, clazz );
verifyNonAbstract( name, clazz );
verifyNonArray( name, clazz );
verifyNonInterface( name, clazz );
verifyNonPrimitive( name, clazz );
verifyPublic( name, clazz );
}
/**
* Verify that the supplied classes are valid classes for
* a service.
*
* @param name the name of component
* @param classes the classes representign services
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyServices( final String name,
final Class[] classes )
throws VerifyException
{
for( int i = 0; i < classes.length; i++ )
{
verifyService( name, classes[ i ] );
}
}
/**
* Verify that the supplied class is a valid class for
* a service.
*
* @param name the name of component
* @param clazz the class representign service
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyService( final String name,
final Class clazz )
throws VerifyException
{
verifyServiceIsaInterface( name, clazz );
verifyServiceIsPublic( name, clazz );
verifyServiceNotALifecycle( name, clazz );
}
/**
* Verify that the implementation class does not
* implement incompatible lifecycle interfaces.
*
* @param name the name of component
* @param implementation the implementation class
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyLifecycles( final String name,
final Class implementation )
throws VerifyException
{
final boolean composable =
Composable.class.isAssignableFrom( implementation ) ||
Recomposable.class.isAssignableFrom( implementation );
final boolean serviceable = Serviceable.class.isAssignableFrom(
implementation );
if( serviceable && composable )
{
final String message =
REZ.getString( "verifier.incompat-serviceable.error",
name,
implementation.getName() );
getLogger().error( message );
throw new VerifyException( message );
}
final boolean configurable =
Configurable.class.isAssignableFrom( implementation ) ||
Reconfigurable.class.isAssignableFrom( implementation );
final boolean parameterizable =
Parameterizable.class.isAssignableFrom( implementation ) ||
Reparameterizable.class.isAssignableFrom( implementation );
if( parameterizable && configurable )
{
final String message =
REZ.getString( "verifier.incompat-config.error",
name,
implementation.getName() );
getLogger().error( message );
throw new VerifyException( message );
}
}
/**
* Verify that the service implemented by
* specified component is an interface.
*
* @param name the name of component
* @param clazz the class representign service
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyServiceIsaInterface( final String name,
final Class clazz )
throws VerifyException
{
if( !clazz.isInterface() )
{
final String message =
REZ.getString( "verifier.non-interface-service.error",
name,
clazz.getName() );
getLogger().error( message );
throw new VerifyException( message );
}
}
/**
* Verify that the service implemented by
* specified component is public.
*
* @param name the name of component
* @param clazz the class representign service
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyServiceIsPublic( final String name,
final Class clazz )
throws VerifyException
{
final boolean isPublic =
Modifier.isPublic( clazz.getModifiers() );
if( !isPublic )
{
final String message =
REZ.getString( "verifier.non-public-service.error",
name,
clazz.getName() );
getLogger().error( message );
throw new VerifyException( message );
}
}
/**
* Verify that the service implemented by
* specified component does not extend any lifecycle interfaces.
*
* @param name the name of component
* @param clazz the class representign service
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyServiceNotALifecycle( final String name,
final Class clazz )
throws VerifyException
{
for( int i = 0; i < FRAMEWORK_CLASSES.length; i++ )
{
final Class lifecycle = FRAMEWORK_CLASSES[ i ];
if( lifecycle.isAssignableFrom( clazz ) )
{
final String message =
REZ.getString( "verifier.service-isa-lifecycle.error",
name,
clazz.getName(),
lifecycle.getName() );
getLogger().error( message );
throw new VerifyException( message );
}
}
}
/**
* Verify that the component has a no-arg aka default
* constructor.
*
* @param name the name of component
* @param clazz the class representign component
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyNoArgConstructor( final String name,
final Class clazz )
throws VerifyException
{
try
{
final Constructor ctor = clazz.getConstructor( EMPTY_TYPES );
if( !Modifier.isPublic( ctor.getModifiers() ) )
{
final String message =
REZ.getString( "verifier.non-public-ctor.error",
name,
clazz.getName() );
getLogger().error( message );
throw new VerifyException( message );
}
}
catch( final NoSuchMethodException nsme )
{
final String message =
REZ.getString( "verifier.missing-noargs-ctor.error",
name,
clazz.getName() );
getLogger().error( message );
throw new VerifyException( message );
}
}
/**
* Verify that the component is not represented by
* abstract class.
*
* @param name the name of component
* @param clazz the class representign component
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyNonAbstract( final String name,
final Class clazz )
throws VerifyException
{
final boolean isAbstract =
Modifier.isAbstract( clazz.getModifiers() );
if( isAbstract )
{
final String message =
REZ.getString( "verifier.abstract-class.error",
name,
clazz.getName() );
getLogger().error( message );
throw new VerifyException( message );
}
}
/**
* Verify that the component is not represented by
* abstract class.
*
* @param name the name of component
* @param clazz the class representign component
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyPublic( final String name,
final Class clazz )
throws VerifyException
{
final boolean isPublic =
Modifier.isPublic( clazz.getModifiers() );
if( !isPublic )
{
final String message =
REZ.getString( "verifier.nonpublic-class.error",
name,
clazz.getName() );
getLogger().error( message );
throw new VerifyException( message );
}
}
/**
* Verify that the component is not represented by
* primitive class.
*
* @param name the name of component
* @param clazz the class representign component
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyNonPrimitive( final String name,
final Class clazz )
throws VerifyException
{
if( clazz.isPrimitive() )
{
final String message =
REZ.getString( "verifier.primitive-class.error",
name,
clazz.getName() );
getLogger().error( message );
throw new VerifyException( message );
}
}
/**
* Verify that the component is not represented by
* interface class.
*
* @param name the name of component
* @param clazz the class representign component
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyNonInterface( final String name,
final Class clazz )
throws VerifyException
{
if( clazz.isInterface() )
{
final String message =
REZ.getString( "verifier.interface-class.error",
name,
clazz.getName() );
getLogger().error( message );
throw new VerifyException( message );
}
}
/**
* Verify that the component is not represented by
* an array class.
*
* @param name the name of component
* @param clazz the class representign component
* @throws VerifyException if error thrown on failure and
* component fails check
*/
public void verifyNonArray( final String name,
final Class clazz )
throws VerifyException
{
if( clazz.isArray() )
{
final String message =
REZ.getString( "verifier.array-class.error",
name,
clazz.getName() );
getLogger().error( message );
throw new VerifyException( message );
}
}
}
1.1
jakarta-avalon-excalibur/info/src/java/org/apache/avalon/framework/tools/verifier/Resources.properties
Index: Resources.properties
===================================================================
#From Verifier class
verifier.non-public-ctor.error=The implementation class {1} for component named
"{0}" does not have a public no-arg constructor.
verifier.missing-noargs-ctor.error=The implementation class {1} for component named
"{0}" does not have a no-arg constructor.
verifier.abstract-class.error=The implementation class {1} for component named "{0}"
is abstract.
verifier.nonpublic-class.error=The implementation class {1} for component named
"{0}" is not public.
verifier.primitive-class.error=The implementation class {1} for component named
"{0}" is primitive.
verifier.interface-class.error=The implementation class {1} for component named
"{0}" is an interface.
verifier.array-class.error=The implementation class {1} for component named "{0}" is
an array class.
verifier.non-interface-service.error=The service class {1} for component named "{0}"
is not an interface.
verifier.non-public-service.error=The service class {1} for component named "{0}" is
not public.
verifier.incompat-serviceable.error=The implementation class {1} for component named
"{0}" is both Serviceable and Composable (incompatible lifecycle interfaces).
verifier.incompat-config.error=The implementation class {1} for component named
"{0}" is both Configurable and Parameterizable (incompatible lifecycle interfaces).
verifier.noimpl-service.error=The implementation class {1} for component named "{0}"
does not implement the service interface {2} which it declares it supports.
1.1
jakarta-avalon-excalibur/info/src/java/org/apache/avalon/framework/tools/verifier/VerifyException.java
Index: VerifyException.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.framework.tools.verifier;
import org.apache.avalon.framework.CascadingException;
/**
* Exception to indicate error verifying a Block or application.
*
* @author <a href="mailto:peter at apache.org">Peter Donald</a>
* @version $Revision: 1.1 $ $Date: 2002/09/09 11:35:16 $
*/
public final class VerifyException
extends CascadingException
{
/**
* Construct a new <code>VerifyException</code> instance.
*
* @param message The detail message for this exception.
*/
public VerifyException( final String message )
{
this( message, null );
}
/**
* Construct a new <code>VerifyException</code> instance.
*
* @param message The detail message for this exception.
* @param throwable the root cause of the exception
*/
public VerifyException( final String message, final Throwable throwable )
{
super( message, throwable );
}
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
