org.jboss.deployment
Interface SubDeployer

All Known Subinterfaces:

SubDeployerExt

All Known Implementing Classes:

JARDeployer, ObjectModelFactorySimpleSubDeployerSupport, SARDeployer, SchemaBindingSimpleSubDeployerSupport, SimpleSubDeployerSupport, SubDeployerSupport, XSLSubDeployer

public interface SubDeployer

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

Version:

$Revision: 1.7.6.5 $

Author:

Jason Dillon, Toby Allsopp, Marc Fleury, Dimitris Andreadis

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 int	RELATIVE_ORDER_100 Deprecated.
static int	RELATIVE_ORDER_200 Deprecated.
static int	RELATIVE_ORDER_300 Deprecated.
static int	RELATIVE_ORDER_400 Deprecated.
static int	RELATIVE_ORDER_500 Deprecated.
static int	RELATIVE_ORDER_600 Deprecated.
static int	RELATIVE_ORDER_700 Deprecated.
static int	RELATIVE_ORDER_800 Deprecated.
static int	RELATIVE_ORDER_900 Deprecated.
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
int	getRelativeOrder() Get the relative order of the specified suffixes
javax.management.ObjectName	getServiceName() Get the JMX ObjectName of the service that provides the SubDeployer
String[]	getSuffixes() Get an array of suffixes of interest to this 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

static final String INIT_NOTIFICATION

The notification type send when a SubDeployer completes init

See Also:

Constant Field Values

CREATE_NOTIFICATION

static final String CREATE_NOTIFICATION

The notification type send when a SubDeployer completes create

See Also:

Constant Field Values

START_NOTIFICATION

static final String START_NOTIFICATION

The notification type send when a SubDeployer completes start

See Also:

Constant Field Values

STOP_NOTIFICATION

static final String STOP_NOTIFICATION

The notification type send when a SubDeployer completes stop

See Also:

Constant Field Values

DESTROY_NOTIFICATION

static final String DESTROY_NOTIFICATION

The notification type send when a SubDeployer completes destroy

See Also:

Constant Field Values

RELATIVE_ORDER_100

static final int RELATIVE_ORDER_100

Deprecated.

See Also:

Constant Field Values

RELATIVE_ORDER_200

static final int RELATIVE_ORDER_200

Deprecated.

See Also:

Constant Field Values

RELATIVE_ORDER_300

static final int RELATIVE_ORDER_300

Deprecated.

See Also:

Constant Field Values

RELATIVE_ORDER_400

static final int RELATIVE_ORDER_400

Deprecated.

See Also:

Constant Field Values

RELATIVE_ORDER_500

static final int RELATIVE_ORDER_500

Deprecated.

See Also:

Constant Field Values

RELATIVE_ORDER_600

static final int RELATIVE_ORDER_600

Deprecated.

See Also:

Constant Field Values

RELATIVE_ORDER_700

static final int RELATIVE_ORDER_700

Deprecated.

See Also:

Constant Field Values

RELATIVE_ORDER_800

static final int RELATIVE_ORDER_800

Deprecated.

See Also:

Constant Field Values

RELATIVE_ORDER_900

static final int RELATIVE_ORDER_900

Deprecated.

See Also:

Constant Field Values

Method Detail

getServiceName

javax.management.ObjectName getServiceName()

Get the JMX ObjectName of the service that provides the SubDeployer

Returns:

JMX ObjectName of the service

getSuffixes

String[] getSuffixes()

Get an array of suffixes of interest to this subdeployer

Returns:

array of suffix strings

getRelativeOrder

int getRelativeOrder()

Get the relative order of the specified suffixes

Returns:

the relative order of the specified suffixes

accepts

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

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

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 - if an error occurs

start

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

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

void destroy(DeploymentInfo sdi)
             throws DeploymentException

The destroy method removes individual components

Parameters:

sdi - a DeploymentInfo value

Throws:

DeploymentException - if an error occurs