org.apache.nifi.web.api

Class UserResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.UserResource

public class UserResource
extends ApplicationResource

RESTful endpoint for managing this Controller's users.

Field Summary

Fields

Modifier and Type	Field and Description
private WebClusterManager	clusterManager
private NiFiProperties	properties
private NiFiServiceFacade	serviceFacade

Fields inherited from class org.apache.nifi.web.api.ApplicationResource

CLIENT_ID, CLUSTER_CONTEXT_HTTP_HEADER, PROXIED_ENTITIES_CHAIN_HTTP_HEADER, PROXIED_ENTITY_USER_DETAILS_HTTP_HEADER, PROXY_CONTEXT_PATH_HTTP_HEADER, PROXY_HOST_HTTP_HEADER, PROXY_PORT_HTTP_HEADER, PROXY_SCHEME_HTTP_HEADER, VERSION

Constructor Summary

Constructors

Constructor and Description
UserResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteUser(javax.servlet.http.HttpServletRequest httpServletRequest, String id, ClientIdParameter clientId) Deletes the specified user.
javax.ws.rs.core.Response	getUser(ClientIdParameter clientId, String id) Gets the details for the specified user.
javax.ws.rs.core.Response	getUsers(ClientIdParameter clientId, Boolean grouped) Gets all users that are registered within this Controller.
javax.ws.rs.core.Response	searchUsers(String value) Searches for users with match the specified query.
void	setClusterManager(WebClusterManager clusterManager)
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateUser(javax.servlet.http.HttpServletRequest httpServletRequest, ClientIdParameter clientId, String id, Set<String> rawAuthorities, String status, javax.ws.rs.core.MultivaluedMap<String,String> formParams) Updates the specified user.
javax.ws.rs.core.Response	updateUser(javax.servlet.http.HttpServletRequest httpServletRequest, String id, UserEntity userEntity) Updates the specified user.

Methods inherited from class org.apache.nifi.web.api.ApplicationResource

clusterContext, generateContinueResponse, generateCreatedResponse, generateOkResponse, generateOkResponse, generateResourceUri, getAbsolutePath, getClusterContextFromRequest, getHeaders, getHeaders, getRequestParameters, getRequestParameters, noCache, updateClientId

Methods inherited from class java.lang.Object

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

Field Detail

clusterManager

private WebClusterManager clusterManager

properties

private NiFiProperties properties

serviceFacade

private NiFiServiceFacade serviceFacade

Constructor Detail

UserResource

public UserResource()

Method Detail

getUsers

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getUsers(ClientIdParameter clientId,
                                              Boolean grouped)

Gets all users that are registered within this Controller.

Parameters:

clientId - Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

grouped - Whether to return the users in their groups.

Returns:

A usersEntity.

getUser

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getUser(ClientIdParameter clientId,
                                             String id)

Gets the details for the specified user.

Parameters:

clientId - Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

id - The user id.

Returns:

A userEntity.

searchUsers

@PreAuthorize(value="hasAnyRole(\'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response searchUsers(String value)

Searches for users with match the specified query.

Parameters:

value - Search value that will be matched against users

Returns:

A userSearchResultsEntity

updateUser

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
public javax.ws.rs.core.Response updateUser(@Context
                                                javax.servlet.http.HttpServletRequest httpServletRequest,
                                                ClientIdParameter clientId,
                                                String id,
                                                Set<String> rawAuthorities,
                                                String status,
                                                javax.ws.rs.core.MultivaluedMap<String,String> formParams)

Updates the specified user.

Parameters:

httpServletRequest -

clientId - Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

id - The id of the user to update.

rawAuthorities - Array of authorities to assign to the specified user.

status - The status of the specified users account.

formParams -

Returns:

A userEntity

updateUser

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
public javax.ws.rs.core.Response updateUser(@Context
                                                javax.servlet.http.HttpServletRequest httpServletRequest,
                                                String id,
                                                UserEntity userEntity)

Updates the specified user.

Parameters:

httpServletRequest -

id - The id of the user to update.

userEntity - A userEntity

Returns:

A userEntity

deleteUser

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
public javax.ws.rs.core.Response deleteUser(@Context
                                                javax.servlet.http.HttpServletRequest httpServletRequest,
                                                String id,
                                                ClientIdParameter clientId)

Deletes the specified user.

Parameters:

httpServletRequest -

id - The user id

clientId - Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

Returns:

A userEntity.

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setProperties

public void setProperties(NiFiProperties properties)

setClusterManager

public void setClusterManager(WebClusterManager clusterManager)