org.jboss.deployment
Interface SubDeployer

All Known Implementing Classes:

SARDeployer, SubDeployerSupport

public interface SubDeployer

The common interface for sub-deployer components which perform the actual deployment services for application components.

Version:

$Revision: 1.2.4.2 $

Author:

Jason Dillon, Toby Allsopp, Marc Fleury

Field Summary

static String	CREATE_NOTIFICATION The notification type send when a SubDeployer completes create
static String	DESTROY_NOTIFICATION The notification type send when a SubDeployer completes destroy
static String	INIT_NOTIFICATION The notification type send when a SubDeployer completes init
static String	START_NOTIFICATION The notification type send when a SubDeployer completes start
static String	STOP_NOTIFICATION The notification type send when a SubDeployer completes stop

Method Summary

boolean	accepts(DeploymentInfo sdi) The accepts method is called by MainDeployer to determine which deployer is suitable for a DeploymentInfo.
void	create(DeploymentInfo sdi) Set up the components of the deployment that do not refer to other components
void	destroy(DeploymentInfo sdi) The destroy method removes individual components
javax.management.ObjectName	getServiceName() Get the JMX ObjectName of the service that provides the SubDeployer
void	init(DeploymentInfo sdi) The init method lets the deployer set a few properties of the DeploymentInfo, such as the watch url.
void	start(DeploymentInfo sdi) The start method sets up relationships with other components.
void	stop(DeploymentInfo sdi) The stop method removes relationships between components.

Field Detail

INIT_NOTIFICATION

public static final String INIT_NOTIFICATION

The notification type send when a SubDeployer completes init

See Also:

Constant Field Values

CREATE_NOTIFICATION

public static final String CREATE_NOTIFICATION

The notification type send when a SubDeployer completes create

See Also:

Constant Field Values

START_NOTIFICATION

public static final String START_NOTIFICATION

The notification type send when a SubDeployer completes start

See Also:

Constant Field Values

STOP_NOTIFICATION

public static final String STOP_NOTIFICATION

The notification type send when a SubDeployer completes stop

See Also:

Constant Field Values

DESTROY_NOTIFICATION

public static final String DESTROY_NOTIFICATION

The notification type send when a SubDeployer completes destroy

See Also:

Constant Field Values

Method Detail

getServiceName

public javax.management.ObjectName getServiceName()

Get the JMX ObjectName of the service that provides the SubDeployer

Returns:

JMX ObjectName of the service

accepts

public boolean accepts(DeploymentInfo sdi)

The accepts method is called by MainDeployer to determine which deployer is suitable for a DeploymentInfo.

Parameters:

sdi - a DeploymentInfo value

Returns:

a boolean value

init

public void init(DeploymentInfo sdi)
          throws DeploymentException

The init method lets the deployer set a few properties of the DeploymentInfo, such as the watch url.

Parameters:

sdi - a DeploymentInfo value

Throws:

DeploymentException - if an error occurs

create

public void create(DeploymentInfo sdi)
            throws DeploymentException

Set up the components of the deployment that do not refer to other components

Parameters:

sdi - a DeploymentInfo value

Throws:

DeploymentException - Failed to deploy

start

public void start(DeploymentInfo sdi)
           throws DeploymentException

The start method sets up relationships with other components.

Parameters:

sdi - a DeploymentInfo value

Throws:

DeploymentException - if an error occurs

stop

public void stop(DeploymentInfo sdi)
          throws DeploymentException

The stop method removes relationships between components.

Parameters:

sdi - a DeploymentInfo value

Throws:

DeploymentException - if an error occurs

destroy

public void destroy(DeploymentInfo sdi)
             throws DeploymentException

The destroy method removes individual components

Parameters:

sdi - a DeploymentInfo value

Throws:

DeploymentException - if an error occurs