org.jboss.deployers.plugins.deployers
Class DeployersImpl

java.lang.Object
  org.jboss.deployers.plugins.deployers.DeployersImpl

All Implemented Interfaces:

org.jboss.dependency.spi.ControllerContextActions, org.jboss.deployers.spi.deployer.Deployers

public class DeployersImpl
extends Object
implements org.jboss.deployers.spi.deployer.Deployers, org.jboss.dependency.spi.ControllerContextActions

DeployersImpl.

Version:

$Revision: 1.1 $

Author:

Adrian Brock, Ales Justin

Constructor Summary

DeployersImpl(org.jboss.dependency.plugins.AbstractController controller)
Create a new DeployersImpl.

DeployersImpl(org.jboss.dependency.plugins.AbstractController controller, Set<org.jboss.deployers.spi.deployer.Deployer> deployers)
Create a new DeployersImpl.

Method Summary

void	addDeployer(org.jboss.deployers.spi.deployer.Deployer deployer) Add a deployer
protected void	addDeploymentStage(org.jboss.deployers.spi.deployer.DeploymentStage stage) Add a deployment stage
protected void	checkComplete(boolean checkContexts, org.jboss.deployers.structure.spi.DeploymentContext... contexts) Check if deployments are complete.
void	checkComplete(Collection<org.jboss.deployers.structure.spi.DeploymentContext> errors, Collection<org.jboss.deployers.client.spi.Deployment> missingDeployer)
void	checkComplete(org.jboss.deployers.structure.spi.DeploymentContext... contexts)
protected void	checkComplete(org.jboss.deployers.structure.spi.DeploymentContext context, Map<String,Throwable> contextsInError, Map<String,Set<org.jboss.deployers.client.spi.MissingDependency>> contextsMissingDependencies, Set<org.jboss.dependency.spi.ControllerContext> notInstalled, List<org.jboss.dependency.spi.ControllerState> states) Check complete on deployment context.
protected void	checkControllerContext(org.jboss.dependency.spi.ControllerContext context, Map<String,Throwable> contextsInError, Map<String,Set<org.jboss.deployers.client.spi.MissingDependency>> contextsMissingDependencies, List<org.jboss.dependency.spi.ControllerState> states) Check controller context.
protected void	checkControllerContext(org.jboss.dependency.spi.ControllerContext context, Map<String,Throwable> contextsInError, Map<String,Set<org.jboss.deployers.client.spi.MissingDependency>> contextsMissingDependencies, Set<org.jboss.dependency.spi.ControllerContext> notInstalled, List<org.jboss.dependency.spi.ControllerState> states) Check complete on deployment context.
void	checkStructureComplete(org.jboss.deployers.structure.spi.DeploymentContext... contexts)
protected void	doInstallParentFirst(org.jboss.deployers.spi.deployer.Deployer deployer, org.jboss.deployers.structure.spi.DeploymentContext context) Do the install parent first
protected void	doInstallParentLast(org.jboss.deployers.spi.deployer.Deployer deployer, org.jboss.deployers.structure.spi.DeploymentContext context) Do the install parent last
protected void	doUninstallParentFirst(org.jboss.deployers.spi.deployer.Deployer deployer, org.jboss.deployers.structure.spi.DeploymentContext context, boolean doContext, boolean doComponents) Do the uninstall parent first
protected void	doUninstallParentLast(org.jboss.deployers.spi.deployer.Deployer deployer, org.jboss.deployers.structure.spi.DeploymentContext context, boolean doChildren, boolean doComponents) Do the uninstall parent last
org.jboss.deployers.spi.deployer.managed.ManagedObjectCreator	getDeployerManagedObjectBuilder(org.jboss.deployers.spi.deployer.Deployer deployer) Get the ManagedObjectBuilder for a deployer.
protected List<org.jboss.deployers.spi.deployer.Deployer>	getDeployersList(String stageName) Build a list of deployers for this stage
Set<DeployerWrapper>	getDeployerWrappers() Get the deployers.
Map<String,org.jboss.managed.api.ManagedObject>	getManagedObjects(org.jboss.deployers.structure.spi.DeploymentContext context)
org.jboss.metadata.spi.repository.MutableMetaDataRepository	getRepository() Get the repository.
org.jboss.deployers.structure.spi.scope.ScopeBuilder	getScopeBuilder() Get the scopeBuilder.
protected List<org.jboss.deployers.spi.deployer.Deployer>	insert(List<org.jboss.deployers.spi.deployer.Deployer> original, org.jboss.deployers.spi.deployer.Deployer newDeployer) Insert the new Deployer.
void	install(org.jboss.dependency.spi.ControllerContext context, org.jboss.dependency.spi.ControllerState fromState, org.jboss.dependency.spi.ControllerState toState)
protected boolean	isDeployed(org.jboss.deployers.structure.spi.DeploymentContext context) Is context deployed.
protected boolean	isRelevant(org.jboss.deployers.spi.deployer.Deployer deployer, org.jboss.deployers.structure.spi.DeploymentUnit unit, boolean isTopLevel, boolean isComponent) Test whether a deployer is relevant
void	process(List<org.jboss.deployers.structure.spi.DeploymentContext> deploy, List<org.jboss.deployers.structure.spi.DeploymentContext> undeploy)
void	removeDeployer(org.jboss.deployers.spi.deployer.Deployer deployer) Remove a deployer
void	setDeployerManagedObjectBuilder(org.jboss.deployers.spi.deployer.Deployer deployer, org.jboss.deployers.spi.deployer.managed.ManagedObjectCreator managedObjectCreator) Set the ManagedObjectBuilder for a deployer.
void	setDeployers(Set<org.jboss.deployers.spi.deployer.Deployer> deployers) Set the deployers.
void	setRepository(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository) Set the repository.
void	setScopeBuilder(org.jboss.deployers.structure.spi.scope.ScopeBuilder scopeBuilder) Set the scopeBuilder.
void	start()
void	uninstall(org.jboss.dependency.spi.ControllerContext context, org.jboss.dependency.spi.ControllerState fromState, org.jboss.dependency.spi.ControllerState toState)

Methods inherited from class java.lang.Object

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

Constructor Detail

DeployersImpl

public DeployersImpl(org.jboss.dependency.plugins.AbstractController controller)

Create a new DeployersImpl.

Parameters:

controller - the controller

Throws:

IllegalArgumentException - for a null controller

DeployersImpl

public DeployersImpl(org.jboss.dependency.plugins.AbstractController controller,
                     Set<org.jboss.deployers.spi.deployer.Deployer> deployers)

Create a new DeployersImpl.

Parameters:

controller - the controller

deployers - the deployers

Throws:

IllegalArgumentException - for a null controller

Method Detail

getDeployerWrappers

public Set<DeployerWrapper> getDeployerWrappers()

Get the deployers.

Returns:

the deployers.

setDeployers

public void setDeployers(Set<org.jboss.deployers.spi.deployer.Deployer> deployers)

Set the deployers.

Parameters:

deployers - the deployers.

Throws:

IllegalArgumentException - for null deployers

addDeployer

public void addDeployer(org.jboss.deployers.spi.deployer.Deployer deployer)

Add a deployer

Parameters:

deployer - the deployer

removeDeployer

public void removeDeployer(org.jboss.deployers.spi.deployer.Deployer deployer)

Remove a deployer

Parameters:

deployer - the deployer

addDeploymentStage

protected void addDeploymentStage(org.jboss.deployers.spi.deployer.DeploymentStage stage)

Add a deployment stage

Parameters:

stage - the deployment stage

getScopeBuilder

public org.jboss.deployers.structure.spi.scope.ScopeBuilder getScopeBuilder()

Get the scopeBuilder.

Returns:

the scopeBuilder.

setScopeBuilder

public void setScopeBuilder(org.jboss.deployers.structure.spi.scope.ScopeBuilder scopeBuilder)

Set the scopeBuilder.

Parameters:

scopeBuilder - the scopeBuilder.

getRepository

public org.jboss.metadata.spi.repository.MutableMetaDataRepository getRepository()

Get the repository.

Returns:

the repository.

setRepository

public void setRepository(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository)

Set the repository.

Parameters:

repository - the repository.

start

public void start()

getManagedObjects

public Map<String,org.jboss.managed.api.ManagedObject> getManagedObjects(org.jboss.deployers.structure.spi.DeploymentContext context)
                                                                  throws org.jboss.deployers.spi.DeploymentException

Specified by:

getManagedObjects in interface org.jboss.deployers.spi.deployer.Deployers

Throws:

org.jboss.deployers.spi.DeploymentException

getDeployerManagedObjectBuilder

public org.jboss.deployers.spi.deployer.managed.ManagedObjectCreator getDeployerManagedObjectBuilder(org.jboss.deployers.spi.deployer.Deployer deployer)

Get the ManagedObjectBuilder for a deployer.

Parameters:

deployer - - the deployer to set the ManagedObjectBuilder for.

Returns:

managedObjectBuilder for deployer, may be null

Throws:

IllegalArgumentException - for a null deployer

setDeployerManagedObjectBuilder

public void setDeployerManagedObjectBuilder(org.jboss.deployers.spi.deployer.Deployer deployer,
                                            org.jboss.deployers.spi.deployer.managed.ManagedObjectCreator managedObjectCreator)

Set the ManagedObjectBuilder for a deployer. This allows one to override the given deployer ManagedObjectBuilder or assign one when the deployer does not provide a ManagedObjectBuilder.

Parameters:

deployer - - the deployer to set the ManagedObjectBuilder for.

managedObjectCreator - the managed object builder to set to the deployer

Throws:

IllegalArgumentException - for a null deployer

process

public void process(List<org.jboss.deployers.structure.spi.DeploymentContext> deploy,
                    List<org.jboss.deployers.structure.spi.DeploymentContext> undeploy)

Specified by:

process in interface org.jboss.deployers.spi.deployer.Deployers

checkComplete

public void checkComplete(Collection<org.jboss.deployers.structure.spi.DeploymentContext> errors,
                          Collection<org.jboss.deployers.client.spi.Deployment> missingDeployer)
                   throws org.jboss.deployers.spi.DeploymentException

Specified by:

checkComplete in interface org.jboss.deployers.spi.deployer.Deployers

Throws:

org.jboss.deployers.spi.DeploymentException

checkControllerContext

protected final void checkControllerContext(org.jboss.dependency.spi.ControllerContext context,
                                            Map<String,Throwable> contextsInError,
                                            Map<String,Set<org.jboss.deployers.client.spi.MissingDependency>> contextsMissingDependencies,
                                            List<org.jboss.dependency.spi.ControllerState> states)

Check controller context.

Parameters:

context - the controller context

contextsInError - contexts in error map

contextsMissingDependencies - contexts missing dependecies map

states - controller states

checkComplete

public void checkComplete(org.jboss.deployers.structure.spi.DeploymentContext... contexts)
                   throws org.jboss.deployers.spi.DeploymentException

Specified by:

checkComplete in interface org.jboss.deployers.spi.deployer.Deployers

Throws:

org.jboss.deployers.spi.DeploymentException

checkStructureComplete

public void checkStructureComplete(org.jboss.deployers.structure.spi.DeploymentContext... contexts)
                            throws org.jboss.deployers.spi.DeploymentException

Specified by:

checkStructureComplete in interface org.jboss.deployers.spi.deployer.Deployers

Throws:

org.jboss.deployers.spi.DeploymentException

checkComplete

protected void checkComplete(boolean checkContexts,
                             org.jboss.deployers.structure.spi.DeploymentContext... contexts)
                      throws org.jboss.deployers.spi.DeploymentException

Check if deployments are complete.

Parameters:

contexts - the deployment contexts

checkContexts - do we check contexts

Throws:

org.jboss.deployers.spi.DeploymentException - throw error if deployment is incomplete

isDeployed

protected boolean isDeployed(org.jboss.deployers.structure.spi.DeploymentContext context)

Is context deployed.

Parameters:

context - the deployment context

Returns:

true if context deployed, false otherwise

checkComplete

protected final void checkComplete(org.jboss.deployers.structure.spi.DeploymentContext context,
                                   Map<String,Throwable> contextsInError,
                                   Map<String,Set<org.jboss.deployers.client.spi.MissingDependency>> contextsMissingDependencies,
                                   Set<org.jboss.dependency.spi.ControllerContext> notInstalled,
                                   List<org.jboss.dependency.spi.ControllerState> states)

Check complete on deployment context.

Parameters:

context - the deployment context

contextsInError - contexts in error map

contextsMissingDependencies - contexts missing dependecies map

notInstalled - the not installed contexts

states - controller states

checkControllerContext

protected void checkControllerContext(org.jboss.dependency.spi.ControllerContext context,
                                      Map<String,Throwable> contextsInError,
                                      Map<String,Set<org.jboss.deployers.client.spi.MissingDependency>> contextsMissingDependencies,
                                      Set<org.jboss.dependency.spi.ControllerContext> notInstalled,
                                      List<org.jboss.dependency.spi.ControllerState> states)

Check complete on deployment context.

Parameters:

context - the deployment context

contextsInError - contexts in error map

contextsMissingDependencies - contexts missing dependecies map

notInstalled - the not installed contexts

states - controller states

install

public void install(org.jboss.dependency.spi.ControllerContext context,
                    org.jboss.dependency.spi.ControllerState fromState,
                    org.jboss.dependency.spi.ControllerState toState)
             throws Throwable

Specified by:

install in interface org.jboss.dependency.spi.ControllerContextActions

Throws:

Throwable

doInstallParentFirst

protected void doInstallParentFirst(org.jboss.deployers.spi.deployer.Deployer deployer,
                                    org.jboss.deployers.structure.spi.DeploymentContext context)
                             throws Throwable

Do the install parent first

Parameters:

deployer - the deployer

context - the context

Throws:

Throwable - for any problem

doInstallParentLast

protected void doInstallParentLast(org.jboss.deployers.spi.deployer.Deployer deployer,
                                   org.jboss.deployers.structure.spi.DeploymentContext context)
                            throws Throwable

Do the install parent last

Parameters:

deployer - the deployer

context - the context

Throws:

Throwable - for any problem

uninstall

public void uninstall(org.jboss.dependency.spi.ControllerContext context,
                      org.jboss.dependency.spi.ControllerState fromState,
                      org.jboss.dependency.spi.ControllerState toState)

Specified by:

uninstall in interface org.jboss.dependency.spi.ControllerContextActions

doUninstallParentLast

protected void doUninstallParentLast(org.jboss.deployers.spi.deployer.Deployer deployer,
                                     org.jboss.deployers.structure.spi.DeploymentContext context,
                                     boolean doChildren,
                                     boolean doComponents)

Do the uninstall parent last

Parameters:

deployer - the deployer

context - the context

doChildren - whether to do children

doComponents - whether to do components

doUninstallParentFirst

protected void doUninstallParentFirst(org.jboss.deployers.spi.deployer.Deployer deployer,
                                      org.jboss.deployers.structure.spi.DeploymentContext context,
                                      boolean doContext,
                                      boolean doComponents)

Do the uninstall parent first

Parameters:

deployer - the deployer

context - the context

doContext - whether to do context

doComponents - whether to do components

getDeployersList

protected List<org.jboss.deployers.spi.deployer.Deployer> getDeployersList(String stageName)

Build a list of deployers for this stage

Parameters:

stageName - the stage name

Returns:

the deployers

isRelevant

protected boolean isRelevant(org.jboss.deployers.spi.deployer.Deployer deployer,
                             org.jboss.deployers.structure.spi.DeploymentUnit unit,
                             boolean isTopLevel,
                             boolean isComponent)

Test whether a deployer is relevant

Parameters:

deployer - deployer

unit - the deployment unit

isTopLevel - whether this is a top level deployment

isComponent - whether this is a component

Returns:

the deployers

insert

protected List<org.jboss.deployers.spi.deployer.Deployer> insert(List<org.jboss.deployers.spi.deployer.Deployer> original,
                                                                 org.jboss.deployers.spi.deployer.Deployer newDeployer)

Insert the new Deployer.

Parameters:

original - the original deployers

newDeployer - the new deployer

Returns:

the sorted deployers