com.vmware.vapi.protocol.server.rpc.http

Interface Filter

All Known Implementing Classes:

FilterImpl

public interface Filter

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Filter.Dispatcher

Method Summary

Modifier and Type	Method and Description
Filter.Dispatcher[]	getDispatchers()
javax.servlet.Filter	getFilter() Get the Servlet API filter.
Map<String,String>	getInitParameters() Get the parameters, which which the Filter will be initialized.
String	getPath() Get the path for, which the filter is triggered.
void	setDispatchers(Filter.Dispatcher[] dispatchers)
void	setFilter(javax.servlet.Filter filter) Set the Servlet API Filter.
void	setInitParameters(Map<String,String> params) Set the initial configuration of the Filter.
void	setPath(String path) Set the path for which the filter is triggered.

Method Detail

getDispatchers

Filter.Dispatcher[] getDispatchers()

Returns:

the dispatchers

setDispatchers

void setDispatchers(Filter.Dispatcher[] dispatchers)

Parameters:

dispatchers - should not have duplicates and nulls.

getPath

String getPath()

Get the path for, which the filter is triggered.

Returns:

a standard servlet mapping pattern.

setPath

void setPath(String path)

Set the path for which the filter is triggered.

The path must follow the standard Servlet spec mapping patterns:

• Exact: starts with "/" and does not end with "/*".
• Prefix: starts with "/" and ends with "/*".
• Extension: starts with "*."
• Default: equals "/".

Request paths are tested against the mapping patterns in the standard order:

1. Exact match: E.g. "/foo".
2. Longest prefix match: E.g. "/foo/bar/*" is tested before "/foo/*".
3. Longest extension match: E.g. "*.html" is tested before "*.htm".
4. Default always matches: E.g. use this if no other matches.

Parameters:

path - the path

getFilter

javax.servlet.Filter getFilter()

Get the Servlet API filter.

Returns:

a Filter object.

setFilter

void setFilter(javax.servlet.Filter filter)

Set the Servlet API Filter.

Parameters:

filter - the Filter.

getInitParameters

Map<String,String> getInitParameters()

Get the parameters, which which the Filter will be initialized.

Returns:

a Map with the initial parameters or null if no initial configuration is set.

setInitParameters

void setInitParameters(Map<String,String> params)

Set the initial configuration of the Filter. These parameters will be accessible to the Filter via it's FilterConfig.

Parameters:

params - the parameters.