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

Class DeleteChangeMessage

java.lang.Object

com.google.gerrit.server.restapi.change.DeleteChangeMessage

All Implemented Interfaces:

RestModifyView<ChangeMessageResource,DeleteChangeMessageInput>, RestView<ChangeMessageResource>

public class DeleteChangeMessage
extends Object
implements RestModifyView<ChangeMessageResource,DeleteChangeMessageInput>

Deletes a change message by rewriting history.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteChangeMessage.DefaultDeleteChangeMessage

Constructor Summary

Constructors

Constructor	Description
DeleteChangeMessage(com.google.inject.Provider<CurrentUser> userProvider, PermissionBackend permissionBackend, BatchUpdate.Factory updateFactory, ChangeMessagesUtil changeMessagesUtil, AccountLoader.Factory accountLoaderFactory, ChangeNotes.Factory notesFactory)

Method Summary

Modifier and Type	Method	Description
Response<ChangeMessageInfo>	apply(ChangeMessageResource resource, DeleteChangeMessageInput input)	Process the view operation by altering the resource.
static String	createNewChangeMessage(Account.Id deletedBy)
static String	createNewChangeMessage(Account.Id deletedBy, String deletedReason)

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteChangeMessage

@Inject
public DeleteChangeMessage(com.google.inject.Provider<CurrentUser> userProvider,
                           PermissionBackend permissionBackend,
                           BatchUpdate.Factory updateFactory,
                           ChangeMessagesUtil changeMessagesUtil,
                           AccountLoader.Factory accountLoaderFactory,
                           ChangeNotes.Factory notesFactory)

Method Detail

apply

public Response<ChangeMessageInfo> apply(ChangeMessageResource resource,
                                         DeleteChangeMessageInput input)
                                  throws RestApiException,
                                         PermissionBackendException,
                                         UpdateException,
                                         IOException

Description copied from interface: RestModifyView

Process the view operation by altering 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 RestModifyViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. 202 Accepted if a background task was scheduled, 204 No Content if no content is returned, 302 Found for a redirect).

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 RestModifyView<ChangeMessageResource,DeleteChangeMessageInput>

Parameters:

resource - resource to modify

input - input after parsing from request

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

PermissionBackendException

UpdateException

IOException

createNewChangeMessage

public static String createNewChangeMessage(Account.Id deletedBy,
                                            String deletedReason)

createNewChangeMessage

public static String createNewChangeMessage(Account.Id deletedBy)