org.jboss.deployment
Class SimpleSubDeployerSupport

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport (src) 
      extended byorg.jboss.system.ServiceMBeanSupport (src) 
          extended byorg.jboss.deployment.SubDeployerSupport (src) 
              extended byorg.jboss.deployment.SimpleSubDeployerSupport
All Implemented Interfaces:
MBeanRegistration (src) , NotificationBroadcaster (src) , NotificationEmitter (src) , Service (src) , ServiceMBean (src) , SubDeployer (src)
Direct Known Subclasses:
RARDeployer (src)

public abstract class SimpleSubDeployerSupport
extends SubDeployerSupport (src)

A simple subdeployer that deploys a managed object after parsing the deployment's xml file.


Nested Class Summary
 
Nested classes inherited from class org.jboss.deployment.SubDeployerSupport (src)
SubDeployerSupport.ClassConfiguration (src)
 
Field Summary
 
Fields inherited from class org.jboss.deployment.SubDeployerSupport (src)
CONFIGURATION, mainDeployer, nativePrefix, nativeSuffix, relativeOrder, suffixes, tempDeployDir
 
Fields inherited from class org.jboss.system.ServiceMBeanSupport (src)
log, server, SERVICE_CONTROLLER_SIG, serviceName
 
Fields inherited from interface org.jboss.deployment.SubDeployer (src)
CREATE_NOTIFICATION, DESTROY_NOTIFICATION, INIT_NOTIFICATION, RELATIVE_ORDER_100, RELATIVE_ORDER_200, RELATIVE_ORDER_300, RELATIVE_ORDER_400, RELATIVE_ORDER_500, RELATIVE_ORDER_600, RELATIVE_ORDER_700, RELATIVE_ORDER_800, RELATIVE_ORDER_900, START_NOTIFICATION, STOP_NOTIFICATION
 
Fields inherited from interface org.jboss.system.ServiceMBean (src)
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Constructor Summary
SimpleSubDeployerSupport()
           
 
Method Summary
 boolean accepts(DeploymentInfo (src)  di)
          The accepts method is called by MainDeployer to determine which deployer is suitable for a DeploymentInfo.
 void create(DeploymentInfo (src)  di)
          Sub-classes should override this method to provide custom 'create' logic.
protected  void createService(DeploymentInfo (src)  di)
          Do the create lifecyle for the deployment
 void destroy(DeploymentInfo (src)  di)
          Sub-classes should override this method to provide custom 'destroy' logic.
protected  void destroyService(DeploymentInfo (src)  di)
          Do the destroy lifecyle for the deployment
protected  void determineObjectName(DeploymentInfo (src)  di)
          Determine the object name
abstract  java.lang.String getDeploymentClass()
          Get the deployment class
abstract  java.lang.String getExtension()
          Get the package extension for this deployment
protected  java.net.URL getMetaDataResource(DeploymentInfo (src)  di)
          Get the url of the meta data resource
abstract  java.lang.String getMetaDataURL()
          Get the metadata url
abstract  ObjectModelFactory (src) getObjectModelFactory()
          Get the object model factory
abstract  java.lang.String getObjectName(DeploymentInfo (src)  di)
          Get the object name for this deployment
 void init(DeploymentInfo (src)  di)
          Sub-classes should override this method to provide custom 'init' logic.
protected  void parseMetaData(DeploymentInfo (src)  di, java.net.URL url)
          Parse the meta data
 void postRegister(java.lang.Boolean done)
          This method is called by the MBeanServer after registration takes place or when registration fails.
protected  ObjectName (src) registerClassLoader(DeploymentInfo (src)  di)
          Register the UCL classloader
protected  void registerDeployment(DeploymentInfo (src)  di, ObjectName (src)  uclName)
          Register the deployment
protected  void resolveWatch(DeploymentInfo (src)  di, java.net.URL url)
          Resolve the watch url
 void start(DeploymentInfo (src)  di)
          Sub-classes should override this method to provide custom 'start' logic.
protected  void startService(DeploymentInfo (src)  di)
          Do the start lifecyle for the deployment
 void stop(DeploymentInfo (src)  di)
          Sub-classes should override this method to provide custom 'stop' logic.
protected  void stopService(DeploymentInfo (src)  di)
          Do the stop lifecyle for the deployment
protected  void unregisterClassLoader(DeploymentInfo (src)  di)
          Unregister the UCL classloader
protected  void unregisterDeployment(DeploymentInfo (src)  di)
          Unregister the deployment
 
Methods inherited from class org.jboss.deployment.SubDeployerSupport (src)
addDeployableFiles, addDeployableJar, createService, deployUrl, destroyService, emitNotification, getRelativeOrder, getSuffixes, isDeployable, processNestedDeployments, setRelativeOrder, setSuffixes, startService, stopService
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport (src)
create, destroy, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, getState, getStateString, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, preDeregister, preRegister, start, stop
 
Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport (src)
addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jboss.deployment.SubDeployer (src)
getServiceName
 

Constructor Detail

SimpleSubDeployerSupport

public SimpleSubDeployerSupport()
Method Detail

getExtension

public abstract java.lang.String getExtension()
Get the package extension for this deployment

Returns:
the package extension

getMetaDataURL

public abstract java.lang.String getMetaDataURL()
Get the metadata url

Returns:
the meta data url

getObjectName

public abstract java.lang.String getObjectName(DeploymentInfo (src)  di)
                                        throws DeploymentException (src) 
Get the object name for this deployment

Parameters:
di - the deployment info
Returns:
the object name
Throws:
DeploymentException (src)

getDeploymentClass

public abstract java.lang.String getDeploymentClass()
Get the deployment class

Returns:
the deployment class

getObjectModelFactory

public abstract ObjectModelFactory (src)  getObjectModelFactory()
Get the object model factory

Returns:
the object model factory

accepts

public boolean accepts(DeploymentInfo (src)  di)
Description copied from interface: SubDeployer (src)
The accepts method is called by MainDeployer to determine which deployer is suitable for a DeploymentInfo.

Parameters:
di - a DeploymentInfo value
Returns:
a boolean value

init

public void init(DeploymentInfo (src)  di)
          throws DeploymentException (src) 
Description copied from class: SubDeployerSupport (src)
Sub-classes should override this method to provide custom 'init' logic.

This method calls the processNestedDeployments(di) method and then issues a JMX notification of type SubDeployer.INIT_NOTIFICATION. This behaviour can overridden by concrete sub-classes. If further initialization needs to be done, and you wish to preserve the functionality, be sure to call super.init(di) at the end of your implementation.

Specified by:
init in interface SubDeployer (src)
Overrides:
init in class SubDeployerSupport (src)
Throws:
DeploymentException (src)

create

public void create(DeploymentInfo (src)  di)
            throws DeploymentException (src) 
Description copied from class: SubDeployerSupport (src)
Sub-classes should override this method to provide custom 'create' logic. This method issues a JMX notification of type SubDeployer.CREATE_NOTIFICATION.

Specified by:
create in interface SubDeployer (src)
Overrides:
create in class SubDeployerSupport (src)
Throws:
DeploymentException (src)

start

public void start(DeploymentInfo (src)  di)
           throws DeploymentException (src) 
Description copied from class: SubDeployerSupport (src)
Sub-classes should override this method to provide custom 'start' logic. This method issues a JMX notification of type SubDeployer.START_NOTIFICATION.

Specified by:
start in interface SubDeployer (src)
Overrides:
start in class SubDeployerSupport (src)
Throws:
DeploymentException (src)

stop

public void stop(DeploymentInfo (src)  di)
          throws DeploymentException (src) 
Description copied from class: SubDeployerSupport (src)
Sub-classes should override this method to provide custom 'stop' logic. This method issues a JMX notification of type SubDeployer.START_NOTIFICATION.

Specified by:
stop in interface SubDeployer (src)
Overrides:
stop in class SubDeployerSupport (src)
Throws:
DeploymentException (src)

destroy

public void destroy(DeploymentInfo (src)  di)
             throws DeploymentException (src) 
Description copied from class: SubDeployerSupport (src)
Sub-classes should override this method to provide custom 'destroy' logic. This method issues a JMX notification of type SubDeployer.DESTROY_NOTIFICATION.

Specified by:
destroy in interface SubDeployer (src)
Overrides:
destroy in class SubDeployerSupport (src)
Throws:
DeploymentException (src)

postRegister

public void postRegister(java.lang.Boolean done)
Description copied from interface: MBeanRegistration (src)
This method is called by the MBeanServer after registration takes place or when registration fails.

Specified by:
postRegister in interface MBeanRegistration (src)
Overrides:
postRegister in class ServiceMBeanSupport (src)

getMetaDataResource

protected java.net.URL getMetaDataResource(DeploymentInfo (src)  di)
                                    throws DeploymentException (src) 
Get the url of the meta data resource

Parameters:
di - the deployment info
Returns:
the url of the meta data resource
Throws:
DeploymentException (src) - for any error

parseMetaData

protected void parseMetaData(DeploymentInfo (src)  di,
                             java.net.URL url)
                      throws DeploymentException (src) 
Parse the meta data

Parameters:
di - the deployment info
url - the location of the meta data
Throws:
DeploymentException (src) - for any error

resolveWatch

protected void resolveWatch(DeploymentInfo (src)  di,
                            java.net.URL url)
                     throws DeploymentException (src) 
Resolve the watch url

Parameters:
di - the deployment info
url - the location of the meta data
Throws:
DeploymentException (src) - for any error

determineObjectName

protected void determineObjectName(DeploymentInfo (src)  di)
                            throws DeploymentException (src) 
Determine the object name

Parameters:
di - the deployment info
Throws:
DeploymentException (src) - for any error

registerClassLoader

protected ObjectName (src)  registerClassLoader(DeploymentInfo (src)  di)
                                  throws DeploymentException (src) 
Register the UCL classloader

Parameters:
di - the deployment info
Returns:
the object name of the classloader
Throws:
DeploymentException (src) - for any error

unregisterClassLoader

protected void unregisterClassLoader(DeploymentInfo (src)  di)
Unregister the UCL classloader

Parameters:
di - the deployment info

registerDeployment

protected void registerDeployment(DeploymentInfo (src)  di,
                                  ObjectName (src)  uclName)
                           throws DeploymentException (src) 
Register the deployment

Parameters:
di - the deployment info
uclName - the object name of the classloader
Throws:
DeploymentException (src) - for any error

unregisterDeployment

protected void unregisterDeployment(DeploymentInfo (src)  di)
Unregister the deployment

Parameters:
di - the deployment info

createService

protected void createService(DeploymentInfo (src)  di)
                      throws DeploymentException (src) 
Do the create lifecyle for the deployment

Parameters:
di - the deployment info
Throws:
DeploymentException (src) - for any error

startService

protected void startService(DeploymentInfo (src)  di)
                     throws DeploymentException (src) 
Do the start lifecyle for the deployment

Parameters:
di - the deployment info
Throws:
DeploymentException (src) - for any error

stopService

protected void stopService(DeploymentInfo (src)  di)
Do the stop lifecyle for the deployment

Parameters:
di - the deployment info

destroyService

protected void destroyService(DeploymentInfo (src)  di)
                       throws DeploymentException (src) 
Do the destroy lifecyle for the deployment

Parameters:
di - the deployment info
Throws:
DeploymentException (src)