org.jboss.deployment
Interface SubDeployer

All Known Implementing Classes:
FoeDeployer (src) , MediaEngineDeployer (src) , SARDeployer (src) , SubDeployerSupport (src)

public interface SubDeployer

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


Field Summary
static java.lang.String CREATE_NOTIFICATION
          The notification type send when a SubDeployer completes create
static java.lang.String DESTROY_NOTIFICATION
          The notification type send when a SubDeployer completes destroy
static java.lang.String INIT_NOTIFICATION
          The notification type send when a SubDeployer completes init
static int RELATIVE_ORDER_100
          Indicative relative suffix order
static int RELATIVE_ORDER_200
           
static int RELATIVE_ORDER_300
           
static int RELATIVE_ORDER_400
           
static int RELATIVE_ORDER_500
           
static int RELATIVE_ORDER_600
           
static int RELATIVE_ORDER_700
           
static int RELATIVE_ORDER_800
           
static int RELATIVE_ORDER_900
           
static java.lang.String START_NOTIFICATION
          The notification type send when a SubDeployer completes start
static java.lang.String STOP_NOTIFICATION
          The notification type send when a SubDeployer completes stop
 
Method Summary
 boolean accepts(DeploymentInfo (src)  sdi)
          The accepts method is called by MainDeployer to determine which deployer is suitable for a DeploymentInfo.
 void create(DeploymentInfo (src)  sdi)
          Set up the components of the deployment that do not refer to other components
 void destroy(DeploymentInfo (src)  sdi)
          The destroy method removes individual components
 int getRelativeOrder()
          Get the relative order of the specified suffixes
 ObjectName (src) getServiceName()
          Get the JMX ObjectName of the service that provides the SubDeployer
 java.lang.String[] getSuffixes()
          Get an array of suffixes of interest to this subdeployer
 void init(DeploymentInfo (src)  sdi)
          The init method lets the deployer set a few properties of the DeploymentInfo, such as the watch url.
 void setRelativeOrder(int relativeOrder)
          Set the relative order of the specified suffixes
 void setSuffixes(java.lang.String[] suffixes)
          Set an array of suffixes of interest to this subdeployer
 void start(DeploymentInfo (src)  sdi)
          The start method sets up relationships with other components.
 void stop(DeploymentInfo (src)  sdi)
          The stop method removes relationships between components.
 

Field Detail

INIT_NOTIFICATION

public static final java.lang.String INIT_NOTIFICATION
The notification type send when a SubDeployer completes init

See Also:
Constant Field Values (src)

CREATE_NOTIFICATION

public static final java.lang.String CREATE_NOTIFICATION
The notification type send when a SubDeployer completes create

See Also:
Constant Field Values (src)

START_NOTIFICATION

public static final java.lang.String START_NOTIFICATION
The notification type send when a SubDeployer completes start

See Also:
Constant Field Values (src)

STOP_NOTIFICATION

public static final java.lang.String STOP_NOTIFICATION
The notification type send when a SubDeployer completes stop

See Also:
Constant Field Values (src)

DESTROY_NOTIFICATION

public static final java.lang.String DESTROY_NOTIFICATION
The notification type send when a SubDeployer completes destroy

See Also:
Constant Field Values (src)

RELATIVE_ORDER_100

public static final int RELATIVE_ORDER_100
Indicative relative suffix order

See Also:
Constant Field Values (src)

RELATIVE_ORDER_200

public static final int RELATIVE_ORDER_200
See Also:
Constant Field Values (src)

RELATIVE_ORDER_300

public static final int RELATIVE_ORDER_300
See Also:
Constant Field Values (src)

RELATIVE_ORDER_400

public static final int RELATIVE_ORDER_400
See Also:
Constant Field Values (src)

RELATIVE_ORDER_500

public static final int RELATIVE_ORDER_500
See Also:
Constant Field Values (src)

RELATIVE_ORDER_600

public static final int RELATIVE_ORDER_600
See Also:
Constant Field Values (src)

RELATIVE_ORDER_700

public static final int RELATIVE_ORDER_700
See Also:
Constant Field Values (src)

RELATIVE_ORDER_800

public static final int RELATIVE_ORDER_800
See Also:
Constant Field Values (src)

RELATIVE_ORDER_900

public static final int RELATIVE_ORDER_900
See Also:
Constant Field Values (src)
Method Detail

getServiceName

public ObjectName (src)  getServiceName()
Get the JMX ObjectName of the service that provides the SubDeployer

Returns:
JMX ObjectName of the service

getSuffixes

public java.lang.String[] getSuffixes()
Get an array of suffixes of interest to this subdeployer

Returns:
array of suffix strings

setSuffixes

public void setSuffixes(java.lang.String[] suffixes)
Set an array of suffixes of interest to this subdeployer

Parameters:
suffixes - array of suffix strings

getRelativeOrder

public int getRelativeOrder()
Get the relative order of the specified suffixes

Returns:
the relative order of the specified suffixes

setRelativeOrder

public void setRelativeOrder(int relativeOrder)
Set the relative order of the specified suffixes

Parameters:
relativeOrder - the relative order of the specified suffixes

accepts

public boolean accepts(DeploymentInfo (src)  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 (src)  sdi)
          throws DeploymentException (src) 
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 (src) - if an error occurs

create

public void create(DeploymentInfo (src)  sdi)
            throws DeploymentException (src) 
Set up the components of the deployment that do not refer to other components

Parameters:
sdi - a DeploymentInfo value
Throws:
DeploymentException (src) - Failed to deploy

start

public void start(DeploymentInfo (src)  sdi)
           throws DeploymentException (src) 
The start method sets up relationships with other components.

Parameters:
sdi - a DeploymentInfo value
Throws:
DeploymentException (src) - if an error occurs

stop

public void stop(DeploymentInfo (src)  sdi)
          throws DeploymentException (src) 
The stop method removes relationships between components.

Parameters:
sdi - a DeploymentInfo value
Throws:
DeploymentException (src) - if an error occurs

destroy

public void destroy(DeploymentInfo (src)  sdi)
             throws DeploymentException (src) 
The destroy method removes individual components

Parameters:
sdi - a DeploymentInfo value
Throws:
DeploymentException (src) - if an error occurs