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
Fields Modifier and Type Field Description static java.lang.String
COLLECTIVE_HOST_NAMES
This parameter represents a comma-separated list of host names within the collective.static java.lang.String
COLLECTIVE_SERVER_INSTALL_DIRS
This parameter represents a comma-separated list of the server installation directories to be used in a routing context.static java.lang.String
COLLECTIVE_SERVER_NAMES
This parameter represents a comma-separated list of the server names to be used in a routing context.static java.lang.String
COLLECTIVE_SERVER_USER_DIRS
This parameter represents a comma-separated list of the server user directories to be used in a routing context.static int
REST_HANDLER_CONTAINER_VERSION
The current version of the container.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
handleRequest(RESTRequest request, RESTResponse response)
This method allows servlets or other REST entry points to delegate an incoming call to the RESTHandler framework.java.util.Iterator<java.lang.String>
registeredKeys()
Provides access to an aggregated collection of the registered paths that the current RESTHandler are listening to.
-
-
-
Field Detail
-
REST_HANDLER_CONTAINER_VERSION
static final int REST_HANDLER_CONTAINER_VERSION
The current version of the container.- See Also:
- Constant Field Values
-
COLLECTIVE_HOST_NAMES
static final java.lang.String COLLECTIVE_HOST_NAMES
This parameter represents a comma-separated list of host names within the collective.- See Also:
- Constant Field Values
-
COLLECTIVE_SERVER_NAMES
static final java.lang.String COLLECTIVE_SERVER_NAMES
This parameter represents a comma-separated list of the server names to be used in a routing context.- See Also:
- Constant Field Values
-
COLLECTIVE_SERVER_INSTALL_DIRS
static final java.lang.String 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:
- Constant Field Values
-
COLLECTIVE_SERVER_USER_DIRS
static final java.lang.String 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:
- Constant Field Values
-
-
Method Detail
-
handleRequest
boolean handleRequest(RESTRequest request, RESTResponse response) throws java.io.IOException
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:
java.io.IOException
-
registeredKeys
java.util.Iterator<java.lang.String> 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.
-
-