Package com.github.ambry.rest

Interface Summary

Interface	Description
BlobStorageService	BlobStorageService defines a service that forms the bridge b/w a RESTful frontend and a storage backend (or something that communicates with a storage backend).
BlobStorageServiceFactory	BlobStorageServiceFactory is a factory to generate all the supporting cast required to instantiate a BlobStorageService.
NioServer	Represents a NIO (non blocking I/O) server.
NioServerFactory	NioServerFactory is a factory to generate all the supporting cast required to instantiate a NioServer.
RestRequest	RestRequest represents a HTTP request as a generic object that can be understood by all the layers in a RESTful frontend.
RestRequestHandler	Meant to be the component that handles and routes all incoming requests.
RestRequestHandlerFactory	RestRequestHandlerFactory is a factory to generate all the supporting cast required to instantiate a RestRequestHandler.
RestResponseChannel	The RestResponseChannel is meant to provide a NioServer implementation independent way to return responses to the client.
RestResponseHandler	Meant to be the component that handles and routes all outgoing responses.
RestResponseHandlerFactory	RestResponseHandlerFactory is a factory to generate all the supporting cast required to instantiate a RestResponseHandler.

Class Summary

Class	Description
RequestPath
RestRequestMetrics	A metrics object that is provided as input to RestRequestMetricsTracker.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 a RestRequest.
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 a RestServiceException.
RestUtils.SubResource	Permitted sub-resources of a blob.

Exception Summary

Exception	Description
RestServiceException	Exceptions thrown by different layers of the RESTful frontend.