/* ====================================================================
* Loom Software License, version 1.1
*
* Copyright (c) 2003, Loom Group. 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. Neither the name of the Loom Group nor the name "Loom" nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS 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
* COPYRIGHT OWNER OR 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.
*
* ====================================================================
*
* Loom includes code from the Apache Software Foundation
*
* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 1997-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 "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.
*/
package org.codehaus.loom.components.util.verifier;
import org.codehaus.loom.components.util.metadata.ComponentTemplate;
import org.codehaus.loom.components.util.profile.ComponentProfile;
import org.codehaus.loom.components.util.profile.PartitionProfile;
import org.codehaus.loom.interfaces.ContainerConstants;
import org.codehaus.spice.salt.i18n.ResourceManager;
import org.codehaus.spice.salt.i18n.Resources;
import org.codehaus.dna.Logger;
/**
* This Class verifies that Sars are valid. It performs a number of checks to make sure that the Sar represents a valid
* application and excluding runtime errors will start up validly. Some of the checks it performs include;
*
* <ul> <li>Verify names of Sar, Blocks and BlockListeners contain only letters, digits or the '_' character.</li>
* <li>Verify that the names of the Blocks and BlockListeners are unique to Sar.</li> <li>Verify that the
* dependendencies specified in assembly.xml correspond to dependencies specified in BlockInfo files.</li> <li>Verify
* that the inter-block dependendencies specified in assembly.xml are valid. This essentially means that if Block A
* requires Service S from Block B then Block B must provide Service S.</li> <li>Verify that there are no circular
* dependendencies between blocks.</li> <li>Verify that the Class objects for Blocks support the Block interface and any
* specified Services.</li> <li>Verify that the Class objects for BlockListeners support the BlockListener
* interface.</li> </ul>
*
* @author Peter Donald
* @version $Revision: 1.3 $ $Date: 2004/08/17 23:14:32 $
*/
public class SarVerifier
extends AssemblyVerifier
{
/**
* I18n utils.
*/
private static final Resources REZ =
ResourceManager.getPackageResources( SarVerifier.class );
/**
* The Block class used to warn about deprecation.
*/
private static final Class BLOCK_CLASS =
getClass( "org.apache.avalon.phoenix.Block" );
/**
* The BlockListener class used to warn about deprecation.
*/
private static final Class BLOCKLISTENER_CLASS =
getClass( "org.apache.avalon.phoenix.BlockListener" );
/**
* The Verifier for Info instances.
*/
private final ComponentVerifier m_infoVerifier = new ComponentVerifier();
public void enableLogging( final Logger logger )
{
super.enableLogging( logger );
setupLogger( m_infoVerifier );
}
/**
* Verify the specified {@link org.codehaus.loom.components.util.profile.PartitionProfile} object. The rules used
* to verify {@link org.codehaus.loom.components.util.profile.PartitionProfile} are specified in the Class
* javadocs.
*
* @param profile the Sar profile
* @param classLoader the classloader to load types from
*
* @throws Exception if an error occurs
*/
public void verifySar( final PartitionProfile profile,
final ClassLoader classLoader )
throws Exception
{
final ComponentProfile[] blocks =
profile.getPartition( ContainerConstants.BLOCK_PARTITION )
.getComponents();
final ComponentProfile[] listeners =
profile.getPartition( ContainerConstants.LISTENER_PARTITION )
.getComponents();
String message;
message = REZ.getString( "verify-valid-names" );
getLogger().info( message );
verifySarName( profile.getMetaData().getName() );
verifyValidNames( listeners );
super.verifyAssembly( blocks );
message = REZ.getString( "verify-unique-names" );
getLogger().info( message );
checkNamesUnique( blocks, listeners );
message = REZ.getString( "verify-block-type" );
getLogger().info( message );
verifyBlocksType( blocks, classLoader );
message = REZ.getString( "verify-listener-type" );
getLogger().info( message );
verifyListenersType( listeners, classLoader );
}
/**
* Verfiy that all Blocks specify classes that implement the advertised interfaces.
*
* @param blocks the ComponentProfile objects for the blocks
* @param classLoader the Classloader to load type from
*
* @throws Exception if an error occurs
*/
private void verifyBlocksType( final ComponentProfile[] blocks,
final ClassLoader classLoader )
throws Exception
{
for( int i = 0; i < blocks.length; i++ )
{
verifyBlockType( blocks[i], classLoader );
}
}
/**
* Verfiy that specified Block designate classes that implement the advertised interfaces.
*
* @param block the BlockMetaData object for the blocks
* @param classLoader the classloader to load type from
*
* @throws Exception if an error occurs
*/
private void verifyBlockType( final ComponentProfile block,
final ClassLoader classLoader )
throws Exception
{
final ComponentTemplate metaData = block.getTemplate();
final Class clazz = loadClass( "block", metaData, classLoader );
m_infoVerifier.verifyType( metaData.getName(),
block.getInfo().getType() );
if( BLOCK_CLASS.isAssignableFrom( clazz ) )
{
final String message =
REZ.format( "verifier.implements-block.error",
metaData.getName(),
metaData.getImplementationKey() );
getLogger().error( message );
System.err.println( message );
}
}
private Class loadClass( final String type,
final ComponentTemplate metaData,
final ClassLoader classLoader )
throws Exception
{
try
{
return classLoader.loadClass( metaData.getImplementationKey() );
}
catch( final Exception e )
{
final String message =
REZ.format( "bad-" + type + "-class",
metaData.getName(),
metaData.getImplementationKey(),
e.getMessage() );
throw new Exception( message );
}
}
/**
* Verfiy that all listeners implement BlockListener.
*
* @param listeners the BlockListenerMetaData objects for the listeners
* @param classLoader the classloader to load type from
*
* @throws Exception if an error occurs
*/
private void verifyListenersType( final ComponentProfile[] listeners,
final ClassLoader classLoader )
throws Exception
{
for( int i = 0; i < listeners.length; i++ )
{
verifyListenerType( listeners[i], classLoader );
}
}
/**
* Verfiy that specified Listener class implements the BlockListener interface.
*
* @param listener the BlockListenerMetaData object for the listener
* @param classLoader the classloader to laod type from
*
* @throws Exception if an error occurs
*/
private void verifyListenerType( final ComponentProfile listener,
final ClassLoader classLoader )
throws Exception
{
final ComponentTemplate metaData = listener.getTemplate();
final Class clazz = loadClass( "listener", metaData, classLoader );
if( !BLOCKLISTENER_CLASS.isAssignableFrom( clazz ) )
{
final String message =
REZ.format( "listener-noimpl-listener",
metaData,
metaData );
throw new Exception( message );
}
}
/**
* Verify that the Sat name specified is valid.
*
* @param name the sar name
*
* @throws Exception if an error occurs
*/
private void verifySarName( final String name )
throws Exception
{
if( !isValidName( name ) )
{
final String message = REZ.format( "invalid-sar-name", name );
throw new Exception( message );
}
}
/**
* Return true if specified name is valid. Valid names consist of letters, digits or the '-' & '.' characters.
*
* @param name the name to check
*
* @return true if valid, false otherwise
*/
public boolean isValidName( final String name )
{
final int size = name.length();
for( int i = 0; i < size; i++ )
{
final char ch = name.charAt( i );
if( !Character.isLetterOrDigit( ch ) && '-' != ch && '.' != ch )
{
return false;
}
}
return true;
}
/**
* Verify that the names of the specified blocks and listeners are unique. It is not valid for the same name to be
* used in multiple Blocks and or BlockListeners.
*
* @param blocks the Blocks
* @param listeners the listeners
*
* @throws Exception if an error occurs
*/
private void checkNamesUnique( final ComponentProfile[] blocks,
final ComponentProfile[] listeners )
throws Exception
{
for( int i = 0; i < blocks.length; i++ )
{
final String name = blocks[i].getTemplate().getName();
checkNameUnique( name, blocks, listeners, i, -1 );
}
for( int i = 0; i < listeners.length; i++ )
{
final String name = listeners[i].getTemplate().getName();
checkNameUnique( name, blocks, listeners, -1, i );
}
}
/**
* Verify that the specified name is unique among specified blocks and listeners except for those indexes
* specified.
*
* @param name the name to check for
* @param blocks the Blocks
* @param listeners the listeners
* @param blockIndex the index of block that is allowed to match in name (or -1 if name designates a listener)
* @param listenerIndex the index of listener that is allowed to match in name (or -1 if name designates a block)
*
* @throws Exception if an error occurs
*/
private void checkNameUnique( final String name,
final ComponentProfile[] blocks,
final ComponentProfile[] listeners,
final int blockIndex,
final int listenerIndex )
throws Exception
{
//Verify no blocks have the same name
for( int i = 0; i < blocks.length; i++ )
{
final String other = blocks[i].getTemplate().getName();
if( blockIndex != i && name.equals( other ) )
{
final String message = REZ.format( "duplicate-name", name );
throw new Exception( message );
}
}
//Verify no listeners have the same name
for( int i = 0; i < listeners.length; i++ )
{
final String other = listeners[i].getTemplate().getName();
if( listenerIndex != i && name.equals( other ) )
{
final String message = REZ.format( "duplicate-name", name );
throw new Exception( message );
}
}
}
/**
* Load class with specified name and throw a IllegalStateException if unable to load class.
*
* @param classname the name of class to load
*
* @return the Class object
*/
private static Class getClass( final String classname )
{
try
{
return Class.forName( classname );
}
catch( final ClassNotFoundException cnfe )
{
final String message = "Unable to locate class " +
classname + " due to " + cnfe;
throw new IllegalStateException( message );
}
}
}