org.apache.ambari.server.api.services

Class UserService

java.lang.Object

org.apache.ambari.server.api.services.BaseService

org.apache.ambari.server.api.services.UserService

public class UserService
extends BaseService

Service responsible for user requests.

Constructor Summary

Constructors

Constructor and Description
UserService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createUser(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String userName) Creates a user.
javax.ws.rs.core.Response	deleteUser(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String userName) Deletes a user.
javax.ws.rs.core.Response	getUser(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String userName) Gets a single user.
javax.ws.rs.core.Response	getUsers(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Gets all users.
javax.ws.rs.core.Response	updateUser(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String userName) Updates a specific user.

Methods inherited from class org.apache.ambari.server.api.services.BaseService

getBodyParser, getResultSerializer, handleRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

UserService

public UserService()

Method Detail

getUsers

public javax.ws.rs.core.Response getUsers(@Context
                                          javax.ws.rs.core.HttpHeaders headers,
                                          @Context
                                          javax.ws.rs.core.UriInfo ui)

Gets all users. Handles: GET /users requests.

getUser

public javax.ws.rs.core.Response getUser(@Context
                                         javax.ws.rs.core.HttpHeaders headers,
                                         @Context
                                         javax.ws.rs.core.UriInfo ui,
                                         String userName)

Gets a single user. Handles: GET /users/{username} requests

Parameters:

headers - http headers

ui - uri info

userName - the username

Returns:

information regarding the created user

createUser

public javax.ws.rs.core.Response createUser(String body,
                                            @Context
                                            javax.ws.rs.core.HttpHeaders headers,
                                            @Context
                                            javax.ws.rs.core.UriInfo ui,
                                            String userName)

Creates a user. Handles: POST /users/{userName}

Parameters:

headers - http headers

ui - uri info

userName - the username

Returns:

information regarding the created user

updateUser

public javax.ws.rs.core.Response updateUser(String body,
                                            @Context
                                            javax.ws.rs.core.HttpHeaders headers,
                                            @Context
                                            javax.ws.rs.core.UriInfo ui,
                                            String userName)

Updates a specific user. Handles: PUT /users/{userName}

Parameters:

headers - http headers

ui - uri info

userName - the username

Returns:

information regarding the updated user

deleteUser

public javax.ws.rs.core.Response deleteUser(@Context
                                            javax.ws.rs.core.HttpHeaders headers,
                                            @Context
                                            javax.ws.rs.core.UriInfo ui,
                                            String userName)

Deletes a user. Handles: DELETE /users/{userName}