org.apache.nifi.controller.service

Interface ControllerServiceReference

All Known Implementing Classes:

StandardControllerServiceReference

public interface ControllerServiceReference

Provides a collection of components that are referencing a Controller Service

Method Summary

Modifier and Type	Method and Description
<T> java.util.List<T>	findRecursiveReferences(java.lang.Class<T> componentType) Returns a List of all components that reference this Controller Service (recursively) that are of the given type
java.util.Set<ConfiguredComponent>	getActiveReferences()
ControllerServiceNode	getReferencedComponent()
java.util.Set<ConfiguredComponent>	getReferencingComponents()

Method Detail

getReferencedComponent

ControllerServiceNode getReferencedComponent()

Returns:

the component that is being referenced

getReferencingComponents

java.util.Set<ConfiguredComponent> getReferencingComponents()

Returns:

a Set of all components that are referencing this Controller Service

getActiveReferences

java.util.Set<ConfiguredComponent> getActiveReferences()

Returns:

a Set of all Processors, Reporting Tasks, and Controller Services that are referencing the Controller Service and are running (in the case of Processors and Reporting Tasks) or enabled (in the case of Controller Services)

findRecursiveReferences

<T> java.util.List<T> findRecursiveReferences(java.lang.Class<T> componentType)

Returns a List of all components that reference this Controller Service (recursively) that are of the given type

Parameters:

componentType - the type of component that is desirable

Returns:

a List of all components that reference this Controller Service that are of the given type