org.codehaus.cargo.generic.deployer

Class DefaultDeployerFactory

java.lang.Object

org.codehaus.cargo.util.log.LoggedObject

org.codehaus.cargo.generic.spi.AbstractGenericHintFactory<T>

org.codehaus.cargo.generic.spi.AbstractIntrospectionGenericHintFactory<Deployer>

org.codehaus.cargo.generic.deployer.DefaultDeployerFactory

All Implemented Interfaces:

DeployerFactory, org.codehaus.cargo.util.log.Loggable

public class DefaultDeployerFactory
extends AbstractIntrospectionGenericHintFactory<Deployer>
implements DeployerFactory

Default DeployerFactory implementation that has all the known container deployers registered against their containers. It also supports registering new deployers against any container.

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.cargo.generic.spi.AbstractGenericHintFactory

AbstractGenericHintFactory.GenericParameters

Constructor Summary

Constructors

Constructor and Description
DefaultDeployerFactory() Register default deployers.
DefaultDeployerFactory(ClassLoader classLoader) Register deployer name mappings.

Method Summary

Modifier and Type	Method and Description
Deployer	createDeployer(Container container) Create a Deployer instance whose type matches the container's type.
Deployer	createDeployer(Container container, DeployerType deployerType) Create a Deployer instance matching the specified container and type.
protected Deployer	createInstance(Constructor<? extends Deployer> constructor, String hint, AbstractGenericHintFactory.GenericParameters parameters) Create an implementation class instance.
protected Constructor<? extends Deployer>	getConstructor(Class<? extends Deployer> deployerClass, String hint, AbstractGenericHintFactory.GenericParameters parameters) Create a constructor.
Class<? extends Deployer>	getDeployerClass(String containerId, DeployerType deployerType)
boolean	isDeployerRegistered(String containerId, DeployerType deployerType)
void	registerDeployer(String containerId, DeployerType deployerType, Class<? extends Deployer> deployerClass) Registers a Deployer implementation.
void	registerDeployer(String containerId, DeployerType deployerType, String deployerClassName) Registers a deployer using a class specified as a String.

Methods inherited from class org.codehaus.cargo.generic.spi.AbstractIntrospectionGenericHintFactory

createImplementation, registerImplementation

Methods inherited from class org.codehaus.cargo.generic.spi.AbstractGenericHintFactory

getMapping, getMappings, hasMapping, registerImplementation

Methods inherited from class org.codehaus.cargo.util.log.LoggedObject

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultDeployerFactory

public DefaultDeployerFactory()

Register default deployers.

DefaultDeployerFactory

public DefaultDeployerFactory(ClassLoader classLoader)

Register deployer name mappings.

Parameters:

classLoader - ClassLoader to discover implementations from. See AbstractFactoryRegistry.register(ClassLoader, DeployerFactory) for the details of what this value means.

Method Detail

registerDeployer

public void registerDeployer(String containerId,
                             DeployerType deployerType,
                             Class<? extends Deployer> deployerClass)

Registers a Deployer implementation.

Specified by:

registerDeployer in interface DeployerFactory

Parameters:

containerId - the container attached to this deployerClass

deployerType - the deployer's type (local, remote, etc)

deployerClass - the deployer implementation class to register

See Also:

DeployerFactory.registerDeployer(String, DeployerType, Class)

registerDeployer

public void registerDeployer(String containerId,
                             DeployerType deployerType,
                             String deployerClassName)

Registers a deployer using a class specified as a String.

Parameters:

containerId -

deployerType -

deployerClassName - the deployer implementation class to register as a String

See Also:

registerDeployer(String, DeployerType, Class)

isDeployerRegistered

public boolean isDeployerRegistered(String containerId,
                                    DeployerType deployerType)

Specified by:

isDeployerRegistered in interface DeployerFactory

Parameters:

containerId - the container attached to this deployer class

deployerType - the type to differentiate this deployer from others for the specified container

Returns:

true if the specified deployer is already registered or false otherwise

See Also:

DeployerFactory.isDeployerRegistered(String, DeployerType)

getDeployerClass

public Class<? extends Deployer> getDeployerClass(String containerId,
                                                  DeployerType deployerType)

Specified by:

getDeployerClass in interface DeployerFactory

Parameters:

containerId - the container attached to this deployer class

deployerType - the deployer's type

Returns:

the deployer implementation class

See Also:

DeployerFactory.getDeployerClass(String, org.codehaus.cargo.container.deployer.DeployerType)

createDeployer

public Deployer createDeployer(Container container,
                               DeployerType deployerType)

Create a Deployer instance matching the specified container and type.

Specified by:

createDeployer in interface DeployerFactory

Parameters:

container - the container for which we need to create a deployer instance

deployerType - the deployer's type (local, remote, etc)

Returns:

the deployer instance

See Also:

DeployerFactory.createDeployer(Container, DeployerType)

createDeployer

public Deployer createDeployer(Container container)

Create a Deployer instance whose type matches the container's type. For example this creates a local deployer when the container's instance passed is a local container and a remote deployer when the container's instance passed is a remote container.

Specified by:

createDeployer in interface DeployerFactory

Parameters:

container - the container for which we need to create a deployer instance

Returns:

the deployer instance

See Also:

DeployerFactory.createDeployer(Container)

getConstructor

protected Constructor<? extends Deployer> getConstructor(Class<? extends Deployer> deployerClass,
                                                         String hint,
                                                         AbstractGenericHintFactory.GenericParameters parameters)
                                                  throws NoSuchMethodException

Create a constructor.

Specified by:

getConstructor in class AbstractGenericHintFactory<Deployer>

Parameters:

deployerClass - implementation class for which to create the constructor

hint - the hint to differentiate this implementation class from others

parameters - additional parameters necessary to create the constructor object

Returns:

the constructor to use for creating an instance

Throws:

NoSuchMethodException - in case of error

See Also:

AbstractGenericHintFactory.getConstructor(Class, String, GenericParameters)

createInstance

protected Deployer createInstance(Constructor<? extends Deployer> constructor,
                                  String hint,
                                  AbstractGenericHintFactory.GenericParameters parameters)
                           throws Exception

Create an implementation class instance.

Specified by:

createInstance in class AbstractGenericHintFactory<Deployer>

Parameters:

constructor - the constructor to use for creating the instance

hint - the hint to differentiate this implementation class from others

parameters - additional parameters necessary to create the instance

Returns:

the created instance

Throws:

Exception - in case of error

See Also:

AbstractGenericHintFactory.createInstance(java.lang.reflect.Constructor<? extends T>, java.lang.String, org.codehaus.cargo.generic.spi.AbstractGenericHintFactory.GenericParameters)