|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tomcat.core.Context
Context represent a Web Application as specified by Servlet Specs. The implementation is a repository for all the properties defined in web.xml and tomcat specific properties. This object has many properties, but doesn't do anything special except simple cashing. You need to set at least "path" and "base" before adding a context to a server. You can also set any other properties. At addContext() stage log and paths will be "fixed" based on context manager settings. At initContext() stage, web.xml will be read and all other properties will be set. WebXmlReader must be the first module in initContext() chain.
Field Summary | |
static java.lang.String |
ATTRIB_PREFIX
Private tomcat attribute names |
static java.lang.String |
ATTRIB_PROTECTION_DOMAIN
Protection domain to be used to create new classes in this context. |
static java.lang.String |
ATTRIB_REAL_CONTEXT
This attribute will return the real context ( org.apache.tomcat.core.Context). |
static int |
STATE_ADDED
Context was added to the server, but contextInit() is not called. |
static int |
STATE_DISABLED
Relative paths are fixed, based on server base, and CM is set. |
static int |
STATE_NEW
Context is new, possibly not even added to server. |
static int |
STATE_READY
Context is initialized and ready to serve. |
Constructor Summary | |
Context()
|
Method Summary | |
void |
addClassPath(java.net.URL url)
|
void |
addContainer(Container ct)
Add a new container. |
void |
addContentType(java.lang.String ext,
java.lang.String type)
|
void |
addEnvEntry(java.lang.String name,
java.lang.String type,
java.lang.String value,
java.lang.String description)
Add Env-entry to this context |
void |
addErrorPage(java.lang.String errorType,
java.lang.String value)
|
void |
addHandler(Handler wrapper)
Add a servlet. |
void |
addHostAlias(java.lang.String alias)
Virtual host support - this context will be part of a virtual host with the specified name. |
void |
addInitParameter(java.lang.String name,
java.lang.String value)
|
void |
addInterceptor(BaseInterceptor ri)
Add a per-context interceptor. |
void |
addSecurityConstraint(java.lang.String[] path,
java.lang.String[] methods,
java.lang.String[] roles,
java.lang.String transport)
Deprecated. Use addContainer |
void |
addServlet(Handler wrapper)
Add a servlet. |
void |
addServletMapping(java.lang.String path,
java.lang.String servletName)
Deprecated. Use addContainer |
void |
addTaglib(java.lang.String uri,
java.lang.String location)
Add a taglib declaration for this context |
void |
addWelcomeFile(java.lang.String s)
Add an welcome file. |
boolean |
allowAttribute(java.lang.String name)
Check if "special" attributes can be used by user application. |
java.lang.String |
getAbsolutePath()
Return the absolute path for the docBase, if we are file-system based, null otherwise. |
java.lang.Object |
getAttribute(java.lang.String name)
Return an attribute value. |
java.util.Enumeration |
getAttributeNames()
|
java.lang.String |
getAuthMethod()
Authentication method, if any specified |
java.lang.ClassLoader |
getClassLoader()
The current class loader. |
java.net.URL[] |
getClassPath()
Returns the full classpath - concatenation of ContextManager classpath and locally specified class path |
Container |
getContainer()
Default container for this context. |
Container |
getContainer(java.lang.String path)
Return the container ( properties ) associated with a path ( relative to this context ) |
java.util.Enumeration |
getContainerLocations()
Return an enumeration of Strings, representing all URLs ( relative to this context ) having associated properties ( handlers, security, etc) |
java.util.Enumeration |
getContainers()
|
ContextManager |
getContextManager()
Returned the main server ( servlet container ) |
int |
getDebug()
|
java.lang.String |
getDescription()
|
java.lang.String |
getDocBase()
|
java.lang.String |
getEngineHeader()
|
java.util.Enumeration |
getEnvEntries()
|
java.lang.String |
getEnvEntryType(java.lang.String name)
|
java.lang.String |
getEnvEntryValue(java.lang.String name)
|
java.lang.String |
getErrorPage(int errorCode)
|
java.lang.String |
getErrorPage(java.lang.String errorCode)
|
java.lang.Object |
getFacade()
Every context is associated with a facade. |
java.lang.String |
getFormErrorPage()
|
java.lang.String |
getFormLoginPage()
|
java.lang.String |
getHost()
Return the virtual host name, or null if we are in the default context |
java.lang.String |
getHostAddress()
Return the virtual host ip address. |
java.util.Enumeration |
getHostAliases()
|
java.lang.String |
getId()
|
java.lang.String |
getInitParameter(java.lang.String name)
|
java.util.Enumeration |
getInitParameterNames()
|
Log |
getLog()
|
java.net.FileNameMap |
getMimeMap()
|
java.lang.String |
getName()
Return a name ( id ) for this context. |
java.lang.String |
getPath()
Base URL for this context |
java.lang.String |
getProperty(java.lang.String n)
|
java.lang.String |
getRealmName()
Realm to be used |
boolean |
getReloadable()
Should we reload servlets ? |
java.lang.String |
getServletAPI()
|
Handler |
getServletByName(java.lang.String servletName)
|
Log |
getServletLog()
|
java.util.Enumeration |
getServletNames()
Return all servlets registered with this Context The elements will be of type Handler ( or sub-types ) |
int |
getSessionTimeOut()
|
int |
getState()
|
java.lang.String |
getTaglibLocation(java.lang.String uri)
|
java.util.Enumeration |
getTaglibs()
|
java.lang.String[] |
getWelcomeFiles()
Return welcome files defined in web.xml or the defaults, if user doesn't define any |
java.io.File |
getWorkDir()
|
void |
init()
Initializes this context to be able to accept requests. |
boolean |
isDistributable()
|
boolean |
isTrusted()
|
void |
log(java.lang.String msg)
Internal log method |
void |
log(java.lang.String msg,
java.lang.Throwable t)
Internal log method |
void |
log(java.lang.String msg,
java.lang.Throwable t,
int level)
Internal log method |
void |
logServlet(java.lang.String msg,
java.lang.Throwable t)
User-level log method ( called from a servlet). |
void |
removeAttribute(java.lang.String name)
|
void |
removeContainer(Container ct)
Remove a container |
void |
removeHandler(Handler handler)
|
void |
removeServletByName(java.lang.String servletName)
Remove the servlet with a specific name |
void |
setAbsolutePath(java.lang.String s)
Set the absolute path to this context. |
void |
setAttribute(java.lang.String name,
java.lang.Object object)
XXX Use callbacks !! |
void |
setClassLoader(java.lang.ClassLoader cl)
|
void |
setContextManager(ContextManager cm)
This method is called when the Context is added to a server. |
protected void |
setContextManager1(ContextManager cm)
|
void |
setDebug(int level)
|
void |
setDescription(java.lang.String description)
|
void |
setDistributable(boolean isDistributable)
|
void |
setDocBase(java.lang.String docB)
DocBase points to the web application files. |
void |
setEngineHeader(java.lang.String s)
What is reported in the "Servlet-Engine" header for this context. |
void |
setFacade(java.lang.Object obj)
|
void |
setFormErrorPage(java.lang.String page)
|
void |
setFormLoginPage(java.lang.String page)
|
void |
setHost(java.lang.String h)
Make this context visible as part of a virtual host. |
void |
setHostAddress(java.lang.String ip)
Set the virtual host ip address. |
void |
setIcon(java.lang.String icon)
|
void |
setLog(Log logger)
|
void |
setLoginConfig(java.lang.String authMethod,
java.lang.String realmName,
java.lang.String formLoginPage,
java.lang.String formErrorPage)
|
void |
setName(java.lang.String s)
|
void |
setPath(java.lang.String path)
Base URL for this context |
void |
setProperty(java.lang.String n,
java.lang.String v)
|
void |
setReloadable(boolean b)
|
void |
setServletAPI(java.lang.String s)
The servlet API variant that will be used for requests in this context |
void |
setServletLog(Log logger)
|
void |
setSessionTimeOut(int sessionTimeOut)
|
void |
setState(int state)
Move the context in a different state. |
protected void |
setState1(int state)
|
void |
setTrusted(boolean t)
Mark the webapplication as trusted, i.e. |
void |
setWorkDir(java.io.File workDir)
|
void |
setWorkDir(java.lang.String workDir)
Work dir is a place where servlets are allowed to write |
void |
shutdown()
Stop the context. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String ATTRIB_PREFIX
public static final java.lang.String ATTRIB_PROTECTION_DOMAIN
public static final java.lang.String ATTRIB_REAL_CONTEXT
public static final int STATE_NEW
public static final int STATE_ADDED
public static final int STATE_DISABLED
public static final int STATE_READY
Constructor Detail |
public Context()
Method Detail |
public void addContainer(Container ct) throws TomcatException
TomcatException
public void addServletMapping(java.lang.String path, java.lang.String servletName) throws TomcatException
TomcatException
public void addSecurityConstraint(java.lang.String[] path, java.lang.String[] methods, java.lang.String[] roles, java.lang.String transport) throws TomcatException
TomcatException
public boolean allowAttribute(java.lang.String name)
public java.lang.Object getFacade()
public void setFacade(java.lang.Object obj)
public final ContextManager getContextManager()
public void setContextManager(ContextManager cm)
protected void setContextManager1(ContextManager cm)
public Container getContainer()
public final int getState()
public void setState(int state) throws TomcatException
TomcatException
protected void setState1(int state)
public void init() throws TomcatException
This method must be called before any requests are handled by this context. It will be called after the context was added, typically when the engine starts or after the admin adds a new context. After this call, the context will be in READY state and will be able to server requests.
if
- any interceptor throws an exception the error
will prevent the context from becoming READY
TomcatException
public void shutdown() throws TomcatException
TomcatException
public java.lang.String getName()
public void setName(java.lang.String s)
public java.lang.String getPath()
public void setPath(java.lang.String path)
public void setHost(java.lang.String h)
public java.lang.String getHost()
public final void setHostAddress(java.lang.String ip)
public final java.lang.String getHostAddress()
public void setDocBase(java.lang.String docB)
public java.lang.String getDocBase()
public java.lang.String getAbsolutePath()
public void setAbsolutePath(java.lang.String s)
public java.lang.String getProperty(java.lang.String n)
public void setProperty(java.lang.String n, java.lang.String v)
public void setReloadable(boolean b)
public boolean getReloadable()
public void setServletAPI(java.lang.String s)
public java.lang.String getServletAPI()
public java.lang.String[] getWelcomeFiles()
public void addWelcomeFile(java.lang.String s)
public java.lang.String getInitParameter(java.lang.String name)
public void addInitParameter(java.lang.String name, java.lang.String value)
public java.util.Enumeration getInitParameterNames()
public java.lang.Object getAttribute(java.lang.String name)
public java.util.Enumeration getAttributeNames()
public void setAttribute(java.lang.String name, java.lang.Object object)
public void removeAttribute(java.lang.String name)
public void addTaglib(java.lang.String uri, java.lang.String location)
public java.lang.String getTaglibLocation(java.lang.String uri)
public java.util.Enumeration getTaglibs()
public void addEnvEntry(java.lang.String name, java.lang.String type, java.lang.String value, java.lang.String description)
public java.lang.String getEnvEntryType(java.lang.String name)
public java.lang.String getEnvEntryValue(java.lang.String name)
public java.util.Enumeration getEnvEntries()
public java.lang.String getDescription()
public void setDescription(java.lang.String description)
public void setIcon(java.lang.String icon)
public boolean isDistributable()
public void setDistributable(boolean isDistributable)
public int getSessionTimeOut()
public void setSessionTimeOut(int sessionTimeOut)
public java.net.FileNameMap getMimeMap()
public void addContentType(java.lang.String ext, java.lang.String type)
public java.lang.String getErrorPage(int errorCode)
public void addErrorPage(java.lang.String errorType, java.lang.String value)
public java.lang.String getErrorPage(java.lang.String errorCode)
public java.lang.String getAuthMethod()
public java.lang.String getRealmName()
public java.lang.String getFormLoginPage()
public java.lang.String getFormErrorPage()
public void setFormLoginPage(java.lang.String page)
public void setFormErrorPage(java.lang.String page)
public void setLoginConfig(java.lang.String authMethod, java.lang.String realmName, java.lang.String formLoginPage, java.lang.String formErrorPage)
public java.util.Enumeration getContainers()
public java.util.Enumeration getContainerLocations()
public Container getContainer(java.lang.String path)
public void removeContainer(Container ct) throws TomcatException
TomcatException
public void addServlet(Handler wrapper) throws TomcatException
TomcatException
public void addHandler(Handler wrapper) throws TomcatException
TomcatException
public void removeHandler(Handler handler) throws TomcatException
TomcatException
public void removeServletByName(java.lang.String servletName) throws TomcatException
TomcatException
public Handler getServletByName(java.lang.String servletName)
public java.util.Enumeration getServletNames()
public java.lang.ClassLoader getClassLoader()
public void setClassLoader(java.lang.ClassLoader cl)
public void addClassPath(java.net.URL url)
public java.net.URL[] getClassPath()
public void setDebug(int level)
public int getDebug()
public java.lang.String toString()
public java.lang.String getId()
public void log(java.lang.String msg)
public void log(java.lang.String msg, java.lang.Throwable t)
public void log(java.lang.String msg, java.lang.Throwable t, int level)
public void logServlet(java.lang.String msg, java.lang.Throwable t)
public void setLog(Log logger)
public void setServletLog(Log logger)
public Log getLog()
public Log getServletLog()
public void setEngineHeader(java.lang.String s)
public java.lang.String getEngineHeader()
public void setWorkDir(java.lang.String workDir)
public java.io.File getWorkDir()
public void setWorkDir(java.io.File workDir)
public void addHostAlias(java.lang.String alias)
public java.util.Enumeration getHostAliases()
public void setTrusted(boolean t)
public boolean isTrusted()
public void addInterceptor(BaseInterceptor ri) throws TomcatException
TomcatException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |