Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jboss.deployment
Class SimpleSubDeployerSupport

    java.lang.Object
      org.jboss.mx.util.JBossNotificationBroadcasterSupport
          org.jboss.system.ServiceMBeanSupport
              org.jboss.deployment.SubDeployerSupport
                  org.jboss.deployment.SimpleSubDeployerSupport

All Implemented Interfaces:
  javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, Service, ServiceMBean, SubDeployer, SubDeployerMBean

public abstract class SimpleSubDeployerSupport
extends SubDeployerSupport

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

Version:
  $Revision: 1.6 $
Author:
  Adrian Brock

Nested Class Summary

Nested classes inherited from class org.jboss.deployment.SubDeployerSupport
`SubDeployerSupport.ClassConfiguration`

Field Summary

Fields inherited from class org.jboss.deployment.SubDeployerSupport
`CONFIGURATION, mainDeployer, nativePrefix, nativeSuffix, relativeOrder, suffixes, tempDeployDir`

Fields inherited from class org.jboss.system.ServiceMBeanSupport
`log, server, SERVICE_CONTROLLER_SIG, serviceName`

Fields inherited from interface org.jboss.deployment.SubDeployer
`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
`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 di)` The `accepts` method is called by MainDeployer to determine which deployer is suitable for a DeploymentInfo.
`void` | `create(DeploymentInfo di)` Sub-classes should override this method to provide custom 'create' logic.
`protected void` | `createService(DeploymentInfo di)` Do the create lifecyle for the deployment
`void` | `destroy(DeploymentInfo di)` Sub-classes should override this method to provide custom 'destroy' logic.
`protected void` | `destroyService(DeploymentInfo di)` Do the destroy lifecyle for the deployment
`protected void` | `determineObjectName(DeploymentInfo di)` Determine the object name
`abstract String` | `getDeploymentClass()` Get the deployment class
`abstract String` | `getExtension()` Get the package extension for this deployment
`protected URL` | `getMetaDataResource(DeploymentInfo di)` Get the url of the meta data resource
`abstract String` | `getMetaDataURL()` Get the metadata url
`abstract org.jboss.xml.binding.ObjectModelFactory` | `getObjectModelFactory()` Get the object model factory
`abstract String` | `getObjectName(DeploymentInfo di)` Get the object name for this deployment
`void` | `init(DeploymentInfo di)` Sub-classes should override this method to provide custom 'init' logic.
`protected void` | `parseMetaData(DeploymentInfo di, URL url)` Parse the meta data
`void` | `postRegister(Boolean done)`
`protected javax.management.ObjectName` | `registerClassLoader(DeploymentInfo di)` Register the UCL classloader
`protected void` | `registerDeployment(DeploymentInfo di, javax.management.ObjectName uclName)` Register the deployment
`protected void` | `resolveWatch(DeploymentInfo di, URL url)` Resolve the watch url
`void` | `start(DeploymentInfo di)` Sub-classes should override this method to provide custom 'start' logic.
`protected void` | `startService(DeploymentInfo di)` Do the start lifecyle for the deployment
`void` | `stop(DeploymentInfo di)` Sub-classes should override this method to provide custom 'stop' logic.
`protected void` | `stopService(DeploymentInfo di)` Do the stop lifecyle for the deployment
`protected void` | `unregisterClassLoader(DeploymentInfo di)` Unregister the UCL classloader
`protected void` | `unregisterDeployment(DeploymentInfo di)` Unregister the deployment

Methods inherited from class org.jboss.deployment.SubDeployerSupport
`addDeployableFiles, addDeployableJar, createService, deployUrl, destroyService, getRelativeOrder, getSuffixes, isDeployable, processNestedDeployments, setRelativeOrder, setSuffixes, startService, stopService`

Methods inherited from class org.jboss.system.ServiceMBeanSupport
`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
`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
`getServiceName`

Methods inherited from interface org.jboss.system.ServiceMBean
`getName, getState, getStateString, jbossInternalLifecycle`

Methods inherited from interface org.jboss.system.Service
`create, destroy, start, stop`

Constructor Detail

### SimpleSubDeployerSupport

    public SimpleSubDeployerSupport()

Method Detail

### getExtension

    public abstract String getExtension()

  Get the package extension for this deployment

  Returns:
    the package extension

### getMetaDataURL

    public abstract String getMetaDataURL()

  Get the metadata url

  Returns:
    the meta data url

### getObjectName

    public abstract String getObjectName(DeploymentInfo di)
                                  throws DeploymentException

  Get the object name for this deployment

  Parameters:
    `di` - the deployment info
  Returns:
    the object name
  Throws:
    `DeploymentException`

### getDeploymentClass

    public abstract String getDeploymentClass()

  Get the deployment class

  Returns:
    the deployment class

### getObjectModelFactory

    public abstract org.jboss.xml.binding.ObjectModelFactory getObjectModelFactory()

  Get the object model factory

  Returns:
    the object model factory

### accepts

    public boolean accepts(DeploymentInfo di)

  Description copied from interface: `SubDeployer`
  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 di)
              throws DeploymentException

  Description copied from class: `SubDeployerSupport`
  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`
  Overrides:
    `init` in class `SubDeployerSupport`
  Throws:
    `DeploymentException`

### create

    public void create(DeploymentInfo di)
                throws DeploymentException

  Description copied from class: `SubDeployerSupport`
  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`
  Overrides:
    `create` in class `SubDeployerSupport`
  Throws:
    `DeploymentException`

### start

    public void start(DeploymentInfo di)
               throws DeploymentException

  Description copied from class: `SubDeployerSupport`
  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`
  Overrides:
    `start` in class `SubDeployerSupport`
  Throws:
    `DeploymentException`

### stop

    public void stop(DeploymentInfo di)
              throws DeploymentException

  Description copied from class: `SubDeployerSupport`
  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`
  Overrides:
    `stop` in class `SubDeployerSupport`
  Throws:
    `DeploymentException`

### destroy

    public void destroy(DeploymentInfo di)
                 throws DeploymentException

  Description copied from class: `SubDeployerSupport`
  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`
  Overrides:
    `destroy` in class `SubDeployerSupport`
  Throws:
    `DeploymentException`

### postRegister

    public void postRegister(Boolean done)

  Specified by:
    `postRegister` in interface `javax.management.MBeanRegistration`
  Overrides:
    `postRegister` in class `ServiceMBeanSupport`

### getMetaDataResource

    protected URL getMetaDataResource(DeploymentInfo di)
                               throws DeploymentException

  Get the url of the meta data resource

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

### parseMetaData

    protected void parseMetaData(DeploymentInfo di,
                                 URL url)
                          throws DeploymentException

  Parse the meta data

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

### resolveWatch

    protected void resolveWatch(DeploymentInfo di,
                                URL url)
                         throws DeploymentException

  Resolve the watch url

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

### determineObjectName

    protected void determineObjectName(DeploymentInfo di)
                                throws DeploymentException

  Determine the object name

  Parameters:
    `di` - the deployment info
  Throws:
    `DeploymentException` - for any error

### registerClassLoader

    protected javax.management.ObjectName registerClassLoader(DeploymentInfo di)
                                                       throws DeploymentException

  Register the UCL classloader

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

### unregisterClassLoader

    protected void unregisterClassLoader(DeploymentInfo di)

  Unregister the UCL classloader

  Parameters:
    `di` - the deployment info

### registerDeployment

    protected void registerDeployment(DeploymentInfo di,
                                      javax.management.ObjectName uclName)
                               throws DeploymentException

  Register the deployment

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

### unregisterDeployment

    protected void unregisterDeployment(DeploymentInfo di)

  Unregister the deployment

  Parameters:
    `di` - the deployment info

### createService

    protected void createService(DeploymentInfo di)
                          throws DeploymentException

  Do the create lifecyle for the deployment

  Parameters:
    `di` - the deployment info
  Throws:
    `DeploymentException` - for any error

### startService

    protected void startService(DeploymentInfo di)
                         throws DeploymentException

  Do the start lifecyle for the deployment

  Parameters:
    `di` - the deployment info
  Throws:
    `DeploymentException` - for any error

### stopService

    protected void stopService(DeploymentInfo di)

  Do the stop lifecyle for the deployment

  Parameters:
    `di` - the deployment info

### destroyService

    protected void destroyService(DeploymentInfo di)
                           throws DeploymentException

  Do the destroy lifecyle for the deployment

  Parameters:
    `di` - the deployment info
  Throws:
    `DeploymentException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002 JBoss Group, LLC. All Rights Reserved.