com.google.gerrit.extensions.restapi

Interface RestModifyView<R extends RestResource,I>

Type Parameters:

R - type of the resource the view modifies.

I - type of input the JSON parser will parse the input into.

All Superinterfaces:

RestView<R>

All Known Implementing Classes:

Abandon, AddMembers, AddSshKey, AddSubgroups, ApplyFix, BanCommit, ChangeEdits.Create, ChangeEdits.DeleteContent, ChangeEdits.DeleteFile, ChangeEdits.EditMessage, ChangeEdits.Post, ChangeEdits.Put, Check, CheckAccess, CheckConsistency, CherryPick, CherryPickCommit, ConfirmEmail, CreateAccessChange, CreateAccount, CreateBranch, CreateChange, CreateDraftComment, CreateEmail, CreateGroup, CreateMergePatchSet, CreateProject, CreateTag, DeleteActive, DeleteAssignee, DeleteBranch, DeleteBranches, DeleteChange, DeleteChangeEdit, DeleteComment, DeleteDraftComment, DeleteEmail, DeleteExternalIds, DeleteMembers, DeletePrivate, DeletePrivateByPost, DeleteReviewer, DeleteSshKey, DeleteSubgroups, DeleteTag, DeleteTags, DeleteTask, DeleteVote, DeleteWatchedProjects, DisablePlugin, EnablePlugin, FlushCache, GarbageCollect, Ignore, Index, Index, Index, Index, InstallPlugin, MarkAsReviewed, MarkAsUnreviewed, Move, PostCaches, PostHashtags, PostPrivate, PostReview, PostReviewers, PostWatchedProjects, PublishChangeEdit.Publish, PutAccount, PutActive, PutAgreement, PutAssignee, PutBranch, PutConfig, PutDescription, PutDescription, PutDescription, PutDraftComment, PutEmail, PutGroup, PutHttpPassword, PutMessage, PutName, PutName, PutOptions, PutOwner, PutPreferred, PutProject, PutStatus, PutTag, PutTopic, PutUsername, Rebase, Rebase.CurrentRevision, RebaseChangeEdit.Rebase, Rebuild, ReloadPlugin, Restore, RetryingRestModifyView, Revert, Reviewed.DeleteReviewed, Reviewed.PutReviewed, SetAccess, SetDashboard, SetDiffPreferences, SetDiffPreferences, SetEditPreferences, SetHead, SetParent, SetPreferences, SetPreferences, SetReadyForReview, SetWorkInProgress, StarredChanges.Create, StarredChanges.Delete, Stars.Post, Submit, Submit.CurrentRevision, TestSubmitRule, TestSubmitType, Unignore

public interface RestModifyView<R extends RestResource,I>
extends RestView<R>

RestView that supports accepting input and changing a resource.

The input must be supplied as JSON as the body of the HTTP request. Modify views can be invoked by any HTTP method that is not GET, which includes POST, PUT, DELETE.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(R resource, I input) Process the view operation by altering the resource.

Method Detail

apply

java.lang.Object apply(R resource,
                       I input)
                throws AuthException,
                       BadRequestException,
                       ResourceConflictException,
                       java.lang.Exception

Process the view operation by altering the resource.

Parameters:

resource - resource to modify.

input - input after parsing from request.

Returns:

result to return to the client. Use BinaryResult to avoid automatic conversion to JSON.

Throws:

AuthException - the client 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.

java.lang.Exception - the implementation of the view failed. The exception will be logged and HTTP 500 Internal Server Error will be returned to the client.