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

Class CheckSubmitRequirement

java.lang.Object

com.google.gerrit.server.restapi.change.CheckSubmitRequirement

All Implemented Interfaces:

RestModifyView<ChangeResource,SubmitRequirementInput>, RestView<ChangeResource>

public class CheckSubmitRequirement
extends Object
implements RestModifyView<ChangeResource,SubmitRequirementInput>

A rest view to evaluate (test) a SubmitRequirement on a given change. The submit requirement can be supplied in one of two ways:

1) Using the SubmitRequirementInput.

2) From a change to the RefNames.REFS_CONFIG branch and the name of the submit-requirement.

Constructor Summary

Constructors

Constructor	Description
CheckSubmitRequirement(SubmitRequirementsEvaluator evaluator, GitRepositoryManager repoManager, ProjectConfig.Factory projectConfigFactory, ChangeData.Factory changeDataFactory, ChangeNotes.Factory changeNotesFactory, ChangesCollection changesCollection)

Method Summary

Modifier and Type	Method	Description
Response<SubmitRequirementResultInfo>	apply(ChangeResource resource, SubmitRequirementInput input)	Process the view operation by altering the resource.
void	setRefsConfigChangeId(String refsConfigChangeId)
void	setSrName(String srName)

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckSubmitRequirement

@Inject
public CheckSubmitRequirement(SubmitRequirementsEvaluator evaluator,
                              GitRepositoryManager repoManager,
                              ProjectConfig.Factory projectConfigFactory,
                              ChangeData.Factory changeDataFactory,
                              ChangeNotes.Factory changeNotesFactory,
                              ChangesCollection changesCollection)

Method Detail

setSrName

public void setSrName(String srName)

setRefsConfigChangeId

public void setRefsConfigChangeId(String refsConfigChangeId)

apply

public Response<SubmitRequirementResultInfo> apply(ChangeResource resource,
                                                   SubmitRequirementInput input)
                                            throws IOException,
                                                   PermissionBackendException,
                                                   RestApiException

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<ChangeResource,SubmitRequirementInput>

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.

IOException

PermissionBackendException

RestApiException