org.apache.tomcat.util.http.mapper

Class Mapper

java.lang.Object

org.apache.tomcat.util.http.mapper.Mapper

public final class Mapper
extends Object

Mapper, which implements the servlet API mapping rules (which are derived from the HTTP rules).

Author:

Remy Maucherat

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
Mapper()

Method Summary

Modifier and Type	Method and Description
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

hosts

protected Mapper.Host[] hosts

Array containing the virtual hosts definitions.

defaultHostName

protected String defaultHostName

Default host name.

context

protected Mapper.Context context

Context associated with this wrapper, used for wrapper mapping.

Constructor Detail

Mapper

public Mapper()

Method Detail

getDefaultHostName

public String getDefaultHostName()

Get default host.

Returns:

Default host name

setDefaultHostName

public void setDefaultHostName(String defaultHostName)

Set default host.

Parameters:

defaultHostName - Default host name

setHandleFolderRedirects

public static void setHandleFolderRedirects(boolean redirect)

Sets whether or not this Mapper redirects directory requests that aren't / terminated.

Parameters:

redirect - true if this Mapper should redirect such requests, false if the default servlet handles such requests.

isHandleFolderRedirects

public static boolean isHandleFolderRedirects()

Returns whether or not this Mapper redirects directory requests that aren't / terminated.

addHost

public void addHost(String name,
                    String[] aliases,
                    Object host)

Add a new host to the mapper.

Parameters:

name - Virtual host name

host - Host object

removeHost

public void removeHost(String name)

Remove a host from the mapper.

Parameters:

name - Virtual host name

getHosts

public String[] getHosts()

setContext

public void setContext(String path,
                       String[] welcomeResources,
                       Context resources)

Set context, used for wrapper mapping (request dispatcher).

Parameters:

welcomeResources - Welcome files defined for this context

resources - Static resources of the context

addContext

public void addContext(String hostName,
                       String path,
                       Object context,
                       String[] welcomeResources,
                       Context resources,
                       ArrayList<AlternateDocBase> alternateDocBases)

Add a new Context to an existing Host.

Parameters:

hostName - Virtual host name this context belongs to

path - Context path

context - Context object

welcomeResources - Welcome files defined for this context

resources - Static resources of the context

removeContext

public void removeContext(String hostName,
                          String path)

Remove a context from an existing host.

Parameters:

hostName - Virtual host name this context belongs to

path - Context path

getContextNames

public String[] getContextNames()

Return all contexts, in //HOST/PATH form

Returns:

The context names

addWrapper

public void addWrapper(String hostName,
                       String contextPath,
                       String path,
                       Object wrapper)

Add a new Wrapper to an existing Context.

Parameters:

hostName - Virtual host name this wrapper belongs to

contextPath - Context path this wrapper belongs to

path - Wrapper mapping

wrapper - Wrapper object

addWrapper

public void addWrapper(String hostName,
                       String contextPath,
                       String path,
                       Object wrapper,
                       boolean jspWildCard)

addWrapper

public void addWrapper(String path,
                       Object wrapper)

Add a wrapper to the context associated with this wrapper.

Parameters:

path - Wrapper mapping

wrapper - The Wrapper object

addWrapper

public void addWrapper(String path,
                       Object wrapper,
                       boolean jspWildCard)

addWrapper

protected void addWrapper(Mapper.Context context,
                          String path,
                          Object wrapper)

addWrapper

protected void addWrapper(Mapper.Context context,
                          String path,
                          Object wrapper,
                          boolean jspWildCard)

Adds a wrapper to the given context.

Parameters:

context - The context to which to add the wrapper

path - Wrapper mapping

wrapper - The Wrapper object

jspWildCard - true if the wrapper corresponds to the JspServlet and the mapping path contains a wildcard; false otherwise

removeWrapper

public void removeWrapper(String path)

Remove a wrapper from the context associated with this wrapper.

Parameters:

path - Wrapper mapping

removeWrapper

public void removeWrapper(String hostName,
                          String contextPath,
                          String path)

Remove a wrapper from an existing context.

Parameters:

hostName - Virtual host name this wrapper belongs to

contextPath - Context path this wrapper belongs to

path - Wrapper mapping

removeWrapper

protected void removeWrapper(Mapper.Context context,
                             String path)

getWrappersString

public String getWrappersString(String host,
                                String context)

getWrapperNames

public String[] getWrapperNames(String host,
                                String context)

setDefaultContextPath

public void setDefaultContextPath(String hostName,
                                  String defaultContextPath)
                           throws Exception

Configures the given virtual server with the given default context path. The given default path corresponds to the context path of one of the web contexts deployed on the virtual server that has been designated as the virtual server's new default-web-module.

Throws:

Exception - if there is no web context deployed on the given virtual server that matches the given default context path

map

public void map(MessageBytes host,
                MessageBytes uri,
                MappingData mappingData)
         throws Exception

Map the specified host name and URI, mutating the given mapping data.

Parameters:

host - Virtual host name

uri - URI

mappingData - This structure will contain the result of the mapping operation

Throws:

Exception

map

public void map(MessageBytes uri,
                MappingData mappingData)
         throws Exception

Map the specified URI relative to the context, mutating the given mapping data.

Parameters:

uri - URI

mappingData - This structure will contain the result of the mapping operation

Throws:

Exception