public interface NiFiServiceFacade
Modifier and Type | Method and Description |
---|---|
ActivateControllerServicesEntity |
activateControllerServices(NiFiUser user,
java.lang.String processGroupId,
ControllerServiceState state,
java.util.Map<java.lang.String,Revision> serviceRevisions)
Enables or disables the controller services with the given IDs & Revisions on behalf of the given user
|
ActivateControllerServicesEntity |
activateControllerServices(java.lang.String processGroupId,
ControllerServiceState state,
java.util.Map<java.lang.String,Revision> serviceRevisions)
Enables or disables the controller services with the given IDs & Revisions on behalf of the currently logged in user
|
void |
authorizeAccess(AuthorizeAccess authorizeAccess)
Authorizes access to the service facade.
|
void |
clearControllerServiceState(java.lang.String controllerServiceId)
Clears the state for the specified controller service.
|
void |
clearProcessorState(java.lang.String processorId)
Clears the state for the specified processor.
|
void |
clearReportingTaskState(java.lang.String reportingTaskId)
Clears the state for the specified reporting task.
|
FlowEntity |
copySnippet(java.lang.String groupId,
java.lang.String snippetId,
java.lang.Double originX,
java.lang.Double originY,
java.lang.String idGenerationSeed)
Creates a new snippet based off the existing snippet.
|
AccessPolicyEntity |
createAccessPolicy(Revision revision,
AccessPolicyDTO accessPolicyDTO)
Creates an access policy.
|
BulletinEntity |
createBulletin(BulletinDTO bulletinDTO,
java.lang.Boolean canRead)
Create a system bulletin
|
ConnectionEntity |
createConnection(Revision revision,
java.lang.String groupId,
ConnectionDTO connectionDTO)
Creates a new Relationship target.
|
ControllerServiceEntity |
createControllerService(Revision revision,
java.lang.String groupId,
ControllerServiceDTO controllerServiceDTO)
Creates a controller service.
|
DropRequestDTO |
createFlowFileDropRequest(java.lang.String connectionId,
java.lang.String dropRequestId)
Creates a new flow file drop request.
|
ListingRequestDTO |
createFlowFileListingRequest(java.lang.String connectionId,
java.lang.String listingRequestId)
Creates a new flow file listing request.
|
FunnelEntity |
createFunnel(Revision revision,
java.lang.String groupId,
FunnelDTO funnelDTO)
Creates a funnel.
|
PortEntity |
createInputPort(Revision revision,
java.lang.String groupId,
PortDTO inputPortDTO)
Creates a new input port.
|
LabelEntity |
createLabel(Revision revision,
java.lang.String groupId,
LabelDTO labelDTO)
Creates a label.
|
PortEntity |
createOutputPort(Revision revision,
java.lang.String groupId,
PortDTO outputPortDTO)
Creates a new output port.
|
ProcessGroupEntity |
createProcessGroup(Revision revision,
java.lang.String parentGroupId,
ProcessGroupDTO processGroupDTO)
Creates a new process group.
|
ProcessorEntity |
createProcessor(Revision revision,
java.lang.String groupId,
ProcessorDTO processorDTO)
Creates a new Processor.
|
RemoteProcessGroupEntity |
createRemoteProcessGroup(Revision revision,
java.lang.String groupId,
RemoteProcessGroupDTO remoteProcessGroupDTO)
Creates a new remote process group.
|
ReportingTaskEntity |
createReportingTask(Revision revision,
ReportingTaskDTO reportingTaskDTO)
Creates a reporting task.
|
SnippetEntity |
createSnippet(SnippetDTO snippet)
Creates a new snippet.
|
TemplateDTO |
createTemplate(java.lang.String name,
java.lang.String description,
java.lang.String snippetId,
java.lang.String groupId,
java.util.Optional<java.lang.String> idGenerationSeed)
Creates a new Template based off the specified snippet.
|
FlowEntity |
createTemplateInstance(java.lang.String groupId,
java.lang.Double originX,
java.lang.Double originY,
java.lang.String templateEncodingVersion,
FlowSnippetDTO snippet,
java.lang.String idGenerationSeed)
Instantiate the corresponding template.
|
UserEntity |
createUser(Revision revision,
UserDTO userDTO)
Creates a user.
|
UserGroupEntity |
createUserGroup(Revision revision,
UserGroupDTO userGroupDTO)
Creates a user group.
|
AccessPolicyEntity |
deleteAccessPolicy(Revision revision,
java.lang.String accessPolicyId)
Deletes the specified access policy.
|
void |
deleteActions(java.util.Date endDate)
Purges all actions up to the specified end date.
|
ConnectionEntity |
deleteConnection(Revision revision,
java.lang.String connectionId)
Deletes the specified relationship target.
|
ControllerServiceEntity |
deleteControllerService(Revision revision,
java.lang.String controllerServiceId)
Deletes the specified label.
|
DropRequestDTO |
deleteFlowFileDropRequest(java.lang.String connectionId,
java.lang.String dropRequestId)
Cancels/removes the specified flow file drop request.
|
ListingRequestDTO |
deleteFlowFileListingRequest(java.lang.String connectionId,
java.lang.String listingRequestId)
Deletes a new flow file listing request.
|
FunnelEntity |
deleteFunnel(Revision revision,
java.lang.String funnelId)
Deletes the specified funnel.
|
PortEntity |
deleteInputPort(Revision revision,
java.lang.String inputPortId)
Deletes the specified input port.
|
LabelEntity |
deleteLabel(Revision revision,
java.lang.String labelId)
Deletes the specified label.
|
void |
deleteLineage(java.lang.String lineageId)
Deletes the lineage with the specified id.
|
void |
deleteNode(java.lang.String nodeId)
Deletes the node.
|
PortEntity |
deleteOutputPort(Revision revision,
java.lang.String outputPortId)
Determines if the output port could be deleted.
|
ProcessGroupEntity |
deleteProcessGroup(Revision revision,
java.lang.String groupId)
Deletes the specified process group.
|
ProcessorEntity |
deleteProcessor(Revision revision,
java.lang.String processorId)
Deletes the specified processor.
|
void |
deleteProvenance(java.lang.String queryId)
Deletes provenance.
|
RemoteProcessGroupEntity |
deleteRemoteProcessGroup(Revision revision,
java.lang.String remoteProcessGroupId)
Deletes the specified remote process group.
|
ReportingTaskEntity |
deleteReportingTask(Revision revision,
java.lang.String reportingTaskId)
Deletes the specified reporting task.
|
SnippetEntity |
deleteSnippet(java.util.Set<Revision> revisions,
java.lang.String snippetId)
Removes the specified snippet.
|
void |
deleteTemplate(java.lang.String id)
Deletes the specified template.
|
UserEntity |
deleteUser(Revision revision,
java.lang.String userId)
Deletes the specified user.
|
UserGroupEntity |
deleteUserGroup(Revision revision,
java.lang.String userGroupId)
Deletes the specified user group.
|
TemplateDTO |
exportTemplate(java.lang.String id)
Gets the template, includes contents, with the specified id.
|
AccessPolicyEntity |
getAccessPolicy(RequestAction requestAction,
java.lang.String resource)
Gets the access policy for the specified action, resource type, and component id.
|
AccessPolicyEntity |
getAccessPolicy(java.lang.String accessPolicyId)
Gets the access policy with the specified ID.
|
ActionEntity |
getAction(java.lang.Integer actionId)
Returns the details for the specified action id.
|
HistoryDTO |
getActions(HistoryQueryDTO historyQuery)
Returns actions that meet the specified criteria.
|
java.util.Set<AffectedComponentDTO> |
getActiveComponentsAffectedByVariableRegistryUpdate(VariableRegistryDTO variableRegistryDto)
Determines which components are active and will be affected by updating the given Variable Registry.
|
BulletinBoardDTO |
getBulletinBoard(BulletinQueryDTO query) |
ClusterDTO |
getCluster() |
ComponentHistoryDTO |
getComponentHistory(java.lang.String componentId)
Gets the history for the specified property for the specified component.
|
java.util.Set<AffectedComponentEntity> |
getComponentsAffectedByVariableRegistryUpdate(VariableRegistryDTO variableRegistryDto)
Determines which components will be affected by updating the given Variable Registry.
|
ConnectionEntity |
getConnection(java.lang.String connectionId)
Gets the specified Connection transfer object.
|
java.util.Set<ConnectionEntity> |
getConnections(java.lang.String groupId)
Gets the Connection transfer objects for the specified source processor.
|
ConnectionStatusEntity |
getConnectionStatus(java.lang.String connectionId)
Gets the status of the specified connection.
|
StatusHistoryEntity |
getConnectionStatusHistory(java.lang.String connectionId)
Gets the status history of the specified connection.
|
DownloadableContent |
getContent(java.lang.Long eventId,
java.lang.String uri,
ContentDirection contentDirection)
Gets the content for the specified claim.
|
DownloadableContent |
getContent(java.lang.String connectionId,
java.lang.String flowfileUuid,
java.lang.String uri)
Gets the content for the specified flowfile in the specified connection.
|
ControllerBulletinsEntity |
getControllerBulletins()
Gets the controller level bulletins.
|
ControllerConfigurationEntity |
getControllerConfiguration()
Gets the configuration for this controller.
|
ControllerServiceEntity |
getControllerService(java.lang.String controllerServiceId)
Gets the specified controller service.
|
PropertyDescriptorDTO |
getControllerServicePropertyDescriptor(java.lang.String id,
java.lang.String property)
Get the descriptor for the specified property of the specified controller service.
|
ControllerServiceReferencingComponentsEntity |
getControllerServiceReferencingComponents(java.lang.String controllerServiceId)
Gets the references for specified controller service.
|
java.util.Set<ControllerServiceEntity> |
getControllerServices(java.lang.String groupId,
boolean includeAncestorGroups,
boolean includeDescendantGroups)
Gets all controller services that belong to the given group and its parent/ancestor groups
|
java.util.Set<ControllerServiceEntity> |
getControllerServices(java.lang.String groupId,
boolean includeAncestorGroups,
boolean includeDescendantGroups,
NiFiUser user)
Gets all controller services that belong to the given group and its parent/ancestor groups
|
ComponentStateDTO |
getControllerServiceState(java.lang.String controllerServiceId)
Gets the state for the specified controller service.
|
java.util.Set<DocumentedTypeDTO> |
getControllerServiceTypes(java.lang.String serviceType,
java.lang.String serviceBundleGroup,
java.lang.String serviceBundleArtifact,
java.lang.String serviceBundleVersion,
java.lang.String bundleGroupFilter,
java.lang.String bundleArtifactFilter,
java.lang.String typeFilter)
Returns the list of controller service types.
|
ControllerStatusDTO |
getControllerStatus()
Returns the controller status.
|
CountersDTO |
getCounters()
Returns the counters.
|
CurrentUserEntity |
getCurrentUser() |
FlowConfigurationEntity |
getFlowConfiguration()
Gets the configuration for the flow.
|
FlowFileDTO |
getFlowFile(java.lang.String connectionId,
java.lang.String flowFileUuid)
Gets the specified flowfile from the specified connection.
|
DropRequestDTO |
getFlowFileDropRequest(java.lang.String connectionId,
java.lang.String dropRequestId)
Gets the specified flow file drop request.
|
ListingRequestDTO |
getFlowFileListingRequest(java.lang.String connectionId,
java.lang.String listingRequestId)
Gets a new flow file listing request.
|
FunnelEntity |
getFunnel(java.lang.String funnelId)
Gets the specified funnel.
|
java.util.Set<FunnelEntity> |
getFunnels(java.lang.String groupId)
Gets all of the funnels.
|
PortEntity |
getInputPort(java.lang.String inputPortId)
Gets an input port.
|
java.util.Set<PortEntity> |
getInputPorts(java.lang.String groupId)
Gets all input ports in a given group.
|
PortStatusEntity |
getInputPortStatus(java.lang.String inputPortId)
Gets the input port status.
|
LabelEntity |
getLabel(java.lang.String labelId)
Gets the specified label.
|
java.util.Set<LabelEntity> |
getLabels(java.lang.String groupId)
Gets all of the labels.
|
LineageDTO |
getLineage(java.lang.String lineageId)
Gets the lineage with the specified id.
|
NodeDTO |
getNode(java.lang.String nodeId)
Returns the contents of the node.
|
java.lang.String |
getNodeId() |
PortEntity |
getOutputPort(java.lang.String outputPortId)
Gets an output port.
|
java.util.Set<PortEntity> |
getOutputPorts(java.lang.String groupId)
Gets all output ports in a given group.
|
PortStatusEntity |
getOutputPortStatus(java.lang.String outputPortId)
Gets the output port status.
|
ProcessGroupEntity |
getProcessGroup(java.lang.String groupId)
Returns the process group.
|
ProcessGroupFlowEntity |
getProcessGroupFlow(java.lang.String groupId)
Returns the flow.
|
java.util.Set<ProcessGroupEntity> |
getProcessGroups(java.lang.String parentGroupId)
Gets all process groups in the specified parent group.
|
ProcessGroupStatusEntity |
getProcessGroupStatus(java.lang.String groupId,
boolean recursive)
Returns the process group status.
|
StatusHistoryEntity |
getProcessGroupStatusHistory(java.lang.String groupId)
Gets the process group status history.
|
ProcessorEntity |
getProcessor(java.lang.String id)
Gets the Processor transfer object for the specified id.
|
PropertyDescriptorDTO |
getProcessorPropertyDescriptor(java.lang.String id,
java.lang.String property)
Get the descriptor for the specified property of the specified processor.
|
java.util.Set<ProcessorEntity> |
getProcessors(java.lang.String groupId,
boolean includeDescendants)
Gets all the Processor transfer objects for this controller.
|
ComponentStateDTO |
getProcessorState(java.lang.String processorId)
Gets the state for the specified processor.
|
ProcessorStatusEntity |
getProcessorStatus(java.lang.String id)
Gets the processor status.
|
StatusHistoryEntity |
getProcessorStatusHistory(java.lang.String id)
Gets the processor status history.
|
java.util.Set<DocumentedTypeDTO> |
getProcessorTypes(java.lang.String bundleGroupFilter,
java.lang.String bundleArtifactFilter,
java.lang.String typeFilter)
Returns the list of processor types.
|
ProvenanceDTO |
getProvenance(java.lang.String queryId,
java.lang.Boolean summarize,
java.lang.Boolean incrementalResults)
Retrieves provenance.
|
ProvenanceEventDTO |
getProvenanceEvent(java.lang.Long id)
Gets the provenance event with the specified id.
|
ProvenanceOptionsDTO |
getProvenanceSearchOptions()
Returns the available options for searching provenance.
|
RemoteProcessGroupEntity |
getRemoteProcessGroup(java.lang.String remoteProcessGroupId)
Gets a remote process group.
|
java.util.Set<RemoteProcessGroupEntity> |
getRemoteProcessGroups(java.lang.String groupId)
Gets all remote process groups in the a given parent group.
|
RemoteProcessGroupStatusEntity |
getRemoteProcessGroupStatus(java.lang.String id)
Gets the remote process group status.
|
StatusHistoryEntity |
getRemoteProcessGroupStatusHistory(java.lang.String id)
Gets the remote process group status history.
|
ReportingTaskEntity |
getReportingTask(java.lang.String reportingTaskId)
Gets the specified reporting task.
|
PropertyDescriptorDTO |
getReportingTaskPropertyDescriptor(java.lang.String id,
java.lang.String property)
Get the descriptor for the specified property of the specified reporting task.
|
java.util.Set<ReportingTaskEntity> |
getReportingTasks()
Gets all reporting tasks.
|
ComponentStateDTO |
getReportingTaskState(java.lang.String reportingTaskId)
Gets the state for the specified reporting task.
|
java.util.Set<DocumentedTypeDTO> |
getReportingTaskTypes(java.lang.String bundleGroupFilter,
java.lang.String bundleArtifactFilter,
java.lang.String typeFilter)
Returns the list of reporting task types.
|
java.util.List<ResourceDTO> |
getResources() |
java.util.Set<Revision> |
getRevisionsFromGroup(java.lang.String groupId,
java.util.function.Function<ProcessGroup,java.util.Set<java.lang.String>> getComponents)
Gets the current revisions for the components based on the specified function.
|
java.util.Set<Revision> |
getRevisionsFromSnippet(java.lang.String snippetId)
Gets the revisions from the specified snippet.
|
ControllerDTO |
getSiteToSiteDetails() |
SystemDiagnosticsDTO |
getSystemDiagnostics() |
TemplateDTO |
getTemplate(java.lang.String id)
Gets the template with the specified id.
|
java.util.Set<TemplateEntity> |
getTemplates()
Gets all templates.
|
UserEntity |
getUser(java.lang.String userId)
Gets the user with the specified ID.
|
UserGroupEntity |
getUserGroup(java.lang.String userGroupId)
Gets the user group with the specified ID.
|
java.util.Set<UserGroupEntity> |
getUserGroups()
Gets all user groups.
|
java.util.Set<UserEntity> |
getUsers()
Gets all the users.
|
VariableRegistryEntity |
getVariableRegistry(java.lang.String groupId,
boolean includeAncestorGroups)
Returns the Variable Registry for the Process Group with the given ID
|
java.util.Set<DocumentedTypeDTO> |
getWorkQueuePrioritizerTypes()
Returns the list of prioritizer types.
|
TemplateDTO |
importTemplate(TemplateDTO templateDTO,
java.lang.String groupId,
java.util.Optional<java.lang.String> idGenerationSeed)
Imports the specified Template.
|
boolean |
isClustered() |
VariableRegistryEntity |
populateAffectedComponents(VariableRegistryDTO variableRegistryDto)
Returns a Variable Registry that includes the variables in the given DTO but has the affected components populated
|
ScheduleComponentsEntity |
scheduleComponents(NiFiUser user,
java.lang.String processGroupId,
ScheduledState state,
java.util.Map<java.lang.String,Revision> componentRevisions)
Schedules all applicable components under the specified ProcessGroup on behalf of the given user.
|
ScheduleComponentsEntity |
scheduleComponents(java.lang.String processGroupId,
ScheduledState state,
java.util.Map<java.lang.String,Revision> componentRevisions)
Schedules all applicable components under the specified ProcessGroup on behalf of the currently logged in user.
|
SearchResultsDTO |
searchController(java.lang.String query)
Searches the controller for the specified query string.
|
LineageDTO |
submitLineage(LineageDTO lineage)
Submits a lineage request.
|
ProvenanceDTO |
submitProvenance(ProvenanceDTO query)
Submits a provenance request.
|
ProvenanceEventDTO |
submitReplay(java.lang.Long eventId)
Submits a new replay request.
|
AccessPolicyEntity |
updateAccessPolicy(Revision revision,
AccessPolicyDTO accessPolicyDTO)
Updates the specified access policy.
|
ConnectionEntity |
updateConnection(Revision revision,
ConnectionDTO connectionDTO)
Updates the specified Relationship target.
|
ControllerConfigurationEntity |
updateControllerConfiguration(Revision revision,
ControllerConfigurationDTO controllerConfigurationDTO)
Updates the configuration for this controller.
|
ControllerServiceEntity |
updateControllerService(Revision revision,
ControllerServiceDTO controllerServiceDTO)
Updates the specified controller service.
|
ControllerServiceReferencingComponentsEntity |
updateControllerServiceReferencingComponents(java.util.Map<java.lang.String,Revision> referenceRevisions,
java.lang.String controllerServiceId,
ScheduledState scheduledState,
ControllerServiceState controllerServiceState)
Updates the referencing components for the specified controller service.
|
CounterDTO |
updateCounter(java.lang.String counterId)
Updates the specified counter by setting its value to 0.
|
FunnelEntity |
updateFunnel(Revision revision,
FunnelDTO funnelDTO)
Updates the specified funnel.
|
PortEntity |
updateInputPort(Revision revision,
PortDTO inputPortDTO)
Updates the specified input port.
|
LabelEntity |
updateLabel(Revision revision,
LabelDTO labelDTO)
Updates the specified label.
|
NodeDTO |
updateNode(NodeDTO nodeDTO)
Updates the contents of the node.
|
PortEntity |
updateOutputPort(Revision revision,
PortDTO outputPortDTO)
Updates the specified output port.
|
ProcessGroupEntity |
updateProcessGroup(Revision revision,
ProcessGroupDTO processGroupDTO)
Updates the specified process group.
|
ProcessorEntity |
updateProcessor(Revision revision,
ProcessorDTO processorDTO)
Updates the specified Processor.
|
RemoteProcessGroupEntity |
updateRemoteProcessGroup(Revision revision,
RemoteProcessGroupDTO remoteProcessGroupDTO)
Updates the specified remote process group.
|
RemoteProcessGroupPortEntity |
updateRemoteProcessGroupInputPort(Revision revision,
java.lang.String remoteProcessGroupId,
RemoteProcessGroupPortDTO remoteProcessGroupPortDTO)
Updates the specified remote process groups input port.
|
RemoteProcessGroupPortEntity |
updateRemoteProcessGroupOutputPort(Revision revision,
java.lang.String remoteProcessGroupId,
RemoteProcessGroupPortDTO remoteProcessGroupPortDTO)
Updates the specified remote process groups output port.
|
ReportingTaskEntity |
updateReportingTask(Revision revision,
ReportingTaskDTO reportingTaskDTO)
Updates the specified reporting task.
|
SnippetEntity |
updateSnippet(java.util.Set<Revision> revisions,
SnippetDTO snippetDto)
If group id is specified, moves the specified snippet to the specified group.
|
UserEntity |
updateUser(Revision revision,
UserDTO userDTO)
Updates the specified user.
|
UserGroupEntity |
updateUserGroup(Revision revision,
UserGroupDTO userGroupDTO)
Updates the specified user group.
|
VariableRegistryEntity |
updateVariableRegistry(NiFiUser user,
Revision revision,
VariableRegistryDTO variableRegistryDto)
Updates the variable registry on behalf of the given user
|
VariableRegistryEntity |
updateVariableRegistry(Revision revision,
VariableRegistryDTO variableRegistryDto)
Updates the variable registry on behalf of the user currently logged in
|
void |
verifyActivateControllerServices(java.lang.String processGroupId,
ControllerServiceState state,
java.util.Set<java.lang.String> serviceIds)
Verifies the controller services with the given ID's can be enabled or disabled
|
void |
verifyCanAddTemplate(java.lang.String groupId,
java.lang.String name)
Verifies a template with the specified name can be created.
|
void |
verifyCanClearControllerServiceState(java.lang.String controllerServiceId)
Verifies the controller service state could be cleared.
|
void |
verifyCanClearProcessorState(java.lang.String processorId)
Verifies the processor state could be cleared.
|
void |
verifyCanClearReportingTaskState(java.lang.String reportingTaskId)
Verifies the reporting task state could be cleared.
|
void |
verifyComponentTypes(FlowSnippetDTO snippet)
Verifies the types of components in a template.
|
void |
verifyCreateConnection(java.lang.String groupId,
ConnectionDTO connectionDTO)
Determines if this connection can be created.
|
void |
verifyCreateControllerService(ControllerServiceDTO controllerServiceDTO)
Verifies the specified controller service can be created.
|
void |
verifyCreateProcessor(ProcessorDTO processorDTO)
Verifies the specified processor can be created.
|
void |
verifyCreateReportingTask(ReportingTaskDTO reportingTaskDTO)
Verifies the specified reporting task can be created.
|
void |
verifyDeleteConnection(java.lang.String connectionId)
Determines if this connection can be removed.
|
void |
verifyDeleteControllerService(java.lang.String controllerServiceId)
Verifies the specified controller service can be removed.
|
void |
verifyDeleteFunnel(java.lang.String funnelId)
Verifies the specified funnel can be deleted.
|
void |
verifyDeleteInputPort(java.lang.String inputPortId)
Determines if the input port could be deleted.
|
void |
verifyDeleteOutputPort(java.lang.String outputPortId)
Determines if the output port could be deleted.
|
void |
verifyDeleteProcessGroup(java.lang.String groupId)
Verifies the specified process group can be removed.
|
void |
verifyDeleteProcessor(java.lang.String processorId)
Verifies the specified processor can be removed.
|
void |
verifyDeleteRemoteProcessGroup(java.lang.String remoteProcessGroupId)
Verifies the remote process group can be deleted.
|
void |
verifyDeleteReportingTask(java.lang.String reportingTaskId)
Verifies the specified reporting task can be removed.
|
void |
verifyDeleteSnippet(java.lang.String id,
java.util.Set<java.lang.String> affectedComponentIds)
Determines if this snippet can be removed.
|
void |
verifyListQueue(java.lang.String connectionId)
Determines if this connection can be listed.
|
void |
verifyRevision(Revision revision,
NiFiUser user)
Claims the specified revision for the specified user.
|
void |
verifyRevisions(java.util.Set<Revision> revisions,
NiFiUser user)
Claims the specified revisions for the specified user.
|
void |
verifyScheduleComponents(java.lang.String processGroupId,
ScheduledState state,
java.util.Set<java.lang.String> componentIds)
Verifies the contents of the specified process group can be scheduled or unscheduled.
|
void |
verifyUpdateConnection(ConnectionDTO connectionDTO)
Determines if this connection can be updated.
|
void |
verifyUpdateControllerService(ControllerServiceDTO controllerServiceDTO)
Verifies the specified controller service can be updated.
|
void |
verifyUpdateControllerServiceReferencingComponents(java.lang.String controllerServiceId,
ScheduledState scheduledState,
ControllerServiceState controllerServiceState)
Verifies the referencing components of the specified controller service can be updated.
|
void |
verifyUpdateInputPort(PortDTO inputPortDTO)
Determines if the input port could be updated.
|
void |
verifyUpdateOutputPort(PortDTO outputPortDTO)
Determines if the output port could be updated.
|
void |
verifyUpdateProcessGroup(ProcessGroupDTO processGroupDTO)
Verifies that the Process Group identified by the given DTO can be updated in the manner appropriate according
to the DTO
|
void |
verifyUpdateProcessor(ProcessorDTO processorDTO)
Verifies the specified processor can be updated.
|
void |
verifyUpdateRemoteProcessGroup(RemoteProcessGroupDTO remoteProcessGroupDTO)
Verifies the specified remote process group can be updated.
|
void |
verifyUpdateRemoteProcessGroupInputPort(java.lang.String remoteProcessGroupId,
RemoteProcessGroupPortDTO remoteProcessGroupPortDTO)
Verifies the specified remote process group can update the specified remote input port.
|
void |
verifyUpdateRemoteProcessGroupOutputPort(java.lang.String remoteProcessGroupId,
RemoteProcessGroupPortDTO remoteProcessGroupPortDTO)
Verifies the specified remote process group can update the specified remote output port.
|
void |
verifyUpdateReportingTask(ReportingTaskDTO reportingTaskDTO)
Verifies the specified reporting task can be updated.
|
void |
verifyUpdateSnippet(SnippetDTO snippetDto,
java.util.Set<java.lang.String> affectedComponentIds)
Determines if this snippet can be updated.
|
void authorizeAccess(AuthorizeAccess authorizeAccess)
authorizeAccess
- authorize access callbackvoid verifyRevision(Revision revision, NiFiUser user) throws InvalidRevisionException
revision
- revisionuser
- userInvalidRevisionException
- invalid revisionvoid verifyRevisions(java.util.Set<Revision> revisions, NiFiUser user) throws InvalidRevisionException
revisions
- revisionsuser
- userInvalidRevisionException
- invalid revisionjava.util.Set<Revision> getRevisionsFromGroup(java.lang.String groupId, java.util.function.Function<ProcessGroup,java.util.Set<java.lang.String>> getComponents)
groupId
- groupgetComponents
- callbackjava.util.Set<Revision> getRevisionsFromSnippet(java.lang.String snippetId)
snippetId
- snippetControllerDTO getSiteToSiteDetails()
SearchResultsDTO searchController(java.lang.String query)
query
- queryProvenanceDTO submitProvenance(ProvenanceDTO query)
query
- queryProvenanceEventDTO submitReplay(java.lang.Long eventId)
eventId
- idDownloadableContent getContent(java.lang.Long eventId, java.lang.String uri, ContentDirection contentDirection)
eventId
- iduri
- uricontentDirection
- directionDownloadableContent getContent(java.lang.String connectionId, java.lang.String flowfileUuid, java.lang.String uri)
connectionId
- connectionflowfileUuid
- flowfileuri
- uriProvenanceDTO getProvenance(java.lang.String queryId, java.lang.Boolean summarize, java.lang.Boolean incrementalResults)
queryId
- identifiersummarize
- whether to summarize the event dtosincrementalResults
- whether to return any events if the search has not finishedvoid deleteProvenance(java.lang.String queryId)
queryId
- identifierProvenanceOptionsDTO getProvenanceSearchOptions()
LineageDTO submitLineage(LineageDTO lineage)
lineage
- lineageLineageDTO getLineage(java.lang.String lineageId)
lineageId
- idvoid deleteLineage(java.lang.String lineageId)
lineageId
- lineageProvenanceEventDTO getProvenanceEvent(java.lang.Long id)
id
- idControllerConfigurationEntity getControllerConfiguration()
ControllerBulletinsEntity getControllerBulletins()
FlowConfigurationEntity getFlowConfiguration()
ControllerConfigurationEntity updateControllerConfiguration(Revision revision, ControllerConfigurationDTO controllerConfigurationDTO)
revision
- Revision to compare with current base revisioncontrollerConfigurationDTO
- Controller configuration DTOProcessGroupStatusEntity getProcessGroupStatus(java.lang.String groupId, boolean recursive)
groupId
- groupStatusHistoryEntity getProcessGroupStatusHistory(java.lang.String groupId)
groupId
- idControllerStatusDTO getControllerStatus()
CounterDTO updateCounter(java.lang.String counterId)
counterId
- idCountersDTO getCounters()
java.util.Set<DocumentedTypeDTO> getProcessorTypes(java.lang.String bundleGroupFilter, java.lang.String bundleArtifactFilter, java.lang.String typeFilter)
bundleGroupFilter
- if specified, must be member of bundle groupbundleArtifactFilter
- if specified, must be member of bundle artifacttypeFilter
- if specified, type must matchjava.util.Set<DocumentedTypeDTO> getControllerServiceTypes(java.lang.String serviceType, java.lang.String serviceBundleGroup, java.lang.String serviceBundleArtifact, java.lang.String serviceBundleVersion, java.lang.String bundleGroupFilter, java.lang.String bundleArtifactFilter, java.lang.String typeFilter)
serviceType
- Filters only service types that implement this typeserviceBundleGroup
- if serviceType specified, the bundle group of the serviceTypeserviceBundleArtifact
- if serviceType specified, the bundle artifact of the serviceTypeserviceBundleVersion
- if serviceType specified, the bundle version of the serviceTypebundleGroupFilter
- if specified, must be member of bundle groupbundleArtifactFilter
- if specified, must be member of bundle artifacttypeFilter
- if specified, type must matchjava.util.Set<DocumentedTypeDTO> getReportingTaskTypes(java.lang.String bundleGroupFilter, java.lang.String bundleArtifactFilter, java.lang.String typeFilter)
bundleGroupFilter
- if specified, must be member of bundle groupbundleArtifactFilter
- if specified, must be member of bundle artifacttypeFilter
- if specified, type must matchjava.util.Set<DocumentedTypeDTO> getWorkQueuePrioritizerTypes()
void verifyCanAddTemplate(java.lang.String groupId, java.lang.String name)
groupId
- the id of the group for the templatename
- name of proposed templatevoid verifyComponentTypes(FlowSnippetDTO snippet)
snippet
- proposed templateTemplateDTO createTemplate(java.lang.String name, java.lang.String description, java.lang.String snippetId, java.lang.String groupId, java.util.Optional<java.lang.String> idGenerationSeed)
name
- namedescription
- descriptionsnippetId
- idgroupId
- id of the process groupidGenerationSeed
- the seed to use for generating a UUIDTemplateDTO importTemplate(TemplateDTO templateDTO, java.lang.String groupId, java.util.Optional<java.lang.String> idGenerationSeed)
templateDTO
- The template dtogroupId
- id of the process groupidGenerationSeed
- the seed to use for generating a UUIDFlowEntity createTemplateInstance(java.lang.String groupId, java.lang.Double originX, java.lang.Double originY, java.lang.String templateEncodingVersion, FlowSnippetDTO snippet, java.lang.String idGenerationSeed)
groupId
- group idoriginX
- xoriginY
- ytemplateEncodingVersion
- template encoding versionsnippet
- template snippetidGenerationSeed
- the ID to use for generating UUID's. May be null.TemplateDTO getTemplate(java.lang.String id)
id
- idTemplateDTO exportTemplate(java.lang.String id)
id
- idjava.util.Set<TemplateEntity> getTemplates()
void deleteTemplate(java.lang.String id)
id
- The id of the templatevoid verifyCreateProcessor(ProcessorDTO processorDTO)
processorDTO
- processorProcessorEntity createProcessor(Revision revision, java.lang.String groupId, ProcessorDTO processorDTO)
revision
- revisiongroupId
- Group idprocessorDTO
- The processor DTOProcessorEntity getProcessor(java.lang.String id)
id
- Id of the processor to returnProcessorStatusEntity getProcessorStatus(java.lang.String id)
id
- idStatusHistoryEntity getProcessorStatusHistory(java.lang.String id)
id
- idPropertyDescriptorDTO getProcessorPropertyDescriptor(java.lang.String id, java.lang.String property)
id
- idproperty
- propertyjava.util.Set<ProcessorEntity> getProcessors(java.lang.String groupId, boolean includeDescendants)
groupId
- groupincludeDescendants
- if processors from descendent groups should be includedvoid verifyUpdateProcessor(ProcessorDTO processorDTO)
processorDTO
- processorProcessorEntity updateProcessor(Revision revision, ProcessorDTO processorDTO)
revision
- Revision to compare with current base revisionprocessorDTO
- The processorDTOvoid verifyDeleteProcessor(java.lang.String processorId)
processorId
- processorProcessorEntity deleteProcessor(Revision revision, java.lang.String processorId)
revision
- Revision to compare with current base revisionprocessorId
- The processor id to deletejava.util.Set<ConnectionEntity> getConnections(java.lang.String groupId)
groupId
- groupConnectionEntity getConnection(java.lang.String connectionId)
connectionId
- The ID of the connectionConnectionStatusEntity getConnectionStatus(java.lang.String connectionId)
connectionId
- connectionStatusHistoryEntity getConnectionStatusHistory(java.lang.String connectionId)
connectionId
- connectionConnectionEntity createConnection(Revision revision, java.lang.String groupId, ConnectionDTO connectionDTO)
revision
- revisiongroupId
- groupconnectionDTO
- The Connection DTOvoid verifyListQueue(java.lang.String connectionId)
connectionId
- connectionvoid verifyCreateConnection(java.lang.String groupId, ConnectionDTO connectionDTO)
groupId
- groupconnectionDTO
- connectionvoid verifyUpdateConnection(ConnectionDTO connectionDTO)
connectionDTO
- connectionConnectionEntity updateConnection(Revision revision, ConnectionDTO connectionDTO)
revision
- Revision to compare with current base revisionconnectionDTO
- The Connection DTOvoid verifyDeleteConnection(java.lang.String connectionId)
connectionId
- connectionConnectionEntity deleteConnection(Revision revision, java.lang.String connectionId)
revision
- Revision to compare with current base revisionconnectionId
- The ID of the connectionDropRequestDTO createFlowFileDropRequest(java.lang.String connectionId, java.lang.String dropRequestId)
connectionId
- The ID of the connectiondropRequestId
- The ID of the drop requestDropRequestDTO getFlowFileDropRequest(java.lang.String connectionId, java.lang.String dropRequestId)
connectionId
- The ID of the connectiondropRequestId
- The flow file drop requestDropRequestDTO deleteFlowFileDropRequest(java.lang.String connectionId, java.lang.String dropRequestId)
connectionId
- The ID of the connectiondropRequestId
- The flow file drop requestListingRequestDTO createFlowFileListingRequest(java.lang.String connectionId, java.lang.String listingRequestId)
connectionId
- The ID of the connectionlistingRequestId
- The ID of the listing requestListingRequestDTO getFlowFileListingRequest(java.lang.String connectionId, java.lang.String listingRequestId)
connectionId
- The ID of the connectionlistingRequestId
- The ID of the listing requestListingRequestDTO deleteFlowFileListingRequest(java.lang.String connectionId, java.lang.String listingRequestId)
connectionId
- The ID of the connectionlistingRequestId
- The ID of the listing requestFlowFileDTO getFlowFile(java.lang.String connectionId, java.lang.String flowFileUuid)
connectionId
- The ID of the connectionflowFileUuid
- The UUID of the flowfilePortEntity createInputPort(Revision revision, java.lang.String groupId, PortDTO inputPortDTO)
revision
- revisiongroupId
- The id of the group this port should be create ininputPortDTO
- The input PortDTOPortEntity getInputPort(java.lang.String inputPortId)
inputPortId
- The input port idjava.util.Set<PortEntity> getInputPorts(java.lang.String groupId)
groupId
- The id of the groupPortStatusEntity getInputPortStatus(java.lang.String inputPortId)
inputPortId
- input portvoid verifyUpdateInputPort(PortDTO inputPortDTO)
inputPortDTO
- The id of the input portPortEntity updateInputPort(Revision revision, PortDTO inputPortDTO)
revision
- Revision to compare with current base revisioninputPortDTO
- The input PortDTOvoid verifyDeleteInputPort(java.lang.String inputPortId)
inputPortId
- The id of the input portPortEntity deleteInputPort(Revision revision, java.lang.String inputPortId)
revision
- Revision to compare with current base revisioninputPortId
- The id of the input portPortEntity createOutputPort(Revision revision, java.lang.String groupId, PortDTO outputPortDTO)
revision
- revisiongroupId
- The id of the group this port should be create inoutputPortDTO
- The output PortDTOPortEntity getOutputPort(java.lang.String outputPortId)
outputPortId
- The output port idjava.util.Set<PortEntity> getOutputPorts(java.lang.String groupId)
groupId
- The id of the groupPortStatusEntity getOutputPortStatus(java.lang.String outputPortId)
outputPortId
- output portvoid verifyUpdateOutputPort(PortDTO outputPortDTO)
outputPortDTO
- The id of the output portPortEntity updateOutputPort(Revision revision, PortDTO outputPortDTO)
revision
- Revision to compare with current base revisionoutputPortDTO
- The output PortDTOvoid verifyDeleteOutputPort(java.lang.String outputPortId)
outputPortId
- The id of the output portPortEntity deleteOutputPort(Revision revision, java.lang.String outputPortId)
revision
- revisionoutputPortId
- The id of the output portCurrentUserEntity getCurrentUser()
ProcessGroupFlowEntity getProcessGroupFlow(java.lang.String groupId)
groupId
- groupProcessGroupEntity createProcessGroup(Revision revision, java.lang.String parentGroupId, ProcessGroupDTO processGroupDTO)
revision
- revisionparentGroupId
- The id of the parent groupprocessGroupDTO
- The ProcessGroupDTOProcessGroupEntity getProcessGroup(java.lang.String groupId)
groupId
- groupVariableRegistryEntity getVariableRegistry(java.lang.String groupId, boolean includeAncestorGroups)
groupId
- the ID of the Process GroupincludeAncestorGroups
- whether or not to include the variables that are defined in the the process group's parent group & its parent group, etc.VariableRegistryEntity populateAffectedComponents(VariableRegistryDTO variableRegistryDto)
variableRegistryDto
- the Variable Registry that contains the variables of interestVariableRegistryEntity updateVariableRegistry(Revision revision, VariableRegistryDTO variableRegistryDto)
revision
- Revision to compare with current base revisionvariableRegistryDto
- the Variable RegistryVariableRegistryEntity updateVariableRegistry(NiFiUser user, Revision revision, VariableRegistryDTO variableRegistryDto)
user
- the user who performed the actionrevision
- Revision to compare with current base revisionvariableRegistryDto
- the Variable Registryjava.util.Set<AffectedComponentEntity> getComponentsAffectedByVariableRegistryUpdate(VariableRegistryDTO variableRegistryDto)
variableRegistryDto
- the variable registryjava.util.Set<AffectedComponentDTO> getActiveComponentsAffectedByVariableRegistryUpdate(VariableRegistryDTO variableRegistryDto)
variableRegistryDto
- the variable registryjava.util.Set<ProcessGroupEntity> getProcessGroups(java.lang.String parentGroupId)
parentGroupId
- The id of the parent groupvoid verifyScheduleComponents(java.lang.String processGroupId, ScheduledState state, java.util.Set<java.lang.String> componentIds)
processGroupId
- The ProcessGroup idcomponentIds
- the componentsstate
- scheduled statevoid verifyActivateControllerServices(java.lang.String processGroupId, ControllerServiceState state, java.util.Set<java.lang.String> serviceIds)
processGroupId
- the ID of the process groupstate
- the stateserviceIds
- the id's of the servicesActivateControllerServicesEntity activateControllerServices(java.lang.String processGroupId, ControllerServiceState state, java.util.Map<java.lang.String,Revision> serviceRevisions)
processGroupId
- the ID of the process groupstate
- the desired state of the servicesserviceRevisions
- a mapping of Controller Service ID to current RevisionActivateControllerServicesEntity activateControllerServices(NiFiUser user, java.lang.String processGroupId, ControllerServiceState state, java.util.Map<java.lang.String,Revision> serviceRevisions)
user
- the user performing the actionprocessGroupId
- the ID of the process groupstate
- the desired state of the servicesserviceRevisions
- a mapping of Controller Service ID to current RevisionScheduleComponentsEntity scheduleComponents(java.lang.String processGroupId, ScheduledState state, java.util.Map<java.lang.String,Revision> componentRevisions)
processGroupId
- The ProcessGroup idstate
- schedule statecomponentRevisions
- components and their revisionScheduleComponentsEntity scheduleComponents(NiFiUser user, java.lang.String processGroupId, ScheduledState state, java.util.Map<java.lang.String,Revision> componentRevisions)
user
- the user performing the actionprocessGroupId
- The ProcessGroup idstate
- schedule statecomponentRevisions
- components and their revisionProcessGroupEntity updateProcessGroup(Revision revision, ProcessGroupDTO processGroupDTO)
revision
- Revision to compare with current base revisionprocessGroupDTO
- The ProcessGroupDTOvoid verifyUpdateProcessGroup(ProcessGroupDTO processGroupDTO)
processGroupDTO
- the DTO that indicates the updates to occurvoid verifyDeleteProcessGroup(java.lang.String groupId)
groupId
- The id of the process groupProcessGroupEntity deleteProcessGroup(Revision revision, java.lang.String groupId)
revision
- Revision to compare with current base revisiongroupId
- The id of the process groupRemoteProcessGroupEntity createRemoteProcessGroup(Revision revision, java.lang.String groupId, RemoteProcessGroupDTO remoteProcessGroupDTO)
revision
- revisiongroupId
- The id of the parent groupremoteProcessGroupDTO
- The RemoteProcessGroupDTORemoteProcessGroupEntity getRemoteProcessGroup(java.lang.String remoteProcessGroupId)
remoteProcessGroupId
- The id of the remote process groupjava.util.Set<RemoteProcessGroupEntity> getRemoteProcessGroups(java.lang.String groupId)
groupId
- The id of the parent groupRemoteProcessGroupStatusEntity getRemoteProcessGroupStatus(java.lang.String id)
id
- remote process groupStatusHistoryEntity getRemoteProcessGroupStatusHistory(java.lang.String id)
id
- The id of the remote process groupvoid verifyUpdateRemoteProcessGroup(RemoteProcessGroupDTO remoteProcessGroupDTO)
remoteProcessGroupDTO
- The RemoteProcessGroupDTOvoid verifyUpdateRemoteProcessGroupInputPort(java.lang.String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPortDTO)
remoteProcessGroupId
- The id of the remote process groupremoteProcessGroupPortDTO
- The RemoteProcessGroupPortDTOvoid verifyUpdateRemoteProcessGroupOutputPort(java.lang.String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPortDTO)
remoteProcessGroupId
- The id of the remote process groupremoteProcessGroupPortDTO
- The RemoteProcessGroupPortDTORemoteProcessGroupEntity updateRemoteProcessGroup(Revision revision, RemoteProcessGroupDTO remoteProcessGroupDTO)
revision
- Revision to compare with current base revisionremoteProcessGroupDTO
- The RemoteProcessGroupDTORemoteProcessGroupPortEntity updateRemoteProcessGroupInputPort(Revision revision, java.lang.String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPortDTO)
revision
- Revision to compare with current base revisionremoteProcessGroupId
- The id of the remote process groupremoteProcessGroupPortDTO
- The RemoteProcessGroupPortDTORemoteProcessGroupPortEntity updateRemoteProcessGroupOutputPort(Revision revision, java.lang.String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPortDTO)
revision
- Revision to compare with current base revisionremoteProcessGroupId
- The id of the remote process groupremoteProcessGroupPortDTO
- The RemoteProcessGroupPortDTOvoid verifyDeleteRemoteProcessGroup(java.lang.String remoteProcessGroupId)
remoteProcessGroupId
- The id of the remote process groupRemoteProcessGroupEntity deleteRemoteProcessGroup(Revision revision, java.lang.String remoteProcessGroupId)
revision
- Revision to compare with current base revisionremoteProcessGroupId
- The id of the remote process groupBulletinEntity createBulletin(BulletinDTO bulletinDTO, java.lang.Boolean canRead)
bulletinDTO
- bulletin to send to userscanRead
- allow users to read bulletinFunnelEntity createFunnel(Revision revision, java.lang.String groupId, FunnelDTO funnelDTO)
revision
- revisiongroupId
- groupfunnelDTO
- funnelFunnelEntity getFunnel(java.lang.String funnelId)
funnelId
- The funnel idjava.util.Set<FunnelEntity> getFunnels(java.lang.String groupId)
groupId
- groupFunnelEntity updateFunnel(Revision revision, FunnelDTO funnelDTO)
revision
- Revision to compare with current base revisionfunnelDTO
- The funnel DTOvoid verifyDeleteFunnel(java.lang.String funnelId)
funnelId
- funnelFunnelEntity deleteFunnel(Revision revision, java.lang.String funnelId)
revision
- Revision to compare with current base revisionfunnelId
- The funnel idComponentStateDTO getProcessorState(java.lang.String processorId)
processorId
- the processor idvoid verifyCanClearProcessorState(java.lang.String processorId)
processorId
- the processor idvoid clearProcessorState(java.lang.String processorId)
processorId
- the processor idComponentStateDTO getControllerServiceState(java.lang.String controllerServiceId)
controllerServiceId
- the controller service idvoid verifyCanClearControllerServiceState(java.lang.String controllerServiceId)
controllerServiceId
- the controller service idvoid clearControllerServiceState(java.lang.String controllerServiceId)
controllerServiceId
- the controller service idComponentStateDTO getReportingTaskState(java.lang.String reportingTaskId)
reportingTaskId
- the reporting task idvoid verifyCanClearReportingTaskState(java.lang.String reportingTaskId)
reportingTaskId
- the reporting task idvoid clearReportingTaskState(java.lang.String reportingTaskId)
reportingTaskId
- the reporting task idLabelEntity createLabel(Revision revision, java.lang.String groupId, LabelDTO labelDTO)
revision
- revisiongroupId
- grouplabelDTO
- The label DTOLabelEntity getLabel(java.lang.String labelId)
labelId
- The label idjava.util.Set<LabelEntity> getLabels(java.lang.String groupId)
groupId
- groupLabelEntity updateLabel(Revision revision, LabelDTO labelDTO)
revision
- Revision to compare with current base revisionlabelDTO
- The label DTOLabelEntity deleteLabel(Revision revision, java.lang.String labelId)
revision
- Revision to compare with current base revisionlabelId
- The label idUserEntity createUser(Revision revision, UserDTO userDTO)
revision
- The starting revisionuserDTO
- The user DTOUserEntity getUser(java.lang.String userId)
userId
- The user IDjava.util.Set<UserEntity> getUsers()
UserEntity updateUser(Revision revision, UserDTO userDTO)
revision
- Revision to compare with current base revisionuserDTO
- The user DTOUserEntity deleteUser(Revision revision, java.lang.String userId)
revision
- Revision to compare with current base revisionuserId
- The user IDUserGroupEntity createUserGroup(Revision revision, UserGroupDTO userGroupDTO)
revision
- The starting revisionuserGroupDTO
- The user group DTOUserGroupEntity getUserGroup(java.lang.String userGroupId)
userGroupId
- The user group IDjava.util.Set<UserGroupEntity> getUserGroups()
UserGroupEntity updateUserGroup(Revision revision, UserGroupDTO userGroupDTO)
revision
- Revision to compare with current base revisionuserGroupDTO
- The user group DTOUserGroupEntity deleteUserGroup(Revision revision, java.lang.String userGroupId)
revision
- Revision to compare with current base revisionuserGroupId
- The user group IDAccessPolicyEntity createAccessPolicy(Revision revision, AccessPolicyDTO accessPolicyDTO)
revision
- The starting revisionaccessPolicyDTO
- The access policy DTOAccessPolicyEntity getAccessPolicy(java.lang.String accessPolicyId)
accessPolicyId
- access policy IDAccessPolicyEntity getAccessPolicy(RequestAction requestAction, java.lang.String resource)
resource
- resourceAccessPolicyEntity updateAccessPolicy(Revision revision, AccessPolicyDTO accessPolicyDTO)
revision
- Revision to compare with current base revisionaccessPolicyDTO
- The access policy DTOAccessPolicyEntity deleteAccessPolicy(Revision revision, java.lang.String accessPolicyId)
revision
- Revision to compare with current base revisionaccessPolicyId
- The access policy IDvoid verifyCreateControllerService(ControllerServiceDTO controllerServiceDTO)
controllerServiceDTO
- serviceControllerServiceEntity createControllerService(Revision revision, java.lang.String groupId, ControllerServiceDTO controllerServiceDTO)
revision
- revisiongroupId
- the ID of the Process Group to add the Controller Service tocontrollerServiceDTO
- The controller service DTOjava.util.Set<ControllerServiceEntity> getControllerServices(java.lang.String groupId, boolean includeAncestorGroups, boolean includeDescendantGroups)
groupId
- the id of the process group of interestincludeAncestorGroups
- if true, parent and ancestor groups' services will be returned as wellincludeDescendantGroups
- if true, child and descendant groups' services will be returned as welljava.util.Set<ControllerServiceEntity> getControllerServices(java.lang.String groupId, boolean includeAncestorGroups, boolean includeDescendantGroups, NiFiUser user)
groupId
- the id of the process group of interestincludeAncestorGroups
- if true, parent and ancestor groups' services will be returned as wellincludeDescendantGroups
- if true, child and descendant groups' services will be returned as welluser
- the user that is retrieving the Controller ServicesControllerServiceEntity getControllerService(java.lang.String controllerServiceId)
controllerServiceId
- idPropertyDescriptorDTO getControllerServicePropertyDescriptor(java.lang.String id, java.lang.String property)
id
- idproperty
- propertyControllerServiceReferencingComponentsEntity getControllerServiceReferencingComponents(java.lang.String controllerServiceId)
controllerServiceId
- idControllerServiceReferencingComponentsEntity updateControllerServiceReferencingComponents(java.util.Map<java.lang.String,Revision> referenceRevisions, java.lang.String controllerServiceId, ScheduledState scheduledState, ControllerServiceState controllerServiceState)
referenceRevisions
- revisionscontrollerServiceId
- idscheduledState
- statecontrollerServiceState
- the value of stateControllerServiceEntity updateControllerService(Revision revision, ControllerServiceDTO controllerServiceDTO)
revision
- Revision to compare with current base revisioncontrollerServiceDTO
- The controller service DTOControllerServiceEntity deleteControllerService(Revision revision, java.lang.String controllerServiceId)
revision
- Revision to compare with current base revisioncontrollerServiceId
- The controller service idvoid verifyUpdateControllerService(ControllerServiceDTO controllerServiceDTO)
controllerServiceDTO
- servicevoid verifyUpdateControllerServiceReferencingComponents(java.lang.String controllerServiceId, ScheduledState scheduledState, ControllerServiceState controllerServiceState)
controllerServiceId
- idscheduledState
- schedule statecontrollerServiceState
- service statevoid verifyDeleteControllerService(java.lang.String controllerServiceId)
controllerServiceId
- idvoid verifyCreateReportingTask(ReportingTaskDTO reportingTaskDTO)
reportingTaskDTO
- taskReportingTaskEntity createReportingTask(Revision revision, ReportingTaskDTO reportingTaskDTO)
revision
- revisionreportingTaskDTO
- The reporting task DTOjava.util.Set<ReportingTaskEntity> getReportingTasks()
ReportingTaskEntity getReportingTask(java.lang.String reportingTaskId)
reportingTaskId
- idPropertyDescriptorDTO getReportingTaskPropertyDescriptor(java.lang.String id, java.lang.String property)
id
- idproperty
- propertyReportingTaskEntity updateReportingTask(Revision revision, ReportingTaskDTO reportingTaskDTO)
revision
- Revision to compare with current base revisionreportingTaskDTO
- The reporting task DTOReportingTaskEntity deleteReportingTask(Revision revision, java.lang.String reportingTaskId)
revision
- Revision to compare with current base revisionreportingTaskId
- The reporting task idvoid verifyUpdateReportingTask(ReportingTaskDTO reportingTaskDTO)
reportingTaskDTO
- taskvoid verifyDeleteReportingTask(java.lang.String reportingTaskId)
reportingTaskId
- idHistoryDTO getActions(HistoryQueryDTO historyQuery)
historyQuery
- queryActionEntity getAction(java.lang.Integer actionId)
actionId
- idvoid deleteActions(java.util.Date endDate)
endDate
- The end dateComponentHistoryDTO getComponentHistory(java.lang.String componentId)
componentId
- idFlowEntity copySnippet(java.lang.String groupId, java.lang.String snippetId, java.lang.Double originX, java.lang.Double originY, java.lang.String idGenerationSeed)
groupId
- group idsnippetId
- snippet idoriginX
- xoriginY
- yidGenerationSeed
- the seed to use for generating UUID's. May be null.SnippetEntity createSnippet(SnippetDTO snippet)
snippet
- snippetvoid verifyUpdateSnippet(SnippetDTO snippetDto, java.util.Set<java.lang.String> affectedComponentIds)
snippetDto
- snippetSnippetEntity updateSnippet(java.util.Set<Revision> revisions, SnippetDTO snippetDto)
revisions
- revisionssnippetDto
- snippetvoid verifyDeleteSnippet(java.lang.String id, java.util.Set<java.lang.String> affectedComponentIds)
id
- idaffectedComponentIds
- affected componentsSnippetEntity deleteSnippet(java.util.Set<Revision> revisions, java.lang.String snippetId)
revisions
- revisionssnippetId
- snippetboolean isClustered()
java.lang.String getNodeId()
ClusterDTO getCluster()
NodeDTO getNode(java.lang.String nodeId)
nodeId
- a node identifierNodeDTO updateNode(NodeDTO nodeDTO)
nodeDTO
- a node transfer objectvoid deleteNode(java.lang.String nodeId)
nodeId
- a node identifierBulletinBoardDTO getBulletinBoard(BulletinQueryDTO query)
query
- querySystemDiagnosticsDTO getSystemDiagnostics()
java.util.List<ResourceDTO> getResources()