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

Class ServiceImpl

java.lang.Object

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

All Implemented Interfaces:

Service

Direct Known Subclasses:

StaticContentServiceImpl

public class ServiceImpl
extends Object
implements Service

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vapi.protocol.server.rpc.http.Service

Service.TransportGuarantee

Constructor Summary

Constructors

Constructor and Description
ServiceImpl()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceImpl

public ServiceImpl()

Method Detail

getPath

public String getPath()

Description copied from interface: Service

Get the path under which the service can be accessed.

Specified by:

getPath in interface Service

Returns:

a standard servlet mapping pattern.

setPath

public void setPath(String path)

Description copied from interface: Service

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/".

Specified by:

setPath in interface Service

Parameters:

path - the path

getServlet

public javax.servlet.Servlet getServlet()

Description copied from interface: Service

Get the Servlet that handles this service entry point.

Specified by:

getServlet in interface Service

Returns:

a Servlet object.

setServlet

public void setServlet(javax.servlet.Servlet servlet)

Description copied from interface: Service

Set a Servlet to handle this service.

Specified by:

setServlet in interface Service

Parameters:

servlet - the Servlet.

getInitParameters

public Map<String,String> getInitParameters()

Description copied from interface: Service

Get the parameters, which which the Servlet will be.

Specified by:

getInitParameters in interface Service

Returns:

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

setInitParameters

public void setInitParameters(Map<String,String> params)

Description copied from interface: Service

Set the initial configuration of the servlet. These parameters will be accessible to the Servlet via it's ServletConfig.

Specified by:

setInitParameters in interface Service

Parameters:

params - the parameters.

getTransportGuarantee

public Service.TransportGuarantee getTransportGuarantee()

Description copied from interface: Service

Obtain the connection restriction this service places on the container.

Specified by:

getTransportGuarantee in interface Service

Returns:

the connection restriction

setTransportGuarantee

public void setTransportGuarantee(Service.TransportGuarantee guarantee)

Description copied from interface: Service

Specify what connection guarantees this service expects from the container.

Specified by:

setTransportGuarantee in interface Service