Package cloud.piranha.api

Interface WebApplicationRequestMapper

All Known Implementing Classes:

DefaultWebApplicationRequestMapper

public interface WebApplicationRequestMapper

The WebApplicationRequestMapper API.

Author:

Manfred Riem ([email protected])

Method Summary

Modifier and Type	Method	Description
Set<String>	addFilterMapping(String filterName, String... urlPatterns)	Add a filter mapping.
Set<String>	addFilterMappingBeforeExisting(String filterName, String... urlPatterns)	Add a filter mapping.
Set<String>	addServletMapping(String servletName, String... urlPatterns)	Add a servlet mapping.
Collection<String>	findFilterMappings(String path)	Find the filter mappings for the given path.
WebApplicationRequestMapping	findServletMapping(String path)	Find the servlet mapping for the given path.
Collection<String>	getServletMappings(String servletName)	Get the mappings for the specified servlet.
String	getServletName(String mapping)	Get the servlet name for the specified mapping.

Method Detail

addServletMapping

Set<String> addServletMapping(String servletName,
                              String... urlPatterns)

Add a servlet mapping.

Parameters:

servletName - the servlet name.

urlPatterns - the URL patterns to map (aka mappings).

Returns:

the URL patterns that were added.

addFilterMapping

Set<String> addFilterMapping(String filterName,
                             String... urlPatterns)

Add a filter mapping.

This adds the filter mappings at the end of list of existing mappings (if any).

Parameters:

filterName - the filter name.

urlPatterns - the URL patterns to map (aka mappings).

Returns:

the URL patterns that were added.

addFilterMappingBeforeExisting

Set<String> addFilterMappingBeforeExisting(String filterName,
                                           String... urlPatterns)

Add a filter mapping.

This adds the filter mappings at the start of list of existing mappings (if any). If there are existing mappings these are shifted to the right.

Parameters:

filterName - the filter name.

urlPatterns - the URL patterns to map (aka mappings).

Returns:

the URL patterns that were added.

findFilterMappings

Collection<String> findFilterMappings(String path)

Find the filter mappings for the given path.

Parameters:

path - the path.

Returns:

the mappings.

findServletMapping

WebApplicationRequestMapping findServletMapping(String path)

Find the servlet mapping for the given path.

Parameters:

path - the path.

Returns:

the mapping, or null if not found.

getServletMappings

Collection<String> getServletMappings(String servletName)

Get the mappings for the specified servlet.

Parameters:

servletName - the servlet name.

Returns:

the servlet mappings, or an empty collection if none.

getServletName

String getServletName(String mapping)

Get the servlet name for the specified mapping.

Parameters:

mapping - the mapping.

Returns:

the servlet name, or null if not found.