Package com.google.gerrit.extensions.restapi

Interface Summary

Interface	Description
ChildCollection<P extends RestResource,C extends RestResource>	Nested collection of RestResources below a parent.
ETagView<R extends RestResource>	A view which may change, although the underlying resource did not change
NeedsParams	Optional interface for RestCollection.
RawInput	Raw data stream supplied by the body of a PUT or POST.
RestCollection<P extends RestResource,R extends RestResource>	A collection of resources accessible through a REST API.
RestCollectionCreateView<P extends RestResource,C extends RestResource,I>	RestView that supports accepting input and creating a resource.
RestCollectionDeleteMissingView<P extends RestResource,C extends RestResource,I>	RestView that supports accepting input and deleting a resource that is missing.
RestCollectionModifyView<P extends RestResource,C extends RestResource,I>	RestView on a RestCollection that supports accepting input.
RestCollectionView<P extends RestResource,C extends RestResource,I>	Any type of view on RestCollection, see RestCollectionModifyView for updates and deletes and RestCollectionCreateView for member creation.
RestModifyView<R extends RestResource,I>	RestView that supports accepting input and changing a resource.
RestReadView<R extends RestResource>	RestView to read a resource without modification.
RestResource	Generic resource handle defining arguments to views.
RestResource.HasETag	A resource with an ETag.
RestResource.HasLastModified	A resource with a last modification date.
RestView<R extends RestResource>	Any type of view, see RestReadView for reads, RestModifyView for updates, and RestCollection for nested collections.

Class Summary

Class	Description
BinaryResult	Wrapper around a non-JSON result from a RestView.
CacheControl
IdString	Resource identifier split out from a URL.
Response<T>	Special return value to mean specific HTTP status codes in a REST API.
Response.Accepted	Accepted as task for asynchronous execution.
Response.Redirect	An HTTP redirect to another location.
RestApiModule	Guice DSL for binding RestView implementations.
RestApiModule.ChildCollectionBinder<P extends RestResource>
RestApiModule.CreateViewBinder<C extends RestResource>
RestApiModule.DeleteViewBinder<C extends RestResource>
RestApiModule.ModifyViewBinder<P extends RestResource>
RestApiModule.ReadViewBinder<P extends RestResource>
RestApiModule.RestCollectionViewBinder<C extends RestResource>
TopLevelResource	Special marker resource naming the top-level of a REST space.
Url	URL related utility functions.

Enum Summary

Enum	Description
CacheControl.Type

Exception Summary

Exception	Description
AuthException	Caller cannot perform the request operation (HTTP 403 Forbidden).
BadRequestException	Request could not be parsed as sent (HTTP 400 Bad Request).
MergeConflictException	Indicates that a commit cannot be merged without conflicts.
MethodNotAllowedException	Method is not acceptable on the resource (HTTP 405 Method Not Allowed).
NotImplementedException	Method is not implemented in currently used implementation.
PreconditionFailedException	Resource state does not match request state (HTTP 412 Precondition failed).
ResourceConflictException	Resource state does not permit requested operation (HTTP 409 Conflict).
ResourceNotFoundException	Named resource does not exist (HTTP 404 Not Found).
RestApiException	Root exception type for REST API failures.
UnprocessableEntityException	Resource referenced in the request body is not found (HTTP 422 Unprocessable Entity).

Annotation Types Summary

Annotation Type	Description
DefaultInput	Applied to a String field to indicate the default input parameter.