org.apache.nifi.web.api

Class ProvenanceResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.ProvenanceResource

public class ProvenanceResource
extends ApplicationResource

RESTful endpoint for querying data provenance.

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteLineage(javax.servlet.http.HttpServletRequest httpServletRequest, ClientIdParameter clientId, String clusterNodeId, String id) Deletes the lineage with the specified id.
javax.ws.rs.core.Response	deleteProvenance(javax.servlet.http.HttpServletRequest httpServletRequest, ClientIdParameter clientId, String clusterNodeId, String id) Deletes the provenance with the specified id.
javax.ws.rs.core.Response	getInputContent(ClientIdParameter clientId, String clusterNodeId, LongParameter id) Gets the content for the input of the specified event.
javax.ws.rs.core.Response	getLineage(ClientIdParameter clientId, String clusterNodeId, String id) Gets the lineage with the specified id.
javax.ws.rs.core.Response	getOutputContent(ClientIdParameter clientId, String clusterNodeId, LongParameter id) Gets the content for the output of the specified event.
javax.ws.rs.core.Response	getProvenance(ClientIdParameter clientId, String clusterNodeId, String id) Gets the provenance with the specified id.
javax.ws.rs.core.Response	getProvenanceEvent(ClientIdParameter clientId, String clusterNodeId, LongParameter id) Gets the details for a provenance event.
javax.ws.rs.core.Response	getSearchOptions(ClientIdParameter clientId) Gets the provenance search options for this NiFi.
private LineageDTO	populateRemainingLineageContent(LineageDTO lineage) Populates the uri for the specified lineage.
private ProvenanceDTO	populateRemainingProvenanceContent(ProvenanceDTO provenance) Populates the uri for the specified provenance.
void	setClusterManager(WebClusterManager clusterManager)
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	submitLineageRequest(javax.servlet.http.HttpServletRequest httpServletRequest, ClientIdParameter clientId, String lineageRequest, LongParameter eventId, String uuid, String clusterNodeId) Submits a lineage request based on an event or a flowfile uuid.
javax.ws.rs.core.Response	submitLineageRequest(javax.servlet.http.HttpServletRequest httpServletRequest, LineageEntity lineageEntity) Submits a lineage request based on an event or a flowfile uuid.
javax.ws.rs.core.Response	submitProvenanceRequest(javax.servlet.http.HttpServletRequest httpServletRequest, ClientIdParameter clientId, DateTimeParameter startDate, DateTimeParameter endDate, String minimumFileSize, String maximumFileSize, IntegerParameter maxResults, String clusterNodeId, javax.ws.rs.core.MultivaluedMap<String,String> formParams) Creates provenance using the specified query criteria.
javax.ws.rs.core.Response	submitProvenanceRequest(javax.servlet.http.HttpServletRequest httpServletRequest, ProvenanceEntity provenanceEntity) Creates provenance using the specified query criteria.
javax.ws.rs.core.Response	submitReplay(javax.servlet.http.HttpServletRequest httpServletRequest, ClientIdParameter clientId, String clusterNodeId, LongParameter eventId) Creates a new replay request for the content associated with the specified provenance event id.

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

MAX_MAX_RESULTS

private static final int MAX_MAX_RESULTS

See Also:

Constant Field Values

properties

private NiFiProperties properties

serviceFacade

private NiFiServiceFacade serviceFacade

clusterManager

private WebClusterManager clusterManager

Constructor Detail

ProvenanceResource

public ProvenanceResource()

Method Detail

populateRemainingProvenanceContent

private ProvenanceDTO populateRemainingProvenanceContent(ProvenanceDTO provenance)

Populates the uri for the specified provenance.

populateRemainingLineageContent

private LineageDTO populateRemainingLineageContent(LineageDTO lineage)

Populates the uri for the specified lineage.

getSearchOptions

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

Gets the provenance search options 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 provenanceOptionsEntity

submitReplay

@PreAuthorize(value="hasRole(\'ROLE_PROVENANCE\') and hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response submitReplay(@Context
                                                  javax.servlet.http.HttpServletRequest httpServletRequest,
                                                  ClientIdParameter clientId,
                                                  String clusterNodeId,
                                                  LongParameter eventId)

Creates a new replay request for the content associated with the specified provenance event id.

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.

clusterNodeId - The id of the node in the cluster that has the specified event. Required if clustered.

eventId - The provenance event id.

Returns:

A provenanceEventEntity

getInputContent

@PreAuthorize(value="hasRole(\'ROLE_PROVENANCE\')")
public javax.ws.rs.core.Response getInputContent(ClientIdParameter clientId,
                                                     String clusterNodeId,
                                                     LongParameter id)

Gets the content for the input of the specified event.

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.

clusterNodeId - The id of the node within the cluster this content is on. Required if clustered.

id - The id of the provenance event associated with this content.

Returns:

The content stream

getOutputContent

@PreAuthorize(value="hasRole(\'ROLE_PROVENANCE\')")
public javax.ws.rs.core.Response getOutputContent(ClientIdParameter clientId,
                                                      String clusterNodeId,
                                                      LongParameter id)

Gets the content for the output of the specified event.

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.

clusterNodeId - The id of the node within the cluster this content is on. Required if clustered.

id - The id of the provenance event associated with this content.

Returns:

The content stream

submitProvenanceRequest

@PreAuthorize(value="hasRole(\'ROLE_PROVENANCE\')")
public javax.ws.rs.core.Response submitProvenanceRequest(@Context
                                                             javax.servlet.http.HttpServletRequest httpServletRequest,
                                                             ClientIdParameter clientId,
                                                             DateTimeParameter startDate,
                                                             DateTimeParameter endDate,
                                                             String minimumFileSize,
                                                             String maximumFileSize,
                                                             IntegerParameter maxResults,
                                                             String clusterNodeId,
                                                             javax.ws.rs.core.MultivaluedMap<String,String> formParams)

Creates provenance using the specified query criteria.

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.

startDate - The start date.

endDate - The end date.

minimumFileSize - The minimum size of the content after the event.

maximumFileSize - The maximum size of the content after the event.

maxResults - The maximum number of results to return.

clusterNodeId - The id of node in the cluster to search. This is optional and only relevant when clustered. If clustered and it is not specified the entire cluster is searched.

formParams - Additionally, the search parameters are specified in the form parameters. Because the search parameters differ based on configuration they are specified in a map-like fashion:

• search[filename]=myFile.txt
• search[eventType]=RECEIVED

Returns:

A provenanceEntity

submitProvenanceRequest

@PreAuthorize(value="hasRole(\'ROLE_PROVENANCE\')")
public javax.ws.rs.core.Response submitProvenanceRequest(@Context
                                                             javax.servlet.http.HttpServletRequest httpServletRequest,
                                                             ProvenanceEntity provenanceEntity)

Creates provenance using the specified query criteria.

Parameters:

httpServletRequest -

provenanceEntity - A provenanceEntity

Returns:

A provenanceEntity

getProvenance

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

Gets the provenance with the specified id.

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 provenance

clusterNodeId - The id of node in the cluster to search. This is optional and only relevant when clustered. If clustered and it is not specified the entire cluster is searched.

Returns:

A provenanceEntity

deleteProvenance

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

Deletes the provenance with the specified id.

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 provenance

clusterNodeId - The id of node in the cluster to search. This is optional and only relevant when clustered. If clustered and it is not specified the entire cluster is searched.

Returns:

A provenanceEntity

getProvenanceEvent

@PreAuthorize(value="hasRole(\'ROLE_PROVENANCE\')")
public javax.ws.rs.core.Response getProvenanceEvent(ClientIdParameter clientId,
                                                        String clusterNodeId,
                                                        LongParameter id)

Gets the details for a provenance event.

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 event

clusterNodeId - The id of node in the cluster that the event/flowfile originated from. This is only required when clustered.

Returns:

A provenanceEventEntity

submitLineageRequest

@PreAuthorize(value="hasRole(\'ROLE_PROVENANCE\')")
public javax.ws.rs.core.Response submitLineageRequest(@Context
                                                          javax.servlet.http.HttpServletRequest httpServletRequest,
                                                          ClientIdParameter clientId,
                                                          String lineageRequest,
                                                          LongParameter eventId,
                                                          String uuid,
                                                          String clusterNodeId)

Submits a lineage request based on an event or a flowfile uuid. When querying for the lineage of an event you must specify the eventId and the eventDirection. The eventDirection must be 'parents' or 'children' and specifies whether we are going up or down the flowfile ancestry. The uuid cannot be specified in these cases. When querying for the lineage of a flowfile you must specify the uuid. The eventId and eventDirection cannot be specified in this case.

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.

eventId - The id of an event to get the lineage for. Must also specify the eventDirection and not the uuid.

lineageRequest - Either 'PARENTS', 'CHILDREN', or 'FLOWFILE'. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage of for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.

uuid - The uuid of the flowfile to get the lineage for. Must not specify the eventId or eventDirection.

clusterNodeId - The id of node in the cluster that the event/flowfile originated from. This is only required when clustered.

Returns:

A lineageEntity

submitLineageRequest

@PreAuthorize(value="hasRole(\'ROLE_PROVENANCE\')")
public javax.ws.rs.core.Response submitLineageRequest(@Context
                                                          javax.servlet.http.HttpServletRequest httpServletRequest,
                                                          LineageEntity lineageEntity)

Submits a lineage request based on an event or a flowfile uuid. When querying for the lineage of an event you must specify the eventId and the eventDirection. The eventDirection must be 'parents' or 'children' and specifies whether we are going up or down the flowfile ancestry. The uuid cannot be specified in these cases. When querying for the lineage of a flowfile you must specify the uuid. The eventId and eventDirection cannot be specified in this case.

Parameters:

httpServletRequest -

lineageEntity - A lineageEntity

Returns:

A lineageEntity

getLineage

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

Gets the lineage with the specified id.

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.

clusterNodeId - The id of node in the cluster that the event/flowfile originated from. This is only required when clustered.

id - The id of the lineage

Returns:

A lineageEntity

deleteLineage

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

Deletes the lineage with the specified id.

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.

clusterNodeId - The id of node in the cluster that the event/flowfile originated from. This is only required when clustered.

id - The id of the lineage

Returns:

A lineageEntity

setClusterManager

public void setClusterManager(WebClusterManager clusterManager)

setProperties

public void setProperties(NiFiProperties properties)

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)