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

Class Submit

java.lang.Object

com.google.gerrit.server.restapi.change.Submit

All Implemented Interfaces:

RestModifyView<RevisionResource,SubmitInput>, RestView<RevisionResource>, UiAction<RevisionResource>

public class Submit
extends Object
implements RestModifyView<RevisionResource,SubmitInput>, UiAction<RevisionResource>

REST API handler for triggering submit of the specific revision of the change.

See /Documentation/rest-api-changes.html#submit-revision for more information.

Even though the endpoint is defined for url including a revision, only revision corresponding to the latest patch set is allowed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Submit.CurrentRevision	Change-level REST API endpoint that calls submit for the latest revision on a change.

Nested classes/interfaces inherited from interface com.google.gerrit.extensions.webui.UiAction

UiAction.Description

Method Summary

Modifier and Type	Method	Description
Response<ChangeInfo>	apply(RevisionResource rsrc, SubmitInput input)	Process the view operation by altering the resource.
UiAction.Description	getDescription(RevisionResource resource)	Get the description of the action customized for the resource.
Collection<ChangeData>	getUnmergeableChanges(ChangeSet cs)
Change	mergeChange(RevisionResource rsrc, IdentifiedUser submitter, SubmitInput input)

Methods inherited from class java.lang.Object

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

Method Details

apply

public Response<ChangeInfo> apply(RevisionResource rsrc,
 SubmitInput input)
                           throws RestApiException,
org.eclipse.jgit.errors.RepositoryNotFoundException,
IOException,
PermissionBackendException,
UpdateException,
org.eclipse.jgit.errors.ConfigInvalidException

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<RevisionResource,SubmitInput>

Parameters:

rsrc - resource to modify

input - input after parsing from request

Returns:

response to return to the client

Throws:

RestApiException

org.eclipse.jgit.errors.RepositoryNotFoundException

IOException

PermissionBackendException

UpdateException

org.eclipse.jgit.errors.ConfigInvalidException

mergeChange

public Change mergeChange(RevisionResource rsrc,
 IdentifiedUser submitter,
 SubmitInput input)
                   throws RestApiException,
IOException,
UpdateException,
org.eclipse.jgit.errors.ConfigInvalidException,
PermissionBackendException

Throws:

RestApiException

IOException

UpdateException

org.eclipse.jgit.errors.ConfigInvalidException

PermissionBackendException

getDescription

public UiAction.Description getDescription(RevisionResource resource)
                                    throws IOException,
PermissionBackendException

Description copied from interface: UiAction

Get the description of the action customized for the resource.

Specified by:

getDescription in interface UiAction<RevisionResource>

Parameters:

resource - the resource the view would act upon if the action is invoked by the client. Information from the resource can be used to customize the description.

Returns:

a description of the action. The server will populate the id and method properties. If null the action will assumed unavailable and not presented. This is usually the same as setVisible(false).

Throws:

IOException

PermissionBackendException

getUnmergeableChanges

public Collection<ChangeData> getUnmergeableChanges(ChangeSet cs)
                                             throws IOException

Throws:

IOException