Package com.google.gerrit.server.restapi.change

Class GetDetail

java.lang.Object

com.google.gerrit.server.restapi.change.GetDetail

All Implemented Interfaces:

RestReadView<ChangeResource>, RestView<ChangeResource>, DynamicOptions.BeanReceiver

public class GetDetail
extends Object
implements RestReadView<ChangeResource>, DynamicOptions.BeanReceiver

Method Summary

Modifier and Type	Method	Description
Response<ChangeInfo>	apply(ChangeResource rsrc)	Process the view operation by reading from the resource.
Class<? extends DynamicOptions.BeanReceiver>	getExportedBeanReceiver()	Returns the class that should be used for looking up exported DynamicBean bindings from plugins.
void	setDynamicBean(String plugin, DynamicOptions.DynamicBean dynamicBean)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

setDynamicBean

public void setDynamicBean(String plugin,
 DynamicOptions.DynamicBean dynamicBean)

Specified by:

setDynamicBean in interface DynamicOptions.BeanReceiver

getExportedBeanReceiver

public Class<? extends DynamicOptions.BeanReceiver> getExportedBeanReceiver()

Description copied from interface: DynamicOptions.BeanReceiver

Returns the class that should be used for looking up exported DynamicBean bindings from plugins. Override when a particular REST/SSH endpoint should respect DynamicBeans bound on a different endpoint. For example, GetDetail is just a synonym for a variant of GetChange, and it should respect any DynamicBeans on GetChange. GetChange}. So it should return GetChange.class from this method.

Specified by:

getExportedBeanReceiver in interface DynamicOptions.BeanReceiver

apply

public Response<ChangeInfo> apply(ChangeResource rsrc)
                           throws RestApiException

Description copied from interface: RestReadView

Process the view operation by reading from the resource.

The value of the returned response is automatically converted to JSON unless it is a BinaryResult.

The returned response defines the status code that is returned to the client. For RestReadViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. Response.Redirect can be returned for 302 Found).

Throwing a subclass of RestApiException results in a 4XX response to the client. For any other exception the client will get a 500 Internal Server Error response.

Specified by:

apply in interface RestReadView<ChangeResource>

Parameters:

rsrc - resource to read

Returns:

response to return to the client

Throws:

AuthException - the caller is not permitted to access this view.

BadRequestException - the request was incorrectly specified and cannot be handled by this view.

ResourceConflictException - the resource state does not permit this view to make the changes at this time.

RestApiException