org.apache.nifi.web.api

Class HistoryResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.HistoryResource

public class HistoryResource
extends ApplicationResource

RESTful endpoint for querying the history of this Controller.

Field Summary

Fields

Modifier and Type	Field and Description
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
HistoryResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteHistory(ClientIdParameter clientId, DateTimeParameter endDate) Deletes flow history from the specified end date.
javax.ws.rs.core.Response	getAction(ClientIdParameter clientId, IntegerParameter id) Gets the action for the corresponding id.
javax.ws.rs.core.Response	getProcessorHistory(ClientIdParameter clientId, String processorId) Gets the actions for the specified processor.
javax.ws.rs.core.Response	queryHistory(ClientIdParameter clientId, IntegerParameter offset, IntegerParameter count, String sortColumn, String sortOrder, DateTimeParameter startDate, DateTimeParameter endDate, String userName, String sourceId) Queries the history of this Controller.
void	setServiceFacade(NiFiServiceFacade serviceFacade)

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

Constructor Detail

HistoryResource

public HistoryResource()

Method Detail

queryHistory

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response queryHistory(ClientIdParameter clientId,
                                                  IntegerParameter offset,
                                                  IntegerParameter count,
                                                  String sortColumn,
                                                  String sortOrder,
                                                  DateTimeParameter startDate,
                                                  DateTimeParameter endDate,
                                                  String userName,
                                                  String sourceId)

Queries the history of 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.

offset - The offset into the data. This parameter is required and is used in conjunction with count.

count - The number of rows that should be returned. This parameter is required and is used in conjunction with page.

sortColumn - The column to sort on. This parameter is optional. If not specified the results will be returned with the most recent first.

sortOrder - The sort order.

startDate - The start date/time for the query. The start date/time must be formatted as 'MM/dd/yyyy HH:mm:ss'. This parameter is optional and must be specified in the timezone of the server. The server's timezone can be determined by inspecting the result of a status or history request.

endDate - The end date/time for the query. The end date/time must be formatted as 'MM/dd/yyyy HH:mm:ss'. This parameter is optional and must be specified in the timezone of the server. The server's timezone can be determined by inspecting the result of a status or history request.

userName - The user name of the user who's actions are being queried. This parameter is optional.

sourceId - The id of the source being queried (usually a processor id). This parameter is optional.

Returns:

A historyEntity.

getAction

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

Gets the action for the corresponding 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 action to get.

Returns:

An actionEntity.

deleteHistory

@PreAuthorize(value="hasRole(\'ROLE_ADMIN\')")
public javax.ws.rs.core.Response deleteHistory(ClientIdParameter clientId,
                                                   DateTimeParameter endDate)

Deletes flow history from the specified end date.

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.

endDate - The end date for the purge action.

Returns:

A historyEntity

getProcessorHistory

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

Gets the actions for the specified processor.

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.

processorId - The id of the processor.

Returns:

An processorHistoryEntity.

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)