org.jboss.deployers.spi.deployer
Interface Deployer

All Superinterfaces:

org.jboss.deployers.spi.Ordered

All Known Implementing Classes:

AbstractClassLoaderDeployer, AbstractComponentDeployer, AbstractDeployer, AbstractOptionalRealDeployer, AbstractParsingDeployer, AbstractParsingDeployerWithOutput, AbstractRealDeployer, AbstractRealDeployerWithInput, AbstractSimpleRealDeployer, AbstractTopLevelClassLoaderDeployer

public interface Deployer
extends org.jboss.deployers.spi.Ordered

Deployer.

Version:

$Revision: 1.1 $

Author:

Adrian Brock

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.deployers.spi.Ordered

org.jboss.deployers.spi.Ordered.OrderedComparator

Field Summary

Fields inherited from interface org.jboss.deployers.spi.Ordered

COMPARATOR

Method Summary

void	deploy(org.jboss.deployers.structure.spi.DeploymentUnit unit) Deploy a deployment
Class<?>	getInput() Get the input for this deployer
Set<String>	getInputs() Get the input for this deployer
Class<?>	getOutput() Get the otput for this deployer
Set<String>	getOutputs() Get the outputs for this deployer
DeploymentStage	getStage() Get the deployment stage for this deployer
String	getType() Get the type of the deployer.
boolean	isAllInputs() Whether we want all inputs
boolean	isComponentsOnly() Whether we only want components
boolean	isParentFirst() Whether to process parents before children (default true)
boolean	isTopLevelOnly() Whether we only want the top level
boolean	isWantComponents() Whether we dont want components
void	undeploy(org.jboss.deployers.structure.spi.DeploymentUnit unit) Undeploy an deployment

Methods inherited from interface org.jboss.deployers.spi.Ordered

getRelativeOrder, setRelativeOrder

Method Detail

getType

String getType()

Get the type of the deployer. This should be reflected in the DeploymentUnit deploymentType set of deployments the Deployer processes.

Returns:

the deployer type.

getStage

DeploymentStage getStage()

Get the deployment stage for this deployer

Returns:

the stage

isTopLevelOnly

boolean isTopLevelOnly()

Whether we only want the top level

Returns:

true for top level only

isComponentsOnly

boolean isComponentsOnly()

Whether we only want components

Returns:

true for components only

isWantComponents

boolean isWantComponents()

Whether we dont want components

Returns:

true for no components

isAllInputs

boolean isAllInputs()

Whether we want all inputs

Returns:

true for all inputs

getInput

Class<?> getInput()

Get the input for this deployer

Returns:

the input type

getOutput

Class<?> getOutput()

Get the otput for this deployer

Returns:

the output type

getInputs

Set<String> getInputs()

Get the input for this deployer

Returns:

the inputs

getOutputs

Set<String> getOutputs()

Get the outputs for this deployer

Returns:

the outputs

isParentFirst

boolean isParentFirst()

Whether to process parents before children (default true)

Returns:

true to process parents first

deploy

void deploy(org.jboss.deployers.structure.spi.DeploymentUnit unit)
            throws org.jboss.deployers.spi.DeploymentException

Deploy a deployment

Parameters:

unit - the unit

Throws:

org.jboss.deployers.spi.DeploymentException - for any error

undeploy

void undeploy(org.jboss.deployers.structure.spi.DeploymentUnit unit)

Undeploy an deployment

Parameters:

unit - the unit