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

Interface Service

All Known Subinterfaces:

StaticContentService

All Known Implementing Classes:

ServiceImpl, StaticContentServiceImpl

public interface Service

Represents a service entry point.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Service.TransportGuarantee Restrictions on the type of connection this service.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getInitParameters() Get the parameters, which which the Servlet will be.
String	getPath() Get the path under which the service can be accessed.
javax.servlet.Servlet	getServlet() Get the Servlet that handles this service entry point.
Service.TransportGuarantee	getTransportGuarantee() Obtain the connection restriction this service places on the container.
void	setInitParameters(Map<String,String> params) Set the initial configuration of the servlet.
void	setPath(String path) Set the path under which the service can be accessed.
void	setServlet(javax.servlet.Servlet servlet) Set a Servlet to handle this service.
void	setTransportGuarantee(Service.TransportGuarantee guarantee) Specify what connection guarantees this service expects from the container.

Method Detail

getPath

String getPath()

Get the path under which the service can be accessed.

Returns:

a standard servlet mapping pattern.

setPath

void setPath(String path)

Set the path under which the service can be accessed.

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.

Note
For backward compatibility all exact patterns are also registered under a path with a trailing "/". E.g. "/foo/bar/baz" is also registered under "/foo/bar/baz/".

Parameters:

path - the path

getServlet

javax.servlet.Servlet getServlet()

Get the Servlet that handles this service entry point.

Returns:

a Servlet object.

setServlet

void setServlet(javax.servlet.Servlet servlet)

Set a Servlet to handle this service.

Parameters:

servlet - the Servlet.

getInitParameters

Map<String,String> getInitParameters()

Get the parameters, which which the Servlet will be.

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 servlet. These parameters will be accessible to the Servlet via it's ServletConfig.

Parameters:

params - the parameters.

setTransportGuarantee

void setTransportGuarantee(Service.TransportGuarantee guarantee)

Specify what connection guarantees this service expects from the container.

Parameters:

guarantee -

getTransportGuarantee

Service.TransportGuarantee getTransportGuarantee()

Obtain the connection restriction this service places on the container.

Returns:

the connection restriction