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

Class PutUsername

java.lang.Object

com.google.gerrit.server.restapi.account.PutUsername

All Implemented Interfaces:

RestModifyView<AccountResource,UsernameInput>, RestView<AccountResource>

public class PutUsername
extends Object
implements RestModifyView<AccountResource,UsernameInput>

REST endpoint to set the username of an account.

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

Whether a username can be set depends on whether the used Realm supports this.

Once set a username cannot be changed or deleted. Changing usernames is disallowed because they can be used in ref names that represent user-specific sandbox branches which can exist in any repository and we have no way to find and rename those refs.

Method Summary

Modifier and Type	Method	Description
Response<String>	apply(AccountResource rsrc, UsernameInput 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,
                              UsernameInput input)
                       throws RestApiException,
                              IOException,
                              org.eclipse.jgit.errors.ConfigInvalidException,
                              PermissionBackendException

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,UsernameInput>

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.

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

IOException

org.eclipse.jgit.errors.ConfigInvalidException

PermissionBackendException