jrun.servlet
Interface WebApplicationServiceMBean

All Superinterfaces:

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

All Known Subinterfaces:

WebApplication

public interface WebApplicationServiceMBean

extends ConfigurableServicePartitionMBean, J2EEModuleMBean

MBean interface for the JRun Web Application Service.

Author:

Karl Moss

Fields inherited from interface jrunx.kernel.Service

INITIALIZED, STARTED, STARTING, STOPPED, STOPPING, UNINITIALIZED

Method Summary

java.lang.Boolean	getCompile() Gets whether dynamic compile is enabled
java.lang.String	getDescription() Gets the web application description
java.lang.Boolean	getDirectoryBrowsing() Gets whether directory browsing is enabled.
java.lang.String	getDisplayName() Get the web application display name
java.lang.String	getDocumentRoot() Returns the current document root.
java.lang.Boolean	getFileServing() Gets whether file server is enabled for this web application
java.lang.Boolean	getReload() Gets whether dynamic reload is enabled
long	getServletCheckInterval() Gets the servlet check interval
ServletEngine	getServletEngine() Returns a direct reference to the servlet engine that this webapp belongs to.
java.lang.Boolean	getSessionPersistence()
java.lang.Boolean	getSessionReplication()
java.util.List	getSessionReplicationBuddies()
WebApplication	getWebApplication() Returns a direct reference to the web application
WebAppMetaData	getWebAppMetaData() Gets the metadata as read from web.xml
java.lang.String	getWebAppName() Gets the web application name
java.lang.String	getWebAppRoot() Gets the root location of the web application
java.lang.String	getWholeContextPath()
void	persistJRunWebXML()
void	persistWebXML()
void	setCompile(java.lang.Boolean enable) Set the dynamic compile meta data element.
void	setContextPath(java.lang.String path) Sets the context path of the web application.
void	setDirectoryBrowsing(java.lang.Boolean directoryBrowsing) Set directory browsing fo this web application
void	setDocumentRoot(java.lang.String documentRoot) Sets the current document root.
void	setFileServing(java.lang.Boolean enable) Set whether file server is enabled for this web application
void	setReload(java.lang.Boolean enable) Set the dynamic reload meta data element.
void	setServletCheckInterval(long ms) The number of milliseconds between checking for a change in a servlet class file.
void	setServletMapping(ServletMapping mapping) Sets (adds) a new ServletMapping for this web applications.
void	setSessionPersistence(java.lang.Boolean persistence)
void	setSessionReplication(java.lang.Boolean replicate)
void	setSessionReplicationBuddies(java.util.List l)
void	setWebAppName(java.lang.String name) Sets the web application name
void	setWebAppRoot(java.lang.String root) Sets the root location of the web application.
void	setWholeContextPath(java.lang.String contextPath)

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

Methods inherited from interface jrun.j2ee.J2EEModuleMBean

getDeploymentOrigin, isRunning, setDeploymentOrigin

Method Detail

getWebApplication

public WebApplication getWebApplication()

Returns a direct reference to the web application

Returns:

The web application

setWebAppName

public void setWebAppName(java.lang.String name)

Sets the web application name

Parameters:

name - The webapp name

getWebAppName

public java.lang.String getWebAppName()

Gets the web application name

Returns:

The webapp name

getDescription

public java.lang.String getDescription()

Gets the web application description

Returns:

the webapp description

getDisplayName

public java.lang.String getDisplayName()

Get the web application display name

Returns:

the display name from the descriptor if non-null or the web app name

setContextPath

public void setContextPath(java.lang.String path)

Sets the context path of the web application. The context path must start with a '/'.

Parameters:

path - The context path

getWholeContextPath

public java.lang.String getWholeContextPath()

setWholeContextPath

public void setWholeContextPath(java.lang.String contextPath)

setCompile

public void setCompile(java.lang.Boolean enable)

Set the dynamic compile meta data element.

Parameters:

enable - Enables/disables dynamic reload

getCompile

public java.lang.Boolean getCompile()

Gets whether dynamic compile is enabled

Returns:

Whether dynamic compile is enabled.

setDocumentRoot

public void setDocumentRoot(java.lang.String documentRoot)

Sets the current document root. This actually maps to a virtual mapping where the resource-path is / and the system-path is the documentRoot.

Parameters:

documentRoot - The document root for the web application

getDocumentRoot

public java.lang.String getDocumentRoot()

Returns the current document root.

Returns:

Returns the document root for the web application

setDirectoryBrowsing

public void setDirectoryBrowsing(java.lang.Boolean directoryBrowsing)

Set directory browsing fo this web application

Parameters:

enable - Enables/disables directory browsing.

getDirectoryBrowsing

public java.lang.Boolean getDirectoryBrowsing()

Gets whether directory browsing is enabled.

Returns:

Whether directory browsing is enabled.

setReload

public void setReload(java.lang.Boolean enable)

Set the dynamic reload meta data element.

Parameters:

enable - Enables/disables dynamic reload

getReload

public java.lang.Boolean getReload()

Gets whether dynamic reload is enabled

Returns:

Whether dynamic reload is enabled.

setFileServing

public void setFileServing(java.lang.Boolean enable)

Set whether file server is enabled for this web application

Parameters:

enable - Whether file serving is enabled

getFileServing

public java.lang.Boolean getFileServing()

Gets whether file server is enabled for this web application

Returns:

Whether file serving is enabled

setWebAppRoot

public void setWebAppRoot(java.lang.String root)

Sets the root location of the web application. This may be a directory path or a war file

Parameters:

root - The root location

getWebAppRoot

public java.lang.String getWebAppRoot()

Gets the root location of the web application

Returns:

The root location

setServletMapping

public void setServletMapping(ServletMapping mapping)

Sets (adds) a new ServletMapping for this web applications. If the ServletMapping target is null or empty, the mapping will be removed.

Parameters:

mapping - The new mapping to add

getWebAppMetaData

public WebAppMetaData getWebAppMetaData()

Gets the metadata as read from web.xml

Returns:

The web.xml metadata

getServletEngine

public ServletEngine getServletEngine()

Returns a direct reference to the servlet engine that this webapp belongs to.

setServletCheckInterval

public void setServletCheckInterval(long ms)

The number of milliseconds between checking for a change in a servlet class file. Automatic reloading of modified servlet classes relies on this setting. A setting of -1 will result in disabling servlet reloading

Parameters:

interval - Number of ms before checking for a new servlet class

getServletCheckInterval

public long getServletCheckInterval()

Gets the servlet check interval

Returns:

The number of ms before checking for a new servlet class

setSessionReplication

public void setSessionReplication(java.lang.Boolean replicate)

getSessionReplication

public java.lang.Boolean getSessionReplication()

setSessionReplicationBuddies

public void setSessionReplicationBuddies(java.util.List l)

getSessionReplicationBuddies

public java.util.List getSessionReplicationBuddies()

setSessionPersistence

public void setSessionPersistence(java.lang.Boolean persistence)

getSessionPersistence

public java.lang.Boolean getSessionPersistence()

persistJRunWebXML

public void persistJRunWebXML()
                       throws java.rmi.RemoteException

persistWebXML

public void persistWebXML()
                   throws java.rmi.RemoteException