Package com.google.gerrit.server.restapi.account

Class PutDisplayName

java.lang.Object

com.google.gerrit.server.restapi.account.PutDisplayName

All Implemented Interfaces:

RestModifyView<AccountResource,DisplayNameInput>, RestView<AccountResource>

public class PutDisplayName
extends Object
implements RestModifyView<AccountResource,DisplayNameInput>

REST endpoint to set the display name of an account.

This REST endpoint handles PUT /accounts/<account-identifier>/displayname requests.

The display name is a free-form text that a user can set for their own account. It defines how the user's name will be rendered in the UI in most screens. It is optional, and if not set, then the UI falls back to whatever is configured as the default display name, e.g. the full name.

Method Summary

Modifier and Type	Method	Description
Response<String>	apply(AccountResource rsrc, DisplayNameInput input)	Process the view operation by altering the resource.

Methods inherited from class java.lang.Object

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

Method Detail

apply

public Response<String> apply(AccountResource rsrc,
                              DisplayNameInput input)
                       throws AuthException,
                              ResourceNotFoundException,
                              IOException,
                              PermissionBackendException,
                              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<AccountResource,DisplayNameInput>

Parameters:

rsrc - 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.

ResourceNotFoundException

IOException

PermissionBackendException

org.eclipse.jgit.errors.ConfigInvalidException