org.apache.nifi.web.controller

Class ControllerFacade

java.lang.Object

org.apache.nifi.web.controller.ControllerFacade

All Implemented Interfaces:

ControllerServiceLookup, ControllerServiceProvider

public class ControllerFacade
extends Object
implements ControllerServiceProvider

Field Summary

Fields

Modifier and Type	Field and Description
private DtoFactory	dtoFactory
private FlowController	flowController
private FlowService	flowService
private static org.slf4j.Logger	logger
private NiFiProperties	properties
private UserService	userService

Constructor Summary

Constructors

Constructor and Description
ControllerFacade()

Method Summary

Methods

Modifier and Type	Method and Description
private void	addIfAppropriate(String searchStr, String value, String label, List<String> matches)
void	createArchive() Creates an archive of the current flow.
ControllerServiceNode	createControllerService(String type, String id, Map<String,String> properties)
private ProvenanceEventDTO	createProvenanceEventDto(ProvenanceEventRecord event) Creates a ProvenanceEventDTO for the specified ProvenanceEventRecord.
void	deleteLineage(String lineageId) Deletes the lineage with the specified id.
void	deleteProvenanceQuery(String provenanceId) Deletes the query with the specified id.
String	findProcessGroupIdForProcessor(String processorId) Returns the group id that contains the specified processor.
BulletinRepository	getBulletinRepository() Gets the BulletinRepository.
Integer	getClusterManagerRemoteSiteListeningPort() Returns the socket port that the Cluster Manager is listening on for Site-to-Site communications
String	getComments() Gets the comments of this controller.
StatusHistoryDTO	getConnectionStatusHistory(String groupId, String connectionId) Returns the status history for the specified connection.
DownloadableContent	getContent(Long eventId, String uri, ContentDirection contentDirection) Gets the content for the specified claim.
ControllerService	getControllerService(String serviceIdentifier) Return the controller service for the specified identifier.
Set<String>	getControllerServiceIdentifiers(Class<? extends ControllerService> serviceType)
ControllerServiceNode	getControllerServiceNode(String id)
ControllerStatusDTO	getControllerStatus() Gets the status of this controller.
List<Counter>	getCounters() Gets the counters for this controller.
Set<DocumentedTypeDTO>	getFlowFileComparatorTypes() Gets the FlowFileComparator types that this controller supports.
Set<DocumentedTypeDTO>	getFlowFileProcessorTypes() Gets the FlowFileProcessor types that this controller supports.
Set<RootGroupPort>	getInputPorts() Gets the input ports on the root group.
String	getInstanceId()
LineageDTO	getLineage(String lineageId) Gets the lineage with the specified id.
int	getMaxEventDrivenThreadCount() Gets the max event driven thread count of this controller.
int	getMaxTimerDrivenThreadCount() Gets the max timer driven thread count of this controller.
String	getName() Gets the name of this controller.
org.apache.nifi.cluster.protocol.NodeIdentifier	getNodeId() Get the node id of this controller.
Set<RootGroupPort>	getOutputPorts() Gets the output ports on the root group.
ProcessGroupStatusDTO	getProcessGroupStatus(String groupId) Gets the status for the specified process group.
StatusHistoryDTO	getProcessGroupStatusHistory(String groupId) Returns the status history for the specified process group.
StatusHistoryDTO	getProcessorStatusHistory(String groupId, String processorId) Returns the status history for the specified processor.
ProvenanceEventDTO	getProvenanceEvent(Long eventId) Get the provenance event with the specified event id.
ProvenanceDTO	getProvenanceQuery(String provenanceId) Retrieves the results of a provenance query.
ProvenanceOptionsDTO	getProvenanceSearchOptions() Gets the available options for searching provenance.
StatusHistoryDTO	getRemoteProcessGroupStatusHistory(String groupId, String remoteProcessGroupId) Returns the status history for the specified remote process group.
Integer	getRemoteSiteListeningPort() Returns the socket port that the local instance is listening on for Site-to-Site communications
String	getRootGroupId() Gets the root group id.
SystemDiagnostics	getSystemDiagnostics() Returns a SystemDiagnostics that describes the current state of the node
boolean	isClustered()
Boolean	isClusterManagerRemoteSiteCommsSecure() Indicates whether or not Site-to-Site communications with the Cluster Manager are secure
boolean	isControllerServiceEnabled(ControllerService service)
boolean	isControllerServiceEnabled(String serviceIdentifier)
Boolean	isRemoteSiteCommsSecure() Indicates whether or not Site-to-Site communications with the local instance are secure
Counter	resetCounter(String id) Resets the counter with the specified id.
void	save() Saves the state of the flow controller.
private void	search(SearchResultsDTO results, String search, ProcessGroup group)
SearchResultsDTO	search(String search) Searches this controller for the specified term.
private ComponentSearchResultDTO	search(String searchStr, Connection connection)
private ComponentSearchResultDTO	search(String searchStr, Funnel funnel)
private ComponentSearchResultDTO	search(String searchStr, Port port)
private ComponentSearchResultDTO	search(String searchStr, ProcessGroup group)
private ComponentSearchResultDTO	search(String searchStr, ProcessorNode procNode)
private ComponentSearchResultDTO	search(String searchStr, RemoteProcessGroup group)
void	setComments(String comments) Sets the comments of this controller.
private void	setComponentDetails(ProvenanceEventDTO dto) Gets the name for the component with the specified id.
void	setDtoFactory(DtoFactory dtoFactory)
void	setFlowController(FlowController flowController)
void	setFlowService(FlowService flowService)
void	setMaxEventDrivenThreadCount(int maxEventDrivenThreadCount) Sets the max event driven thread count of this controller.
void	setMaxTimerDrivenThreadCount(int maxTimerDrivenThreadCount) Sets the max timer driven thread count of this controller.
void	setName(String name) Sets the name of this controller.
void	setProperties(NiFiProperties properties)
void	setUserService(UserService userService)
LineageDTO	submitLineage(LineageDTO lineageDto) Submits the specified lineage request.
ProvenanceDTO	submitProvenance(ProvenanceDTO provenanceDto) Submits a provenance query.
ProvenanceEventDTO	submitReplay(Long eventId) Submits a replay request for the specified event id.

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

flowController

private FlowController flowController

flowService

private FlowService flowService

userService

private UserService userService

properties

private NiFiProperties properties

dtoFactory

private DtoFactory dtoFactory

Constructor Detail

ControllerFacade

public ControllerFacade()

Method Detail

createArchive

public void createArchive()

Creates an archive of the current flow.

findProcessGroupIdForProcessor

public String findProcessGroupIdForProcessor(String processorId)

Returns the group id that contains the specified processor.

Parameters:

processorId -

Returns:

setName

public void setName(String name)

Sets the name of this controller.

Parameters:

name -

setComments

public void setComments(String comments)

Sets the comments of this controller.

Parameters:

comments -

setMaxTimerDrivenThreadCount

public void setMaxTimerDrivenThreadCount(int maxTimerDrivenThreadCount)

Sets the max timer driven thread count of this controller.

Parameters:

maxTimerDrivenThreadCount -

setMaxEventDrivenThreadCount

public void setMaxEventDrivenThreadCount(int maxEventDrivenThreadCount)

Sets the max event driven thread count of this controller.

Parameters:

maxEventDrivenThreadCount -

getRootGroupId

public String getRootGroupId()

Gets the root group id.

Returns:

getInputPorts

public Set<RootGroupPort> getInputPorts()

Gets the input ports on the root group.

Returns:

getOutputPorts

public Set<RootGroupPort> getOutputPorts()

Gets the output ports on the root group.

Returns:

getProcessorStatusHistory

public StatusHistoryDTO getProcessorStatusHistory(String groupId,
                                         String processorId)

Returns the status history for the specified processor.

Parameters:

groupId -

processorId -

Returns:

getConnectionStatusHistory

public StatusHistoryDTO getConnectionStatusHistory(String groupId,
                                          String connectionId)

Returns the status history for the specified connection.

Parameters:

groupId -

connectionId -

Returns:

getProcessGroupStatusHistory

public StatusHistoryDTO getProcessGroupStatusHistory(String groupId)

Returns the status history for the specified process group.

Parameters:

groupId -

Returns:

getRemoteProcessGroupStatusHistory

public StatusHistoryDTO getRemoteProcessGroupStatusHistory(String groupId,
                                                  String remoteProcessGroupId)

Returns the status history for the specified remote process group.

Parameters:

groupId -

remoteProcessGroupId -

Returns:

getNodeId

public org.apache.nifi.cluster.protocol.NodeIdentifier getNodeId()

Get the node id of this controller.

Returns:

isClustered

public boolean isClustered()

getName

public String getName()

Gets the name of this controller.

Returns:

getInstanceId

public String getInstanceId()

getComments

public String getComments()

Gets the comments of this controller.

Returns:

getMaxTimerDrivenThreadCount

public int getMaxTimerDrivenThreadCount()

Gets the max timer driven thread count of this controller.

Returns:

getMaxEventDrivenThreadCount

public int getMaxEventDrivenThreadCount()

Gets the max event driven thread count of this controller.

Returns:

getFlowFileProcessorTypes

public Set<DocumentedTypeDTO> getFlowFileProcessorTypes()

Gets the FlowFileProcessor types that this controller supports.

Returns:

getFlowFileComparatorTypes

public Set<DocumentedTypeDTO> getFlowFileComparatorTypes()

Gets the FlowFileComparator types that this controller supports.

Returns:

getCounters

public List<Counter> getCounters()

Gets the counters for this controller.

Returns:

resetCounter

public Counter resetCounter(String id)

Resets the counter with the specified id.

Parameters:

id -

Returns:

getControllerService

public ControllerService getControllerService(String serviceIdentifier)

Return the controller service for the specified identifier.

Specified by:

getControllerService in interface ControllerServiceLookup

Parameters:

serviceIdentifier -

Returns:

createControllerService

public ControllerServiceNode createControllerService(String type,
                                            String id,
                                            Map<String,String> properties)

Specified by:

createControllerService in interface ControllerServiceProvider

getControllerServiceIdentifiers

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

Specified by:

getControllerServiceIdentifiers in interface ControllerServiceLookup

getControllerServiceNode

public ControllerServiceNode getControllerServiceNode(String id)

Specified by:

getControllerServiceNode in interface ControllerServiceProvider

isControllerServiceEnabled

public boolean isControllerServiceEnabled(ControllerService service)

Specified by:

isControllerServiceEnabled in interface ControllerServiceLookup

isControllerServiceEnabled

public boolean isControllerServiceEnabled(String serviceIdentifier)

Specified by:

isControllerServiceEnabled in interface ControllerServiceLookup

getControllerStatus

public ControllerStatusDTO getControllerStatus()

Gets the status of this controller.

Returns:

getProcessGroupStatus

public ProcessGroupStatusDTO getProcessGroupStatus(String groupId)

Gets the status for the specified process group.

Parameters:

groupId -

Returns:

getBulletinRepository

public BulletinRepository getBulletinRepository()

Gets the BulletinRepository.

Returns:

save

public void save()
          throws NiFiCoreException

Saves the state of the flow controller.

Throws:

NiFiCoreException

getClusterManagerRemoteSiteListeningPort

public Integer getClusterManagerRemoteSiteListeningPort()

Returns the socket port that the Cluster Manager is listening on for Site-to-Site communications

Returns:

isClusterManagerRemoteSiteCommsSecure

public Boolean isClusterManagerRemoteSiteCommsSecure()

Indicates whether or not Site-to-Site communications with the Cluster Manager are secure

Returns:

getRemoteSiteListeningPort

public Integer getRemoteSiteListeningPort()

Returns the socket port that the local instance is listening on for Site-to-Site communications

Returns:

isRemoteSiteCommsSecure

public Boolean isRemoteSiteCommsSecure()

Indicates whether or not Site-to-Site communications with the local instance are secure

Returns:

getSystemDiagnostics

public SystemDiagnostics getSystemDiagnostics()

Returns a SystemDiagnostics that describes the current state of the node

Returns:

getProvenanceSearchOptions

public ProvenanceOptionsDTO getProvenanceSearchOptions()

Gets the available options for searching provenance.

Returns:

submitProvenance

public ProvenanceDTO submitProvenance(ProvenanceDTO provenanceDto)

Submits a provenance query.

Parameters:

provenanceDto -

Returns:

getProvenanceQuery

public ProvenanceDTO getProvenanceQuery(String provenanceId)

Retrieves the results of a provenance query.

Parameters:

provenanceId -

Returns:

submitLineage

public LineageDTO submitLineage(LineageDTO lineageDto)

Submits the specified lineage request.

Parameters:

lineageDto -

Returns:

getLineage

public LineageDTO getLineage(String lineageId)

Gets the lineage with the specified id.

Parameters:

lineageId -

Returns:

deleteProvenanceQuery

public void deleteProvenanceQuery(String provenanceId)

Deletes the query with the specified id.

Parameters:

provenanceId -

deleteLineage

public void deleteLineage(String lineageId)

Deletes the lineage with the specified id.

Parameters:

lineageId -

getContent

public DownloadableContent getContent(Long eventId,
                             String uri,
                             ContentDirection contentDirection)

Gets the content for the specified claim.

Parameters:

eventId -

uri -

contentDirection -

Returns:

submitReplay

public ProvenanceEventDTO submitReplay(Long eventId)

Submits a replay request for the specified event id.

Parameters:

eventId -

Returns:

getProvenanceEvent

public ProvenanceEventDTO getProvenanceEvent(Long eventId)

Get the provenance event with the specified event id.

Parameters:

eventId -

Returns:

createProvenanceEventDto

private ProvenanceEventDTO createProvenanceEventDto(ProvenanceEventRecord event)

Creates a ProvenanceEventDTO for the specified ProvenanceEventRecord.

Parameters:

event -

Returns:

setComponentDetails

private void setComponentDetails(ProvenanceEventDTO dto)

Gets the name for the component with the specified id.

Parameters:

dto -

search

public SearchResultsDTO search(String search)

Searches this controller for the specified term.

Parameters:

search -

Returns:

search

private void search(SearchResultsDTO results,
          String search,
          ProcessGroup group)

search

private ComponentSearchResultDTO search(String searchStr,
                              Port port)

search

private ComponentSearchResultDTO search(String searchStr,
                              ProcessorNode procNode)

search

private ComponentSearchResultDTO search(String searchStr,
                              ProcessGroup group)

search

private ComponentSearchResultDTO search(String searchStr,
                              Connection connection)

search

private ComponentSearchResultDTO search(String searchStr,
                              RemoteProcessGroup group)

search

private ComponentSearchResultDTO search(String searchStr,
                              Funnel funnel)

addIfAppropriate

private void addIfAppropriate(String searchStr,
                    String value,
                    String label,
                    List<String> matches)

setFlowController

public void setFlowController(FlowController flowController)

setProperties

public void setProperties(NiFiProperties properties)

setUserService

public void setUserService(UserService userService)

setFlowService

public void setFlowService(FlowService flowService)

setDtoFactory

public void setDtoFactory(DtoFactory dtoFactory)