jrun.deployment
Interface DeployerServiceMBean

All Superinterfaces:

ClusterableServiceAdapterMBean, ConfigurableServicePartitionMBean, java.io.Serializable, Service, ServiceMBean, ServicePartitionMBean

All Known Implementing Classes:

DeployerService

public interface DeployerServiceMBean

extends ClusterableServiceAdapterMBean

Management view of the object that deploys J2EE component's at runtime.

Author:

Nick Tsivranidis, Paul Reilly, Brian Deitte

Field Summary

static java.lang.String

OBJECT_NAME Easy reference to the JMX ObjectName.

Fields inherited from interface jrunx.kernel.Service

INITIALIZED, STARTED, STARTING, STOPPED, STOPPING, UNINITIALIZED

Method Summary

void	addDeployDirectory(java.lang.String path) Add this directory to the watched directory list This watched directory is persisted to the configuration file
void	deploy(java.net.URL url) Deploy this URL immediately.
void	deployPersistentURL(java.net.URL url) Deploy and add the URL, url, to jrun.xml.
java.lang.String[]	getDeployDirectoryList() Get the list of watched Directories
java.util.ArrayList	getDeployedComponentObjectNames(java.net.URL url) Get a list of deployed component JMX object names at this URL.
java.lang.String[]	getDeployedURLs() Get the list of deployed URLs.
java.lang.String[]	getEARs() Get deployed EAR JMX object names
java.lang.String[]	getEJBs() Get deployed EJB jars object names (not including ones inside deployed ears)
boolean	getHotDeploy()
long	getPollFrequency()
java.lang.String[]	getRARs() Get deployed EJB jars object names (not including ones inside deployed ears)
java.lang.String	getTemporaryDirectory() Accessors for the temporary directory.
java.lang.String[]	getWARs() Get deployed EJB jars object names (not including ones inside deployed ears)
boolean	inWatchedDirectory(java.net.URL url) Determine if a URL is in a watched directory or not.
boolean	isDeployed(java.net.URL url) Determine whether a specific application is deployed
boolean	isPersistXML()
boolean	isStartupDeployComplete() During server startup, client tools need to know when all deployments are completed.
boolean	isValidateXML()
void	redeploy(java.net.URL url) Redeploy this url immediately.
void	removeDeployDirectory(java.lang.String path) Remove this directory from the watched directory list
void	setDeployDirectory(java.lang.String path) Add this directory to the watched directory list
void	setFile(java.lang.String fileString) This method conforms to the MBean standard in order to make use of attributes set in jrun.xml.
void	setHotDeploy(boolean hotDeploy) Turn hotDeploy on or off.
void	setPersistXML(boolean persistXML)
void	setPollFrequency(long seconds) Set the polling frequency of the DeployerService
void	setTemporaryDirectory(java.lang.String temporaryDirectory)
void	setUrl(java.lang.String urlString) This method conforms to the MBean standard in order to make use of attributes set in jrun.xml.
void	setValidateXML(boolean validateXML)
void	undeploy(java.net.URL url) Undeploy this url immediately.
void	undeployPersistentURL(java.net.URL url) Undeploy and remove the URL, url, from jrun.xml.

Methods inherited from interface jrunx.cluster.ClusterableServiceAdapterMBean

addPeerListener, getClientSocketFactory, getClusterAlgorithm, getPort, getServerSocketFactoryClass, setClientSocketFactoryClass, setClusterAlgorithm, setPort, setServerSocketFactoryClass

Methods inherited from interface jrunx.kernel.ConfigurableServicePartitionMBean

setChildElements

Methods inherited from interface jrunx.kernel.ServicePartitionMBean

addService, addService, iterator, removeService, removeService

Methods inherited from interface jrunx.kernel.ServiceMBean

bind, getBindToJNDI, getDeactivated, getDomainName, getJRunService, getLogger, getName, getParentService, getServerName, requestServer, setBindToJNDI, setDeactivated, setDomainName, setName, setParentService, unbind

Methods inherited from interface jrunx.kernel.Service

destroy, getStatus, init, start, stop, updateStatus

Field Detail

OBJECT_NAME

public static final java.lang.String OBJECT_NAME

Easy reference to the JMX ObjectName.

Method Detail

addDeployDirectory

public void addDeployDirectory(java.lang.String path)
                        throws DeploymentException

Add this directory to the watched directory list This watched directory is persisted to the configuration file

setDeployDirectory

public void setDeployDirectory(java.lang.String path)
                        throws DeploymentException

Add this directory to the watched directory list

getDeployDirectoryList

public java.lang.String[] getDeployDirectoryList()

Get the list of watched Directories

removeDeployDirectory

public void removeDeployDirectory(java.lang.String path)
                           throws DeploymentException

Remove this directory from the watched directory list

getDeployedComponentObjectNames

public java.util.ArrayList getDeployedComponentObjectNames(java.net.URL url)
                                                    throws DeploymentException

Get a list of deployed component JMX object names at this URL.

getDeployedURLs

public java.lang.String[] getDeployedURLs()

Get the list of deployed URLs.

getEARs

public java.lang.String[] getEARs()

Get deployed EAR JMX object names

getEJBs

public java.lang.String[] getEJBs()

Get deployed EJB jars object names (not including ones inside deployed ears)

getWARs

public java.lang.String[] getWARs()

Get deployed EJB jars object names (not including ones inside deployed ears)

getRARs

public java.lang.String[] getRARs()

Get deployed EJB jars object names (not including ones inside deployed ears)

setHotDeploy

public void setHotDeploy(boolean hotDeploy)

Turn hotDeploy on or off. HotDeploy watches for changes in J2EE apps in the deploy directory. Turning it off means that you will have to restart the server after you make any changes to deployed apps. Defaults to true.

getHotDeploy

public boolean getHotDeploy()

setPollFrequency

public void setPollFrequency(long seconds)

Set the polling frequency of the DeployerService

getPollFrequency

public long getPollFrequency()

getTemporaryDirectory

public java.lang.String getTemporaryDirectory()

Accessors for the temporary directory.

setTemporaryDirectory

public void setTemporaryDirectory(java.lang.String temporaryDirectory)
                           throws java.io.IOException

deploy

public void deploy(java.net.URL url)
            throws DeploymentException,
                   java.rmi.RemoteException

Deploy this URL immediately. The URL will be added to the watched URL list if it is not already there.

deployPersistentURL

public void deployPersistentURL(java.net.URL url)
                         throws DeploymentException

Deploy and add the URL, url, to jrun.xml.

redeploy

public void redeploy(java.net.URL url)
              throws DeploymentException,
                     java.rmi.RemoteException

Redeploy this url immediately. The url will be added to the watched url list if it is not already there.

undeploy

public void undeploy(java.net.URL url)
              throws DeploymentException,
                     java.rmi.RemoteException

Undeploy this url immediately. The url will be removed from the watched URL list (note that if this URL is in watched directory and hot deploy is enabled it will be back on the watched list during the next hotdeploy cycle).

undeployPersistentURL

public void undeployPersistentURL(java.net.URL url)
                           throws DeploymentException

Undeploy and remove the URL, url, from jrun.xml.

setUrl

public void setUrl(java.lang.String urlString)
            throws DeploymentException

This method conforms to the MBean standard in order to make use of attributes set in jrun.xml. It invokes deploy(url).

setFile

public void setFile(java.lang.String fileString)
             throws DeploymentException

This method conforms to the MBean standard in order to make use of attributes set in jrun.xml. It invokes deploy(url).

isDeployed

public boolean isDeployed(java.net.URL url)
                   throws DeploymentException,
                          java.rmi.RemoteException

Determine whether a specific application is deployed

inWatchedDirectory

public boolean inWatchedDirectory(java.net.URL url)

Determine if a URL is in a watched directory or not. This way you can make sure not to call undeploy because it could get deployed immediately.

isPersistXML

public boolean isPersistXML()

setPersistXML

public void setPersistXML(boolean persistXML)

isValidateXML

public boolean isValidateXML()

setValidateXML

public void setValidateXML(boolean validateXML)

isStartupDeployComplete

public boolean isStartupDeployComplete()
                                throws java.rmi.RemoteException

During server startup, client tools need to know when all deployments are completed.