com.sun.enterprise.web
Class WebModuleConfig

java.lang.Object
  extended by com.sun.enterprise.web.WebModuleConfig

public class WebModuleConfig
extends java.lang.Object

Represents the configuration parameters required in order to create and install a web module (web application) into the server runtime.


Constructor Summary
WebModuleConfig()
           
 
Method Summary
 java.lang.ClassLoader getAppClassLoader()
           
 Application getBean()
          Return the configuration information specified in server.xml.
 java.lang.String getContextPath()
          Return the context path at which the web application is deployed.
 DeploymentContext getDeploymentContext()
          Gets the deployment context of this web application.
 WebBundleDescriptor getDescriptor()
          Return the object representation of the deployment descriptor specified for the web application.
 java.io.File getLocation()
          Return the directory in which the web application is deployed.
 java.lang.String getName()
          Return the name of the web application (as specified in server.xml)
 java.lang.String getObjectType()
          Return the objectType property
 java.lang.ClassLoader getParentLoader()
          Return the parent classloader for the web application.
 java.lang.String getStubPath()
          Gets the stub path of this web application.
 java.lang.String getVirtualServers()
          Return the list of virtual servers to which the web application is deployed.
 java.lang.String getWorkDir()
          Gets the work directory for this web application.
 void setAppClassLoader(java.lang.ClassLoader _appClassLoader)
           
 void setBean(Application wmBean)
          Set the elements of information specified in the web-module element in server.xml.
 void setDeploymentContext(DeploymentContext deploymentContext)
          Sets the deployment context for this web application.
 void setDescriptor(WebBundleDescriptor wbd)
          Set the deployment descriptor object describing the contents of the web application.
 void setLocation(java.io.File sourceDir)
          Set the directory in which the web application is deployed.
 void setObjectType(java.lang.String objectType)
          Set the objectType property.
 void setParentLoader(java.lang.ClassLoader parentLoader)
          Set the parent classloader for the web application.
 void setStubBaseDir(java.lang.String stubBaseDir)
          Sets the base directory of this web application's stub path.
 void setVirtualServers(java.lang.String virtualServers)
          Return the list of virtual servers to which the web application is deployed.
 void setWorkDir(java.lang.String workDir)
          Sets the work directory for this web application.
 void setWorkDirBase(java.lang.String baseDir)
          Sets the parent of the work directory for this web application.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebModuleConfig

public WebModuleConfig()
Method Detail

getAppClassLoader

public java.lang.ClassLoader getAppClassLoader()

setAppClassLoader

public void setAppClassLoader(java.lang.ClassLoader _appClassLoader)

setBean

public void setBean(Application wmBean)
Set the elements of information specified in the web-module element in server.xml.


getBean

public Application getBean()
Return the configuration information specified in server.xml.


getName

public java.lang.String getName()
Return the name of the web application (as specified in server.xml)

Returns:
[$appID:]$moduleID

getContextPath

public java.lang.String getContextPath()
Return the context path at which the web application is deployed.


setLocation

public void setLocation(java.io.File sourceDir)
Set the directory in which the web application is deployed.


getLocation

public java.io.File getLocation()
Return the directory in which the web application is deployed.


getVirtualServers

public java.lang.String getVirtualServers()
Return the list of virtual servers to which the web application is deployed.


setVirtualServers

public void setVirtualServers(java.lang.String virtualServers)
Return the list of virtual servers to which the web application is deployed.


setParentLoader

public void setParentLoader(java.lang.ClassLoader parentLoader)
Set the parent classloader for the web application.


getParentLoader

public java.lang.ClassLoader getParentLoader()
Return the parent classloader for the web application.


setDeploymentContext

public void setDeploymentContext(DeploymentContext deploymentContext)
Sets the deployment context for this web application.


getDeploymentContext

public DeploymentContext getDeploymentContext()
Gets the deployment context of this web application.


setWorkDir

public void setWorkDir(java.lang.String workDir)
Sets the work directory for this web application.


getWorkDir

public java.lang.String getWorkDir()
Gets the work directory for this web application. The work directory is either generated/jsp/$appID/$moduleID or generated/jsp/$moduleID


getStubPath

public java.lang.String getStubPath()
Gets the stub path of this web application.

Returns:
Stub path of this web application

setWorkDirBase

public void setWorkDirBase(java.lang.String baseDir)
Sets the parent of the work directory for this web application. The actual work directory is a subdirectory named after the web application.

Parameters:
baseDir - The new base directory under which the actual work directory will be created

setStubBaseDir

public void setStubBaseDir(java.lang.String stubBaseDir)
Sets the base directory of this web application's stub path.

Parameters:
stubBaseDir - Stub path

getDescriptor

public WebBundleDescriptor getDescriptor()
Return the object representation of the deployment descriptor specified for the web application.


setDescriptor

public void setDescriptor(WebBundleDescriptor wbd)
Set the deployment descriptor object describing the contents of the web application.

Parameters:
wbd - The deployment descriptor object

getObjectType

public java.lang.String getObjectType()
Return the objectType property


setObjectType

public void setObjectType(java.lang.String objectType)
Set the objectType property.

Parameters:
objectType - objectType property


Copyright © 2012 GlassFish Community. All Rights Reserved.