Constructor Detail

• Mapper

  public Mapper()

Method Detail

• setDefaultHostName

  public void setDefaultHostName(java.lang.String defaultHostName)

  Set default host.

  Parameters:

  defaultHostName - Default host name

• addHost

  public void addHost(java.lang.String name,
             java.lang.String[] aliases,
             Host host)

  Add a new host to the mapper.

  Parameters:

  name - Virtual host name

  aliases - Alias names for the virtual host

  host - Host object

• removeHost

  public void removeHost(java.lang.String name)

  Remove a host from the mapper.

  Parameters:

  name - Virtual host name

• addHostAlias

  public void addHostAlias(java.lang.String name,
                  java.lang.String alias)

  Add an alias to an existing host.

  Parameters:

  name - The name of the host

  alias - The alias to add

• removeHostAlias

  public void removeHostAlias(java.lang.String alias)

  Remove a host alias

  Parameters:

  alias - The alias to remove

• addContextVersion

  @Deprecated
  public void addContextVersion(java.lang.String hostName,
                                  Host host,
                                  java.lang.String path,
                                  java.lang.String version,
                                  Context context,
                                  java.lang.String[] welcomeResources,
                                  WebResourceRoot resources)

  Deprecated. Use addContextVersion(String, Host, String, String, Context, String[], WebResourceRoot, Collection)
  Add a new Context to an existing Host.

  Parameters:

  hostName - Virtual host name this context belongs to

  host - Host object

  path - Context path

  version - Context version

  context - Context object

  welcomeResources - Welcome files defined for this context

  resources - Static resources of the context

• addContextVersion

  public void addContextVersion(java.lang.String hostName,
                       Host host,
                       java.lang.String path,
                       java.lang.String version,
                       Context context,
                       java.lang.String[] welcomeResources,
                       WebResourceRoot resources,
                       java.util.Collection<WrapperMappingInfo> wrappers)

  Add a new Context to an existing Host.

  Parameters:

  hostName - Virtual host name this context belongs to

  host - Host object

  path - Context path

  version - Context version

  context - Context object

  welcomeResources - Welcome files defined for this context

  resources - Static resources of the context

  wrappers - Information on wrapper mappings

• removeContextVersion

  public void removeContextVersion(Context ctxt,
                          java.lang.String hostName,
                          java.lang.String path,
                          java.lang.String version)

  Remove a context from an existing host.

  Parameters:

  ctxt - The actual context

  hostName - Virtual host name this context belongs to

  path - Context path

  version - Context version

• pauseContextVersion

  public void pauseContextVersion(Context ctxt,
                         java.lang.String hostName,
                         java.lang.String contextPath,
                         java.lang.String version)

  Mark a context as being reloaded. Reversion of this state is performed by calling addContextVersion(...) when context starts up.

  Parameters:

  ctxt - The actual context

  hostName - Virtual host name this context belongs to

  contextPath - Context path

  version - Context version

• addWrapper

  public void addWrapper(java.lang.String hostName,
                java.lang.String contextPath,
                java.lang.String version,
                java.lang.String path,
                Wrapper wrapper,
                boolean jspWildCard,
                boolean resourceOnly)

• addWrappers

  public void addWrappers(java.lang.String hostName,
                 java.lang.String contextPath,
                 java.lang.String version,
                 java.util.Collection<WrapperMappingInfo> wrappers)

• addWrapper

  protected void addWrapper(Mapper.ContextVersion context,
                java.lang.String path,
                Wrapper wrapper,
                boolean jspWildCard,
                boolean resourceOnly)

  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

  resourceOnly - true if this wrapper always expects a physical resource to be present (such as a JSP)

• removeWrapper

  public void removeWrapper(java.lang.String hostName,
                   java.lang.String contextPath,
                   java.lang.String version,
                   java.lang.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.ContextVersion context,
                   java.lang.String path)

• addWelcomeFile

  public void addWelcomeFile(java.lang.String hostName,
                    java.lang.String contextPath,
                    java.lang.String version,
                    java.lang.String welcomeFile)

  Add a welcome file to the given context.

  Parameters:

  hostName -

  contextPath -

  welcomeFile -

• removeWelcomeFile

  public void removeWelcomeFile(java.lang.String hostName,
                       java.lang.String contextPath,
                       java.lang.String version,
                       java.lang.String welcomeFile)

  Remove a welcome file from the given context.

  Parameters:

  hostName -

  contextPath -

  welcomeFile -

• clearWelcomeFiles

  public void clearWelcomeFiles(java.lang.String hostName,
                       java.lang.String contextPath,
                       java.lang.String version)

  Clear the welcome files for the given context.

  Parameters:

  hostName -

  contextPath -

• map

  public void map(MessageBytes host,
         MessageBytes uri,
         java.lang.String version,
         MappingData mappingData)
           throws java.io.IOException

  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:

  java.io.IOException - if the buffers are too small to hold the results of the mapping.

• map

  public void map(Context context,
         MessageBytes uri,
         MappingData mappingData)
           throws java.io.IOException

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

  Parameters:

  context - The actual context

  uri - URI

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

  Throws:

  java.io.IOException - if the buffers are too small to hold the results of the mapping.