org.apache.nifi.controller

Interface ControllerServiceLookup

public interface ControllerServiceLookup

Method Summary

Methods

Modifier and Type	Method and Description
ControllerService	getControllerService(String serviceIdentifier)
Set<String>	getControllerServiceIdentifiers(Class<? extends ControllerService> serviceType)
String	getControllerServiceName(String serviceIdentifier)
boolean	isControllerServiceEnabled(ControllerService service)
boolean	isControllerServiceEnabled(String serviceIdentifier)
boolean	isControllerServiceEnabling(String serviceIdentifier)

Method Detail

getControllerService

ControllerService getControllerService(String serviceIdentifier)

Parameters:

serviceIdentifier - of controller service

Returns:

the ControllerService that is registered with the given identifier

isControllerServiceEnabled

boolean isControllerServiceEnabled(String serviceIdentifier)

Parameters:

serviceIdentifier - identifier of service to check

Returns:

true if the Controller Service with the given identifier is enabled, false otherwise. If the given identifier is not known by this ControllerServiceLookup, returns false

isControllerServiceEnabling

boolean isControllerServiceEnabling(String serviceIdentifier)

Parameters:

serviceIdentifier - idenfitier of service to check

Returns:

true if the Controller Service with the given identifier has been enabled but is still in the transitioning state, otherwise returns false. If the given identifier is not known by this ControllerServiceLookup, returns false

isControllerServiceEnabled

boolean isControllerServiceEnabled(ControllerService service)

Parameters:

service - service to check

Returns:

true if the given Controller Service is enabled, false otherwise. If the given Controller Service is not known by this ControllerServiceLookup, returns false

getControllerServiceIdentifiers

Set<String> getControllerServiceIdentifiers(Class<? extends ControllerService> serviceType)
                                            throws IllegalArgumentException

Parameters:

serviceType - type of service to get identifiers for

Returns:

the set of all Controller Service Identifiers whose Controller Service is of the given type.

Throws:

IllegalArgumentException - if the given class is not an interface

getControllerServiceName

String getControllerServiceName(String serviceIdentifier)

Parameters:

serviceIdentifier - identifier to look up

Returns:

the name of the Controller service with the given identifier. If no service can be found with this identifier, returns null