Package com.github.ambry.rest
-
Interface Summary Interface Description NioServer Represents a NIO (non blocking I/O) server.NioServerFactory NioServerFactory is a factory to generate all the supporting cast required to instantiate aNioServer
.RestRequest RestRequest represents a HTTP request as a generic object that can be understood by all the layers in a RESTful frontend.RestRequest.RestRequestContext The RestRequestContext that carries some of the internal states of different implementation.RestRequestHandler Meant to be the component that handles and routes all incoming requests.RestRequestResponseHandlerFactory RestRequestResponseHandlerFactory is a factory to generate all the supporting cast required to instantiateRestRequestHandler
andRestResponseHandler
.RestRequestService RestRequestService defines a service that handlesRestRequest
.RestRequestServiceFactory RestRequestServiceFactory is a factory to generate all the supporting cast required to instantiate aRestRequestService
.RestResponseChannel The RestResponseChannel is meant to provide aNioServer
implementation independent way to return responses to the client.RestResponseHandler Meant to be the component that handles and routes all outgoing responses. -
Class Summary Class Description RequestPath RestRequestMetrics A metrics object that is provided as input toRestRequestMetricsTracker.injectMetrics(RestRequestMetrics)
.RestRequestMetricsTracker Construct to support end-to-end metrics tracking based on request type.RestRequestMetricsTracker.NioMetricsTracker Tracker for updating NIO related metrics.RestRequestMetricsTracker.ScalingMetricsTracker Helper for updating scaling related metrics.RestUtils Common utility functions that will be used across implementations of REST interfaces.RestUtils.Headers Ambry specific HTTP headers.RestUtils.InternalKeys Ambry specific keys used internally in aRestRequest
.RestUtils.MultipartPost RestUtils.TrackingHeaders -
Enum Summary Enum Description ResponseStatus All the REST response statuses.RestMethod Generic equivalents of HTTP methods truncated to ones that Ambry supports.RestServiceErrorCode All the error codes that accompany aRestServiceException
.RestUtils.SubResource Permitted sub-resources of a blob. -
Exception Summary Exception Description RestServiceException Exceptions thrown by different layers of the RESTful frontend.