Package com.ibm.wsspi.rest.handler
Interface RESTHandlerContainer
public interface RESTHandlerContainer
This container keeps track of all registered RESTHandler services and is able to find the best match for an incoming request.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
This parameter represents a comma-separated list of host names within the collective.static final String
This parameter represents a comma-separated list of the server installation directories to be used in a routing context.static final String
This parameter represents a comma-separated list of the server names to be used in a routing context.static final String
This parameter represents a comma-separated list of the server user directories to be used in a routing context.static final int
The current version of the container. -
Method Summary
Modifier and TypeMethodDescriptionboolean
handleRequest
(RESTRequest request, RESTResponse response) This method allows servlets or other REST entry points to delegate an incoming call to the RESTHandler framework.Provides access to an aggregated collection of the registered paths that the current RESTHandler are listening to.
-
Field Details
-
REST_HANDLER_CONTAINER_VERSION
static final int REST_HANDLER_CONTAINER_VERSIONThe current version of the container.- See Also:
-
COLLECTIVE_HOST_NAMES
This parameter represents a comma-separated list of host names within the collective.- See Also:
-
COLLECTIVE_SERVER_NAMES
This parameter represents a comma-separated list of the server names to be used in a routing context.- See Also:
-
COLLECTIVE_SERVER_INSTALL_DIRS
This parameter represents a comma-separated list of the server installation directories to be used in a routing context.- See Also:
-
COLLECTIVE_SERVER_USER_DIRS
This parameter represents a comma-separated list of the server user directories to be used in a routing context.- See Also:
-
-
Method Details
-
handleRequest
This method allows servlets or other REST entry points to delegate an incoming call to the RESTHandler framework. This container will match and delegate the incoming request to a registered RESTHandler, or return false if no match was found.- Parameters:
request
- encapsulates the artifacts for the HTTP requestresponse
- encapsulates the artifacts for the HTTP response- Returns:
- true if the request was matched and delegated to a registered RESTHandler, false if no match was found
- Throws:
IOException
-
registeredKeys
Provides access to an aggregated collection of the registered paths that the current RESTHandler are listening to.- Returns:
- an Iteration over the paths that are available to be invoked.
-