org.apache.nifi.web.api

Class UserGroupResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.UserGroupResource

public class UserGroupResource
extends ApplicationResource

RESTful endpoint for managing this Controller's user groups.

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
UserGroupResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	removeUserFromGroup(javax.servlet.http.HttpServletRequest httpServletRequest, String group, String userId, ClientIdParameter clientId) Deletes the user from the specified group.
void	setClusterManager(WebClusterManager clusterManager)
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	ungroup(javax.servlet.http.HttpServletRequest httpServletRequest, String group, ClientIdParameter clientId) Deletes the user group.
javax.ws.rs.core.Response	updateUserGroup(javax.servlet.http.HttpServletRequest httpServletRequest, String group, ClientIdParameter clientId, Set<String> userIds, Set<String> rawAuthorities, String status, javax.ws.rs.core.MultivaluedMap<String,String> formParams) Updates a new user group.
javax.ws.rs.core.Response	updateUserGroup(javax.servlet.http.HttpServletRequest httpServletRequest, String group, UserGroupEntity userGroupEntity) Creates a new user group with the specified users.

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

UserGroupResource

public UserGroupResource()

Method Detail

updateUserGroup

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

Updates a new user group.

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.

userIds - A collection of user ids to include in this group. If a user already belongs to another group, they will be placed in this group instead. Existing users in this group will remain in this group.

group - The name of the group.

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

status - The status of the specified users account.

formParams -

Returns:

A userGroupEntity.

updateUserGroup

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
public javax.ws.rs.core.Response updateUserGroup(@Context
                                                     javax.servlet.http.HttpServletRequest httpServletRequest,
                                                     String group,
                                                     UserGroupEntity userGroupEntity)

Creates a new user group with the specified users.

Parameters:

httpServletRequest -

group - The user group.

userGroupEntity - A userGroupEntity.

Returns:

A userGroupEntity.

removeUserFromGroup

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

Deletes the user from the specified group. The user will not be removed, just the fact that they were in this group.

Parameters:

httpServletRequest -

group - The user group.

userId - The user id to remove.

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

ungroup

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

Deletes the user group. The users will not be removed, just the fact that they were grouped.

Parameters:

httpServletRequest -

group - The user group.

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

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setProperties

public void setProperties(NiFiProperties properties)

setClusterManager

public void setClusterManager(WebClusterManager clusterManager)