|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.tomcat.util.http.mapper.Mapper
public final class Mapper
Mapper, which implements the servlet API mapping rules (which are derived from the HTTP rules).
| Nested Class Summary | |
|---|---|
protected static class |
Mapper.Context
|
protected static class |
Mapper.ContextList
|
protected static class |
Mapper.Host
|
protected static class |
Mapper.MapElement
|
protected static class |
Mapper.Wrapper
|
| Field Summary | |
|---|---|
protected Mapper.Context |
context
Context associated with this wrapper, used for wrapper mapping. |
protected String |
defaultHostName
Default host name. |
protected Mapper.Host[] |
hosts
Array containing the virtual hosts definitions. |
| Constructor Summary | |
|---|---|
Mapper()
|
|
| Method Summary | |
|---|---|
void |
addContext(String hostName,
String path,
Object context,
String[] welcomeResources,
Context resources,
ArrayList<AlternateDocBase> alternateDocBases)
Add a new Context to an existing Host. |
void |
addHost(String name,
String[] aliases,
Object host)
Add a new host to the mapper. |
protected void |
addWrapper(Mapper.Context context,
String path,
Object wrapper)
|
protected void |
addWrapper(Mapper.Context context,
String path,
Object wrapper,
boolean jspWildCard)
Adds a wrapper to the given context. |
void |
addWrapper(String path,
Object wrapper)
Add a wrapper to the context associated with this wrapper. |
void |
addWrapper(String path,
Object wrapper,
boolean jspWildCard)
|
void |
addWrapper(String hostName,
String contextPath,
String path,
Object wrapper)
Add a new Wrapper to an existing Context. |
void |
addWrapper(String hostName,
String contextPath,
String path,
Object wrapper,
boolean jspWildCard)
|
String[] |
getContextNames()
Return all contexts, in //HOST/PATH form |
String |
getDefaultHostName()
Get default host. |
String[] |
getHosts()
|
String[] |
getWrapperNames(String host,
String context)
|
String |
getWrappersString(String host,
String context)
|
static boolean |
isHandleFolderRedirects()
Returns whether or not this Mapper redirects directory requests that aren't / terminated. |
void |
map(MessageBytes uri,
MappingData mappingData)
Map the specified URI relative to the context, mutating the given mapping data. |
void |
map(MessageBytes host,
MessageBytes uri,
MappingData mappingData)
Map the specified host name and URI, mutating the given mapping data. |
void |
removeContext(String hostName,
String path)
Remove a context from an existing host. |
void |
removeHost(String name)
Remove a host from the mapper. |
protected void |
removeWrapper(Mapper.Context context,
String path)
|
void |
removeWrapper(String path)
Remove a wrapper from the context associated with this wrapper. |
void |
removeWrapper(String hostName,
String contextPath,
String path)
Remove a wrapper from an existing context. |
void |
setContext(String path,
String[] welcomeResources,
Context resources)
Set context, used for wrapper mapping (request dispatcher). |
void |
setDefaultContextPath(String hostName,
String defaultContextPath)
Configures the given virtual server with the given default context path. |
void |
setDefaultHostName(String defaultHostName)
Set default host. |
static void |
setHandleFolderRedirects(boolean redirect)
Sets whether or not this Mapper redirects directory requests that aren't / terminated. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Mapper.Host[] hosts
protected String defaultHostName
protected Mapper.Context context
| Constructor Detail |
|---|
public Mapper()
| Method Detail |
|---|
public String getDefaultHostName()
public void setDefaultHostName(String defaultHostName)
defaultHostName - Default host namepublic static void setHandleFolderRedirects(boolean redirect)
redirect - true if this Mapper should redirect such
requests, false if the default servlet handles such requests.public static boolean isHandleFolderRedirects()
public void addHost(String name,
String[] aliases,
Object host)
name - Virtual host namehost - Host objectpublic void removeHost(String name)
name - Virtual host namepublic String[] getHosts()
public void setContext(String path,
String[] welcomeResources,
Context resources)
welcomeResources - Welcome files defined for this contextresources - Static resources of the context
public void addContext(String hostName,
String path,
Object context,
String[] welcomeResources,
Context resources,
ArrayList<AlternateDocBase> alternateDocBases)
hostName - Virtual host name this context belongs topath - Context pathcontext - Context objectwelcomeResources - Welcome files defined for this contextresources - Static resources of the context
public void removeContext(String hostName,
String path)
hostName - Virtual host name this context belongs topath - Context pathpublic String[] getContextNames()
public void addWrapper(String hostName,
String contextPath,
String path,
Object wrapper)
hostName - Virtual host name this wrapper belongs tocontextPath - Context path this wrapper belongs topath - Wrapper mappingwrapper - Wrapper object
public void addWrapper(String hostName,
String contextPath,
String path,
Object wrapper,
boolean jspWildCard)
public void addWrapper(String path,
Object wrapper)
path - Wrapper mappingwrapper - The Wrapper object
public void addWrapper(String path,
Object wrapper,
boolean jspWildCard)
protected void addWrapper(Mapper.Context context,
String path,
Object wrapper)
protected void addWrapper(Mapper.Context context,
String path,
Object wrapper,
boolean jspWildCard)
context - The context to which to add the wrapperpath - Wrapper mappingwrapper - The Wrapper objectjspWildCard - true if the wrapper corresponds to the JspServlet
and the mapping path contains a wildcard; false otherwisepublic void removeWrapper(String path)
path - Wrapper mapping
public void removeWrapper(String hostName,
String contextPath,
String path)
hostName - Virtual host name this wrapper belongs tocontextPath - Context path this wrapper belongs topath - Wrapper mapping
protected void removeWrapper(Mapper.Context context,
String path)
public String getWrappersString(String host,
String context)
public String[] getWrapperNames(String host,
String context)
public void setDefaultContextPath(String hostName,
String defaultContextPath)
throws Exception
Exception - if there is no web context deployed on the given
virtual server that matches the given default context path
public void map(MessageBytes host,
MessageBytes uri,
MappingData mappingData)
throws Exception
host - Virtual host nameuri - URImappingData - This structure will contain the result of the mapping
operation
Exception
public void map(MessageBytes uri,
MappingData mappingData)
throws Exception
uri - URImappingData - This structure will contain the result of the mapping
operation
Exception
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||