| org.jboss.system.ServiceMBeanSupport
 org.jboss.deployment.SubDeployerSupport
All known Subclasses: org.jboss.deployment.SARDeployer, org.jboss.deployment.XSLSubDeployer, org.jboss.deployment.SimpleSubDeployerSupport, org.jboss.deployment.JARDeployer,
| Inner Class :protected static class ClassConfiguration extends org.jboss.util.property.PropertyContainer | |
| Method Summary | |
| public boolean | accepts(DeploymentInfo sdi)
A default implementation that uses the suffixes registered
through either setSuffixes() or setEnhancedSuffixes(), to
decide if a module is deployable by this deployer. | | protected void | addDeployableFiles(DeploymentInfo di, File dir)
This method recursively searches the directory structure for any files
that are deployable (@see isDeployable). | | protected void | addDeployableJar(DeploymentInfo di, JarFile jarFile)
This method searches the entire jar file for any deployable files
(@see isDeployable). | | public void | create(DeploymentInfo di)
Sub-classes should override this method to provide
custom 'create' logic. | | protected void | createService()
The createService method is one of the ServiceMBean lifecyle operations. | | protected void | deployUrl(DeploymentInfo di, URL url, String name)
| | public void | destroy(DeploymentInfo di)
Sub-classes should override this method to provide
custom 'destroy' logic. | | protected void | destroyService()
Clean up. | | protected void | emitNotification(String type, DeploymentInfo di)
| | public String[] | getEnhancedSuffixes()
| | public int | getRelativeOrder()
| | public String[] | getSuffixes()
| | public void | init(DeploymentInfo di)
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. | | protected boolean | isDeployable(String name, URL url)
This method returns true if the name is a recognized archive file.
It will query the MainDeployer that keeps a dynamically updated
list of known archive extensions. | | protected void | processNestedDeployments(DeploymentInfo di)
The processNestedDeployments method searches for any nested and
deployable elements. | | public void | setEnhancedSuffixes(String[] enhancedSuffixes)
Set the enhanced suffixes list for this deployer,
causing also the supported suffixes list to be updated.
Each enhanced suffix entries has the form:
[order:]suffix
No need to register twice suffixes that may refer to
unpacked deployments (e.g. | | protected void | setRelativeOrder(int relativeOrder)
Set the relative order of the specified suffixes
all to the same value. | | protected void | setSuffixes(String[] suffixes)
Set an array of suffixes of interest to this subdeployer.
No need to register twice suffixes that may refer to
unpacked deployments (e.g. | | public void | start(DeploymentInfo di)
Sub-classes should override this method to provide
custom 'start' logic. | | protected void | startService()
Performs SubDeployer registration. | | public void | stop(DeploymentInfo di)
Sub-classes should override this method to provide
custom 'stop' logic. | | protected void | stopService()
Performs SubDeployer deregistration. |
| CONFIGURATION | | final protected static ClassConfiguration CONFIGURATION(Code) | | The singleton class configuration object for this class.
|
| enhancedSuffixes | | protected String[] enhancedSuffixes(Code) | | The list of enhancedSuffixes for this subdeployer
|
| nativeSuffix | | final protected static String nativeSuffix(Code) | | Holds the native library suffix for this system.
Determined by examining the result of System.mapLibraryName(specialToken).
The special token defaults to "XxX", but can be changed by setting the
system property: org.jboss.deployment.SubDeployerSupport.nativeLibToken.
|
| relativeOrder | | protected int relativeOrder(Code) | | The relative order of this subdeployer - not really used
|
| suffixes | | protected String[] suffixes(Code) | | The suffixes of interest to this subdeployer
|
| tempDeployDir | | protected File tempDeployDir(Code) | | The temporary directory into which deployments are unpacked
|
| accepts | | public boolean accepts(DeploymentInfo sdi)(Code) | | A default implementation that uses the suffixes registered
through either setSuffixes() or setEnhancedSuffixes(), to
decide if a module is deployable by this deployer.
If (according to DeploymentInfo) the deployment refers to
a directory, but not an xml or script deployment, then
the deployment suffix will be checked also against the
registered suffixes + "/".
Parameters:
sdi - the DeploymentInfo to check whether the deployer can handle the deployment |
| addDeployableFiles | | protected void addDeployableFiles(DeploymentInfo di, File dir) throws DeploymentException(Code) | | This method recursively searches the directory structure for any files
that are deployable (@see isDeployable). If a directory is found to
be deployable, then its subfiles and subdirectories are not searched.
Parameters:
di - the DeploymentInfo
Parameters:
dir - The root directory to start searching. |
| addDeployableJar | | protected void addDeployableJar(DeploymentInfo di, JarFile jarFile) throws DeploymentException(Code) | | This method searches the entire jar file for any deployable files
(@see isDeployable).
Parameters:
di - the DeploymentInfo
Parameters:
jarFile - the jar file to process. |
| create | | public void create(DeploymentInfo di) throws DeploymentException(Code) | | Sub-classes should override this method to provide
custom 'create' logic.
This method issues a JMX notification of type SubDeployer.CREATE_NOTIFICATION.
|
| createService | | protected void createService() throws Exception(Code) | | The createService method is one of the ServiceMBean lifecyle operations.
(no jmx tag needed from superinterface)
exception:
Exception - if an error occurs |
| destroy | | public void destroy(DeploymentInfo di) throws DeploymentException(Code) | | Sub-classes should override this method to provide
custom 'destroy' logic.
This method issues a JMX notification of type SubDeployer.DESTROY_NOTIFICATION.
|
| destroyService | | protected void destroyService() throws Exception(Code) | | Clean up.
|
| emitNotification | | protected void emitNotification(String type, DeploymentInfo di)(Code) | | Simple helper to emit a subdeployer notification containing DeploymentInfo
|
| getEnhancedSuffixes | | public String[] getEnhancedSuffixes()(Code) | | Get an array of enhancedSuffixes
array of enhanced suffix strings |
| getRelativeOrder | | public int getRelativeOrder()(Code) | | Get the relative order of the specified suffixes
the relative order of the specified suffixes |
| getSuffixes | | public String[] getSuffixes()(Code) | | Get an array of suffixes of interest to this subdeployer
array of suffix strings |
| init | | public void init(DeploymentInfo di) throws DeploymentException(Code) | | 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.
|
| isDeployable | | protected boolean isDeployable(String name, URL url)(Code) | | This method returns true if the name is a recognized archive file.
It will query the MainDeployer that keeps a dynamically updated
list of known archive extensions.
Parameters:
name - The "short-name" of the URL. It will have any trailing '/'characters removed, and any directory structure has been removed.
Parameters:
url - The full url. true iff the name ends in a known archive extension: .jar, .sar,.ear, .rar, .zip, .wsr, .war, or if the name matches the nativelibrary conventions. |
| processNestedDeployments | | protected void processNestedDeployments(DeploymentInfo di) throws DeploymentException(Code) | | The processNestedDeployments method searches for any nested and
deployable elements. Only Directories and Zipped archives are processed,
and those are delegated to the addDeployableFiles and addDeployableJar
methods respectively. This method can be overridden for alternate
behaviour.
|
| setEnhancedSuffixes | | public void setEnhancedSuffixes(String[] enhancedSuffixes)(Code) | | Set the enhanced suffixes list for this deployer,
causing also the supported suffixes list to be updated.
Each enhanced suffix entries has the form:
[order:]suffix
No need to register twice suffixes that may refer to
unpacked deployments (e.g. .sar, .sar/).
Parameters:
enhancedSuffixes - |
| setRelativeOrder | | protected void setRelativeOrder(int relativeOrder)(Code) | | Set the relative order of the specified suffixes
all to the same value.
Parameters:
relativeOrder - the relative order of the specified suffixes |
| setSuffixes | | protected void setSuffixes(String[] suffixes)(Code) | | Set an array of suffixes of interest to this subdeployer.
No need to register twice suffixes that may refer to
unpacked deployments (e.g. .sar, .sar/).
Parameters:
suffixes - array of suffix strings |
| start | | public void start(DeploymentInfo di) throws DeploymentException(Code) | | Sub-classes should override this method to provide
custom 'start' logic.
This method issues a JMX notification of type SubDeployer.START_NOTIFICATION.
|
| startService | | protected void startService() throws Exception(Code) | | Performs SubDeployer registration.
|
| stop | | public void stop(DeploymentInfo di) throws DeploymentException(Code) | | Sub-classes should override this method to provide
custom 'stop' logic.
This method issues a JMX notification of type SubDeployer.START_NOTIFICATION.
|
| stopService | | protected void stopService() throws Exception(Code) | | Performs SubDeployer deregistration.
|
|
|