org.apache.nifi.web.api

Class ControllerResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.ControllerResource

public class ControllerResource
extends ApplicationResource

RESTful endpoint for managing a Flow Controller.

Field Summary

Fields

Modifier and Type	Field and Description
private WebClusterManager	clusterManager
private NiFiProperties	properties
private com.sun.jersey.api.core.ResourceContext	resourceContext
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
ControllerResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createArchive(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId) Creates a new archive of this flow controller.
javax.ws.rs.core.Response	getAboutInfo(ClientIdParameter clientId) Retrieves details about this NiFi to put in the About dialog.
javax.ws.rs.core.Response	getAuthorities(ClientIdParameter clientId) Retrieves the user details, including the authorities, about the user making the request.
javax.ws.rs.core.Response	getBanners(ClientIdParameter clientId) Retrieves the banners for this NiFi.
BulletinBoardResource	getBulletinBoardResource() Locates the History sub-resource.
javax.ws.rs.core.Response	getController(ClientIdParameter clientId) Returns the details of this NiFi.
javax.ws.rs.core.Response	getControllerConfig(ClientIdParameter clientId) Retrieves the configuration for this NiFi.
javax.ws.rs.core.Response	getControllerHead() Returns a 200 OK response to indicate this is a valid controller endpoint.
javax.ws.rs.core.Response	getControllerStatus(ClientIdParameter clientId) Retrieves the status for this NiFi.
javax.ws.rs.core.Response	getCounters(ClientIdParameter clientId) Retrieves the counters report for this NiFi.
ProcessGroupResource	getGroupResource(String groupId) Locates the Group sub-resource.
HistoryResource	getHistoryResource() Locates the History sub-resource.
javax.ws.rs.core.Response	getPrioritizers(ClientIdParameter clientId) Retrieves the types of prioritizers that this NiFi supports.
javax.ws.rs.core.Response	getProcessorTypes(ClientIdParameter clientId) Retrieves the types of processors that this NiFi supports.
ProvenanceResource	getProvenanceResource() Locates the Provenance sub-resource.
javax.ws.rs.core.Response	getRevision() Gets current revision of this NiFi.
SnippetResource	getSnippetResource() Locates the Template sub-resource.
TemplateResource	getTemplateResource() Locates the Template sub-resource.
UserGroupResource	getUserGroupResource() Locates the User sub-resource.
UserResource	getUserResource() Locates the User sub-resource.
javax.ws.rs.core.Response	searchController(String value) Performs a search request for this controller.
void	setClusterManager(WebClusterManager clusterManager)
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateControllerConfig(javax.servlet.http.HttpServletRequest httpServletRequest, ControllerConfigurationEntity configEntity) Update the configuration for this NiFi.
javax.ws.rs.core.Response	updateControllerConfig(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String name, String comments, IntegerParameter maxTimerDrivenThreadCount, IntegerParameter maxEventDrivenThreadCount) Update the configuration for this NiFi.
javax.ws.rs.core.Response	updateCounter(javax.servlet.http.HttpServletRequest httpServletRequest, ClientIdParameter clientId, String id) Update the specified counter.

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

serviceFacade

private NiFiServiceFacade serviceFacade

clusterManager

private WebClusterManager clusterManager

properties

private NiFiProperties properties

resourceContext

@Context
private com.sun.jersey.api.core.ResourceContext resourceContext

Constructor Detail

ControllerResource

public ControllerResource()

Method Detail

getProvenanceResource

public ProvenanceResource getProvenanceResource()

Locates the Provenance sub-resource.

Returns:

getUserResource

public UserResource getUserResource()

Locates the User sub-resource.

Returns:

getUserGroupResource

public UserGroupResource getUserGroupResource()

Locates the User sub-resource.

Returns:

getHistoryResource

public HistoryResource getHistoryResource()

Locates the History sub-resource.

Returns:

getBulletinBoardResource

public BulletinBoardResource getBulletinBoardResource()

Locates the History sub-resource.

Returns:

getTemplateResource

public TemplateResource getTemplateResource()

Locates the Template sub-resource.

Returns:

getSnippetResource

public SnippetResource getSnippetResource()

Locates the Template sub-resource.

Returns:

getGroupResource

public ProcessGroupResource getGroupResource(String groupId)

Locates the Group sub-resource.

Parameters:

groupId - The process group id

Returns:

getControllerHead

public javax.ws.rs.core.Response getControllerHead()

Returns a 200 OK response to indicate this is a valid controller endpoint.

Returns:

An OK response with an empty entity body.

getController

@PreAuthorize(value="hasRole(\'ROLE_NIFI\')")
public javax.ws.rs.core.Response getController(ClientIdParameter clientId)

Returns the details of this NiFi.

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.

Returns:

A controllerEntity.

searchController

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

Performs a search request for this controller.

Parameters:

value - Search string

Returns:

A searchResultsEntity

createArchive

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response createArchive(@Context
                                                   javax.servlet.http.HttpServletRequest httpServletRequest,
                                                   LongParameter version,
                                                   ClientIdParameter clientId)

Creates a new archive of this flow controller. Note, this is a POST operation that returns a URI that is not representative of the thing that was actually created. The archive that is created cannot be referenced at a later time, therefore there is no corresponding URI. Instead the request URI is returned. Alternatively, we could have performed a PUT request. However, PUT requests are supposed to be idempotent and this endpoint is certainly not.

Parameters:

httpServletRequest -

version - The revision is used to verify the client is working with the latest version of the flow.

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

getRevision

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

Gets current revision of this NiFi.

Returns:

A revisionEntity

getControllerStatus

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getControllerStatus(ClientIdParameter clientId)

Retrieves the status for this NiFi.

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.

Returns:

A controllerStatusEntity.

getCounters

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getCounters(ClientIdParameter clientId)

Retrieves the counters report for this NiFi.

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.

Returns:

A countersEntity.

updateCounter

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

Update the specified counter. This will reset the counter value to 0.

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

Returns:

A counterEntity.

getControllerConfig

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\', \'ROLE_NIFI\')")
public javax.ws.rs.core.Response getControllerConfig(ClientIdParameter clientId)

Retrieves the configuration for this NiFi.

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.

Returns:

A controllerConfigurationEntity.

updateControllerConfig

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateControllerConfig(@Context
                                                            javax.servlet.http.HttpServletRequest httpServletRequest,
                                                            LongParameter version,
                                                            ClientIdParameter clientId,
                                                            String name,
                                                            String comments,
                                                            IntegerParameter maxTimerDrivenThreadCount,
                                                            IntegerParameter maxEventDrivenThreadCount)

Update the configuration for this NiFi.

Parameters:

httpServletRequest -

version - The revision is used to verify the client is working with the latest version of the flow.

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.

name - The name of this controller.

comments - The comments of this controller.

maxTimerDrivenThreadCount - The maximum number of timer driven threads this controller has available.

maxEventDrivenThreadCount - The maximum number of timer driven threads this controller has available.

Returns:

A controllerConfigurationEntity.

updateControllerConfig

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateControllerConfig(@Context
                                                            javax.servlet.http.HttpServletRequest httpServletRequest,
                                                            ControllerConfigurationEntity configEntity)

Update the configuration for this NiFi.

Parameters:

httpServletRequest -

configEntity - A controllerConfigurationEntity.

Returns:

A controllerConfigurationEntity.

getAuthorities

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getAuthorities(ClientIdParameter clientId)

Retrieves the user details, including the authorities, about the user making the request.

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.

Returns:

A authoritiesEntity.

getBanners

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getBanners(ClientIdParameter clientId)

Retrieves the banners for this NiFi.

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.

Returns:

A bannerEntity.

getProcessorTypes

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getProcessorTypes(ClientIdParameter clientId)

Retrieves the types of processors that this NiFi supports.

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.

Returns:

A processorTypesEntity.

getPrioritizers

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getPrioritizers(ClientIdParameter clientId)

Retrieves the types of prioritizers that this NiFi supports.

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.

Returns:

A prioritizerTypesEntity.

getAboutInfo

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getAboutInfo(ClientIdParameter clientId)

Retrieves details about this NiFi to put in the About dialog.

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.

Returns:

An aboutEntity.

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setClusterManager

public void setClusterManager(WebClusterManager clusterManager)

setProperties

public void setProperties(NiFiProperties properties)