org.apache.nifi.web.api

Class FunnelResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.FunnelResource

public class FunnelResource
extends ApplicationResource

RESTful endpoint for managing a Funnel.

Field Summary

Fields

Modifier and Type	Field and Description
private WebClusterManager	clusterManager
private String	groupId
private static org.slf4j.Logger	logger
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
FunnelResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createFunnel(javax.servlet.http.HttpServletRequest httpServletRequest, FunnelEntity funnelEntity) Creates a new Funnel.
javax.ws.rs.core.Response	createFunnel(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, DoubleParameter x, DoubleParameter y) Creates a new funnel.
javax.ws.rs.core.Response	getFunnel(ClientIdParameter clientId, String id) Retrieves the specified funnel.
javax.ws.rs.core.Response	getFunnels(ClientIdParameter clientId) Retrieves all the of funnels in this NiFi.
private FunnelDTO	populateRemainingFunnelContent(FunnelDTO funnel) Populates the uri for the specified funnel.
Set<FunnelDTO>	populateRemainingFunnelsContent(Set<FunnelDTO> funnels) Populates the uri for the specified funnels.
javax.ws.rs.core.Response	removeFunnel(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id) Removes the specified funnel.
void	setClusterManager(WebClusterManager clusterManager)
void	setGroupId(String groupId)
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateFunnel(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id, String parentGroupId, DoubleParameter x, DoubleParameter y) Updates the specified funnel.
javax.ws.rs.core.Response	updateFunnel(javax.servlet.http.HttpServletRequest httpServletRequest, String id, FunnelEntity funnelEntity) Creates a new Funnel.

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

logger

private static final org.slf4j.Logger logger

serviceFacade

private NiFiServiceFacade serviceFacade

clusterManager

private WebClusterManager clusterManager

properties

private NiFiProperties properties

groupId

private String groupId

Constructor Detail

FunnelResource

public FunnelResource()

Method Detail

populateRemainingFunnelsContent

public Set<FunnelDTO> populateRemainingFunnelsContent(Set<FunnelDTO> funnels)

Populates the uri for the specified funnels.

Parameters:

funnels -

Returns:

populateRemainingFunnelContent

private FunnelDTO populateRemainingFunnelContent(FunnelDTO funnel)

Populates the uri for the specified funnel.

getFunnels

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

Retrieves all the of funnels in 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 funnelsEntity.

createFunnel

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

Creates a new funnel.

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.

x - The x coordinate for this funnels position.

y - The y coordinate for this funnels position.

Returns:

A funnelEntity.

createFunnel

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

Creates a new Funnel.

Parameters:

httpServletRequest -

funnelEntity - A funnelEntity.

Returns:

A funnelEntity.

getFunnel

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

Retrieves the specified funnel.

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 id of the funnel to retrieve

Returns:

A funnelEntity.

updateFunnel

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateFunnel(@Context
                                                  javax.servlet.http.HttpServletRequest httpServletRequest,
                                                  LongParameter version,
                                                  ClientIdParameter clientId,
                                                  String id,
                                                  String parentGroupId,
                                                  DoubleParameter x,
                                                  DoubleParameter y)

Updates the specified funnel.

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.

id - The id of the funnel to update.

parentGroupId - The id of the process group to move this funnel to.

x - The x coordinate for this funnels position.

y - The y coordinate for this funnels position.

Returns:

A funnelEntity.

updateFunnel

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateFunnel(@Context
                                                  javax.servlet.http.HttpServletRequest httpServletRequest,
                                                  String id,
                                                  FunnelEntity funnelEntity)

Creates a new Funnel.

Parameters:

httpServletRequest -

id - The id of the funnel to update.

funnelEntity - A funnelEntity.

Returns:

A funnelEntity.

removeFunnel

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

Removes the specified funnel.

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.

id - The id of the funnel to remove.

Returns:

A entity containing the client id and an updated revision.

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setGroupId

public void setGroupId(String groupId)

setClusterManager

public void setClusterManager(WebClusterManager clusterManager)

setProperties

public void setProperties(NiFiProperties properties)