WebClusterManager (nifi-framework-cluster 0.6.0 API)

java.lang.Object
- org.apache.nifi.cluster.manager.impl.WebClusterManager

All Implemented Interfaces:

ClusterManager, HttpClusterManager, ProtocolHandler, ControllerServiceLookup, ReportingTaskProvider, ControllerServiceProvider, NodeInformant
```
public class WebClusterManager
extends Object
implements HttpClusterManager, ProtocolHandler, ControllerServiceProvider, ReportingTaskProvider
```
Provides a cluster manager implementation. The manager federates incoming HTTP client requests to the nodes' external API using the HTTP protocol. The manager also communicates with nodes using the nodes' internal socket protocol. The manager's socket address may broadcasted using multicast if a MulticastServiceBroadcaster instance is set on this instance. The manager instance must be started after setting the broadcaster. The manager may be configured with an EventManager for recording noteworthy lifecycle events (e.g., first heartbeat received, node status change). The start() and stop() methods must be called to initialize and stop the instance.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`WebClusterManager.CaptureComponentMetrics` Captures snapshots of components' metrics
`private static class`	`WebClusterManager.ClusterManagerLock`
`private class`	`WebClusterManager.HeartbeatMonitoringTimerTask` A timer task to detect nodes that have not sent a heartbeat in a while.
`private class`	`WebClusterManager.ProcessPendingHeartbeatsTask` This timer task simply processes any pending heartbeats.

Field Summary

Fields
Modifier and Type	Field and Description
`private AuditService`	`auditService`
`static String`	`BULLETIN_CATEGORY`
`private BulletinRepository`	`bulletinRepository`
`private StandardDataFlow`	`cachedDataFlow`
`static String`	`CLUSTER_CONTEXT_HTTP_HEADER` The HTTP header to store a cluster context.
`static String`	`CLUSTER_INVALIDATE_USER_GROUP_HEADER` The HTTP header that the NCM specifies to indicate that a node should invalidate the specified user group.
`static String`	`CLUSTER_INVALIDATE_USER_HEADER` The HTTP header that the NCM specifies to indicate that a node should invalidate the specified user.
`static Pattern`	`CLUSTER_PROCESSOR_URI_PATTERN`
`private ClusterNodeFirewall`	`clusterFirewall`
`private Map<NodeIdentifier,ComponentStatusRepository>`	`componentMetricsRepositoryMap`
`private long`	`componentStatusSnapshotMillis`
`static Pattern`	`CONTROLLER_SERVICE_REFERENCES_URI_PATTERN`
`static Pattern`	`CONTROLLER_SERVICE_STATE_URI_PATTERN`
`static Pattern`	`CONTROLLER_SERVICE_URI_PATTERN`
`static String`	`CONTROLLER_SERVICES_URI`
`private ControllerServiceProvider`	`controllerServiceProvider`
`static Pattern`	`COUNTERS_URI`
`private DataFlowManagementService`	`dataFlowManagementService`
`static String`	`DEFAULT_COMPONENT_STATUS_REPO_IMPLEMENTATION`
`private static int`	`DEFAULT_CONNECTION_REQUEST_TRY_AGAIN_SECONDS` The default number of seconds to respond to a connecting node if the manager cannot provide it with a current data flow.
`static Pattern`	`DROP_REQUEST_URI`
`static Pattern`	`DROP_REQUESTS_URI`
`private StringEncryptor`	`encryptor`
`private EventManager`	`eventManager`
`static Pattern`	`FLOW_SNIPPET_INSTANCE_URI_PATTERN`
`private static org.slf4j.Logger`	`heartbeatLogger`
`private Timer`	`heartbeatMonitor`
`private Timer`	`heartbeatProcessor`
`private HttpRequestReplicator`	`httpRequestReplicator`
`private HttpResponseMapper`	`httpResponseMapper`
`private String`	`instanceId`
`static Pattern`	`LISTING_REQUEST_URI`
`static Pattern`	`LISTING_REQUESTS_URI`
`private static org.slf4j.Logger`	`logger`
`static String`	`NCM_EXPECTS_HTTP_HEADER` The HTTP header that the NCM specifies to ask a node if they are able to process a given request.
`static int`	`NODE_CONTINUE_STATUS_CODE`
`private Set<Node>`	`nodes`
`private OptimisticLockingManager`	`optimisticLockingManager`
`private Queue<Heartbeat>`	`pendingHeartbeats`
`private NodeIdentifier`	`primaryNodeId`
`static Pattern`	`PROCESS_GROUP_URI_PATTERN`
`static Pattern`	`PROCESSOR_STATE_URI_PATTERN`
`static Pattern`	`PROCESSOR_URI_PATTERN`
`static Pattern`	`PROCESSORS_URI_PATTERN`
`private StandardProcessScheduler`	`processScheduler`
`private NiFiProperties`	`properties`
`static Pattern`	`PROVENANCE_EVENT_URI`
`static Pattern`	`PROVENANCE_QUERY_URI`
`static String`	`PROVENANCE_URI`
`static Pattern`	`QUEUE_CONTENTS_URI` Deprecated.
`private WebClusterManager.ClusterManagerLock`	`readLock`
`static Pattern`	`REMOTE_PROCESS_GROUP_URI_PATTERN`
`static Pattern`	`REMOTE_PROCESS_GROUPS_URI_PATTERN`
`private Boolean`	`remoteCommsSecure`
`private Integer`	`remoteInputPort`
`private RemoteSiteListener`	`remoteSiteListener`
`static Pattern`	`REPORTING_TASK_STATE_URI_PATTERN`
`static Pattern`	`REPORTING_TASK_URI_PATTERN`
`static String`	`REPORTING_TASKS_URI`
`private FlowEngine`	`reportingTaskEngine`
`private ConcurrentMap<String,ReportingTaskNode>`	`reportingTasks`
`static String`	`REQUEST_ID_HEADER` HTTP Header that stores a unique ID for each request that is replicated to the nodes.
`private ReentrantReadWriteLock`	`resourceRWLock`
`static String`	`ROOT_GROUP_ID_ALIAS`
`private ClusterManagerProtocolSenderListener`	`senderListener`
`private ClusterServicesBroadcaster`	`servicesBroadcaster`
`private StateManagerProvider`	`stateManagerProvider`
`static Pattern`	`TEMPLATE_INSTANCE_URI_PATTERN`
`private WebClusterManager.ClusterManagerLock`	`writeLock`

Constructor Summary

Constructors
Constructor and Description
`WebClusterManager(HttpRequestReplicator httpRequestReplicator, HttpResponseMapper httpResponseMapper, DataFlowManagementService dataFlowManagementService, ClusterManagerProtocolSenderListener senderListener, NiFiProperties properties, StringEncryptor encryptor, OptimisticLockingManager optimisticLockingManager)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addBroadcastedService(org.apache.nifi.io.socket.multicast.DiscoverableService service)`
`private void`	`addBulletin(NodeIdentifier nodeId, Severity severity, String msg)`
`private void`	`addBulletin(Node node, Severity severity, String msg)`
`void`	`addEvent(NodeIdentifier nodeId, String eventMsg)`
`private NodeIdentifier`	`addRequestorDn(NodeIdentifier nodeId, String dn)`
`private List<StatusSnapshotDTO>`	`aggregate(Map<Date,List<StatusSnapshot>> snapshotsToAggregate)`
`NodeResponse`	`applyRequest(String method, URI uri, Map<String,List<String>> parameters, Map<String,String> headers)` Federates the HTTP request to all connected nodes in the cluster.
`NodeResponse`	`applyRequest(String method, URI uri, Map<String,List<String>> parameters, Map<String,String> headers, Set<NodeIdentifier> nodeIdentifiers)` Federates the HTTP request to the nodes specified.
`NodeResponse`	`applyRequest(String method, URI uri, Object entity, Map<String,String> headers)` Federates the HTTP request to all connected nodes in the cluster.
`NodeResponse`	`applyRequest(String method, URI uri, Object entity, Map<String,String> headers, Set<NodeIdentifier> nodeIdentifiers)` Federates the HTTP request to the nodes specified.
`private boolean`	`assignPrimaryRole(NodeIdentifier nodeId)` Messages the node to have the primary role.
`private boolean`	`canChangeNodeState(String method, URI uri)`
`boolean`	`canHandle(ProtocolMessage msg)`
`private ComponentStatusRepository`	`createComponentStatusRepository()`
`ControllerServiceNode`	`createControllerService(String type, String id, boolean firstTimeAdded)`
`private NodeDTO`	`createNodeDTO(Node node)`
`ReportingTaskNode`	`createReportingTask(String type, String id, boolean firstTimeAdded)`
`StatusHistoryDTO`	`createStatusHistoryDto(StatusHistory statusHistory)`
`void`	`deleteNode(String nodeId, String userDn)` Deletes the node with the given node identifier.
`void`	`disableControllerService(ControllerServiceNode serviceNode)`
`void`	`disableReferencingServices(ControllerServiceNode serviceNode)`
`void`	`disableReportingTask(ReportingTaskNode reportingTask)`
`private void`	`disconnectNodes(Set<NodeResponse> nodeResponses, String explanation)` A helper method to disconnect nodes that returned unsuccessful HTTP responses because of a replicated request.
`private void`	`drainResponses(Collection<NodeResponse> nodeResponses)` Drains the node responses off of the socket to ensure that the socket is appropriately cleaned-up.
`void`	`enableControllerService(ControllerServiceNode serviceNode)`
`void`	`enableControllerServices(Collection<ControllerServiceNode> serviceNodes)`
`void`	`enableReferencingServices(ControllerServiceNode serviceNode)`
`void`	`enableReportingTask(ReportingTaskNode reportingTask)`
`private void`	`executeSafeModeTask()`
`private NodeResponse`	`federateRequest(String method, URI uri, Map<String,List<String>> parameters, Object entity, Map<String,String> headers, Set<NodeIdentifier> nodeIds)`
`Set<ControllerServiceNode>`	`getAllControllerServices()`
`Set<ReportingTaskNode>`	`getAllReportingTasks()`
`BulletinRepository`	`getBulletinRepository()`
`private int`	`getClusterProtocolHeartbeatSeconds()`
`ClusterStatusHistoryDTO`	`getConnectionStatusHistory(String connectionId)`
`ClusterStatusHistoryDTO`	`getConnectionStatusHistory(String connectionId, Date startDate, Date endDate, int preferredDataPoints)`
`ControllerService`	`getControllerService(String serviceIdentifier)`
`Set<String>`	`getControllerServiceIdentifiers(Class<? extends ControllerService> serviceType)`
`String`	`getControllerServiceName(String serviceIdentifier)`
`ControllerServiceNode`	`getControllerServiceNode(String id)`
`int`	`getHeartbeatMonitoringIntervalSeconds()`
`int`	`getMaxHeartbeatGapSeconds()`
`Node`	`getNode(String nodeId)`
`List<Event>`	`getNodeEvents(String nodeId)` Returns a list of node events for the node with the given identifier.
`Set<NodeIdentifier>`	`getNodeIds(Node.Status... statuses)`
`ClusterNodeInformation`	`getNodeInformation()`
`Set<Node>`	`getNodes(Node.Status... statuses)`
`Node`	`getPrimaryNode()`
`private ProcessGroupStatus`	`getProcessGroupStatus(ProcessGroupStatus parent, String groupId)`
`ProcessGroupStatus`	`getProcessGroupStatus(String groupId)`
`ClusterStatusHistoryDTO`	`getProcessGroupStatusHistory(String processGroupId)`
`ClusterStatusHistoryDTO`	`getProcessGroupStatusHistory(String processGroupId, Date startDate, Date endDate, int preferredDataPoints)`
`ClusterStatusHistoryDTO`	`getProcessorStatusHistory(String processorId)`
`ClusterStatusHistoryDTO`	`getProcessorStatusHistory(String processorId, Date startDate, Date endDate, int preferredDataPoints)`
`private Node`	`getRawNode(String nodeId)`
`private Set<Node>`	`getRawNodes(Node.Status... statuses)`
`ClusterStatusHistoryDTO`	`getRemoteProcessGroupStatusHistory(String remoteGroupId)`
`ClusterStatusHistoryDTO`	`getRemoteProcessGroupStatusHistory(String remoteGroupId, Date startDate, Date endDate, int preferredDataPoints)`
`ReportingTaskNode`	`getReportingTaskNode(String taskId)`
`StateManagerProvider`	`getStateManagerProvider()`
`SystemDiagnostics`	`getSystemDiagnostics()`
`ProtocolMessage`	`handle(ProtocolMessage protocolMessage)`
`void`	`handleBulletins(NodeBulletins bulletins)` Handle a bulletins message.
`private ConnectionResponseMessage`	`handleConnectionRequest(ConnectionRequestMessage requestMessage)`
`private void`	`handleControllerStartupFailure(ControllerStartupFailureMessage msg)`
`void`	`handleHeartbeat(Heartbeat heartbeat)` Handles a node's heartbeat.
`private void`	`handleReconnectionFailure(ReconnectionFailureMessage msg)`
`boolean`	`isAuditingConfigured()`
`private boolean`	`isBlockedByFirewall(String ip)` Returns false if an internal protocol message was received by a node listed in the firewall.
`boolean`	`isBroadcasting()`
`boolean`	`isBroadcastingConfigured()`
`boolean`	`isControllerServiceEnabled(ControllerService service)`
`boolean`	`isControllerServiceEnabled(String serviceIdentifier)`
`boolean`	`isControllerServiceEnabling(String serviceIdentifier)`
`private static boolean`	`isControllerServiceEndpoint(URI uri, String method)`
`private static boolean`	`isControllerServiceReferenceEndpoint(URI uri, String method)`
`private static boolean`	`isControllerServicesEndpoint(URI uri, String method)`
`private static boolean`	`isControllerServiceStateEndpoint(URI uri, String method)`
`private static boolean`	`isCountersEndpoint(URI uri)`
`private static boolean`	`isDropRequestEndpoint(URI uri, String method)`
`boolean`	`isFirewallConfigured()`
`private static boolean`	`isFlowSnippetEndpoint(URI uri, String method)`
`private boolean`	`isHeartbeatMonitorRunning()`
`private boolean`	`isInSafeMode()`
`private static boolean`	`isListFlowFilesEndpoint(URI uri, String method)`
`private boolean`	`isMissingCounter(Set<NodeResponse> problematicNodeResponses, URI uri)` Determines if all problematic responses were due to 404 NOT_FOUND.
`private boolean`	`isPrimaryNode(NodeIdentifier nodeId)`
`private static boolean`	`isProcessGroupEndpoint(URI uri, String method)`
`private static boolean`	`isProcessorEndpoint(URI uri, String method)`
`private static boolean`	`isProcessorsEndpoint(URI uri, String method)`
`private static boolean`	`isProcessorStateEndpoint(URI uri, String method)`
`private static boolean`	`isProvenanceEventEndpoint(URI uri, String method)`
`private static boolean`	`isProvenanceQueryEndpoint(URI uri, String method)`
`private static boolean`	`isRemoteProcessGroupEndpoint(URI uri, String method)`
`private static boolean`	`isRemoteProcessGroupsEndpoint(URI uri, String method)`
`private static boolean`	`isReportingTaskEndpoint(URI uri, String method)`
`private static boolean`	`isReportingTasksEndpoint(URI uri, String method)`
`private static boolean`	`isReportingTaskStateEndpoint(URI uri, String method)`
`(package private) static boolean`	`isResponseInterpreted(URI uri, String method)`
`boolean`	`isRunning()`
`private static boolean`	`isTemplateEndpoint(URI uri, String method)`
`private Map<String,ReportingTaskNode>`	`loadReportingTasks(byte[] serialized)`
`private void`	`logNodes(String header, org.slf4j.Logger logger)`
`private void`	`merge(GarbageCollection target, GarbageCollection gc)`
`private void`	`merge(StorageUsage target, StorageUsage du)`
`private void`	`merge(SystemDiagnostics target, SystemDiagnostics sd)`
`private void`	`mergeComponentState(ComponentStateDTO componentState, Map<NodeIdentifier,ComponentStateDTO> componentStateMap)`
`private void`	`mergeControllerService(ControllerServiceDTO controllerService, Map<NodeIdentifier,ControllerServiceDTO> controllerServiceMap)`
`private void`	`mergeControllerServiceReferences(Set<ControllerServiceReferencingComponentDTO> referencingComponents, Map<NodeIdentifier,Set<ControllerServiceReferencingComponentDTO>> referencingComponentMap)`
`private void`	`mergeDropRequests(DropRequestDTO dropRequest, Map<NodeIdentifier,DropRequestDTO> dropRequestMap)` Merges the drop requests in the specified map into the specified drop request.
`private void`	`mergeListingRequests(ListingRequestDTO listingRequest, Map<NodeIdentifier,ListingRequestDTO> listingRequestMap)` Merges the listing requests in the specified map into the specified listing request
`private void`	`mergeProcessorValidationErrors(ProcessorDTO processor, Map<NodeIdentifier,ProcessorDTO> processorMap)`
`private void`	`mergeProvenanceQueryResults(ProvenanceDTO provenanceDto, Map<NodeIdentifier,ProvenanceDTO> resultMap, Set<NodeResponse> problematicResponses)`
`private void`	`mergeRemoteProcessGroup(RemoteProcessGroupDTO remoteProcessGroup, Map<NodeIdentifier,RemoteProcessGroupDTO> remoteProcessGroupMap)`
`private void`	`mergeReportingTask(ReportingTaskDTO reportingTask, Map<NodeIdentifier,ReportingTaskDTO> reportingTaskMap)`
`private NodeResponse`	`mergeResponses(URI uri, String method, Set<NodeResponse> nodeResponses, boolean mutableRequest)`
`void`	`mergeValidationErrors(Map<String,Set<NodeIdentifier>> validationErrorMap, NodeIdentifier nodeId, Collection<String> nodeValidationErrors)` Merges the validation errors into the specified map, recording the corresponding node identifier.
`Set<String>`	`normalizedMergedValidationErrors(Map<String,Set<NodeIdentifier>> validationErrorMap, int totalNodes)` Normalizes the validation errors by prepending the corresponding nodes when the error does not exist across all nodes.
`static Date`	`normalizeStatusSnapshotDate(Date toNormalize, long numMillis)`
`private void`	`notifyComponentsConfigurationRestored()`
`private void`	`notifyDataFlowManagementServiceOfNodeStatusChange()`
`private void`	`notifyDataFlowManagmentServiceOfFlowStateChange(PersistedFlowState newState)`
`private Document`	`parse(byte[] serialized)`
`private void`	`processPendingHeartbeats()`
`boolean`	`removeBroadcastedService(String serviceName)`
`void`	`removeControllerService(ControllerServiceNode serviceNode)`
`void`	`removeReportingTask(ReportingTaskNode reportingTaskNode)`
`ConnectionResponse`	`requestConnection(ConnectionRequest request)` Services connection requests.
`private void`	`requestDisconnection(NodeIdentifier nodeId, boolean ignoreNodeChecks, String explanation)` Issues a disconnection message to the node identified by the given node ID.
`void`	`requestDisconnection(String nodeId, String userDn)` Services a disconnection request.
`private void`	`requestDisconnectionQuietly(NodeIdentifier nodeId, String explanation)` Requests a disconnection to the node with the given node ID, but any exception thrown is suppressed.
`void`	`requestReconnection(String nodeId, String userDn)` Services reconnection requests for a given node.
`private void`	`requestReconnectionAsynchronously(Node node, boolean primaryRole, int reconnectionAttempts, int retrySeconds)`
`private NodeIdentifier`	`resolveProposedNodeIdentifier(NodeIdentifier proposedNodeId)` Resolves a proposed node identifier to a node identifier that the manager approves.
`private boolean`	`revokePrimaryRole(NodeIdentifier nodeId)` Messages the node with the given node ID to no longer have the primary role.
`void`	`saveControllerServices()`
`void`	`saveReportingTasks()`
`void`	`scheduleReferencingComponents(ControllerServiceNode serviceNode)`
`private byte[]`	`serialize(Document doc)`
`private byte[]`	`serializeControllerServices()`
`private byte[]`	`serializeReportingTasks()`
`void`	`setAuditService(AuditService auditService)`
`void`	`setClusterFirewall(ClusterNodeFirewall clusterFirewall)`
`void`	`setEventManager(EventManager eventManager)`
`void`	`setPrimaryNode(String nodeId, String userDn)` Revokes the primary role from the current primary node and assigns the primary role to given given node ID.
`private void`	`setPrimaryNodeId(NodeIdentifier primaryNodeId)`
`void`	`setServicesBroadcaster(ClusterServicesBroadcaster servicesBroadcaster)`
`void`	`start()`
`void`	`startReportingTask(ReportingTaskNode reportingTaskNode)`
`void`	`stop()`
`void`	`stopReportingTask(ReportingTaskNode reportingTaskNode)`
`void`	`unscheduleReferencingComponents(ControllerServiceNode serviceNode)`
`void`	`verifyCanDisableReferencingServices(ControllerServiceNode serviceNode)`
`void`	`verifyCanEnableReferencingServices(ControllerServiceNode serviceNode)`
`void`	`verifyCanScheduleReferencingComponents(ControllerServiceNode serviceNode)`
`void`	`verifyCanStopReferencingComponents(ControllerServiceNode serviceNode)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROOT_GROUP_ID_ALIAS

public static final String ROOT_GROUP_ID_ALIAS

See Also:: Constant Field Values

BULLETIN_CATEGORY

public static final String BULLETIN_CATEGORY

See Also:: Constant Field Values

logger

private static final org.slf4j.Logger logger

heartbeatLogger

private static final org.slf4j.Logger heartbeatLogger

CLUSTER_CONTEXT_HTTP_HEADER
```
public static final String CLUSTER_CONTEXT_HTTP_HEADER
```
The HTTP header to store a cluster context. An example of what may be stored in the context is a node's auditable actions in response to a cluster request. The cluster context is serialized using Java's serialization mechanism and hex encoded.

See Also:

Constant Field Values

REQUEST_ID_HEADER
```
public static final String REQUEST_ID_HEADER
```
HTTP Header that stores a unique ID for each request that is replicated to the nodes. This is used for logging purposes so that request information, such as timing, can be correlated between the NCM and the nodes

See Also:

Constant Field Values

NCM_EXPECTS_HTTP_HEADER
```
public static final String NCM_EXPECTS_HTTP_HEADER
```
The HTTP header that the NCM specifies to ask a node if they are able to process a given request. The value is always 150-NodeContinue. The node will respond with 150 CONTINUE if it is able to process the request, 417 EXPECTATION_FAILED otherwise.

See Also:

Constant Field Values

NODE_CONTINUE_STATUS_CODE
```
public static final int NODE_CONTINUE_STATUS_CODE
```
See Also:

Constant Field Values

CLUSTER_INVALIDATE_USER_GROUP_HEADER
```
public static final String CLUSTER_INVALIDATE_USER_GROUP_HEADER
```
The HTTP header that the NCM specifies to indicate that a node should invalidate the specified user group. This is done to ensure that user cache is not stale when an administrator modifies a group through the UI.

See Also:

Constant Field Values

CLUSTER_INVALIDATE_USER_HEADER
```
public static final String CLUSTER_INVALIDATE_USER_HEADER
```
The HTTP header that the NCM specifies to indicate that a node should invalidate the specified user. This is done to ensure that user cache is not stale when an administrator modifies a user through the UI.

See Also:

Constant Field Values

DEFAULT_CONNECTION_REQUEST_TRY_AGAIN_SECONDS
```
private static final int DEFAULT_CONNECTION_REQUEST_TRY_AGAIN_SECONDS
```
The default number of seconds to respond to a connecting node if the manager cannot provide it with a current data flow.

See Also:

Constant Field Values

DEFAULT_COMPONENT_STATUS_REPO_IMPLEMENTATION

public static final String DEFAULT_COMPONENT_STATUS_REPO_IMPLEMENTATION

See Also:: Constant Field Values

PROCESSORS_URI_PATTERN

public static final Pattern PROCESSORS_URI_PATTERN

PROCESSOR_URI_PATTERN

public static final Pattern PROCESSOR_URI_PATTERN

PROCESSOR_STATE_URI_PATTERN

public static final Pattern PROCESSOR_STATE_URI_PATTERN

CLUSTER_PROCESSOR_URI_PATTERN

public static final Pattern CLUSTER_PROCESSOR_URI_PATTERN

REMOTE_PROCESS_GROUPS_URI_PATTERN

public static final Pattern REMOTE_PROCESS_GROUPS_URI_PATTERN

REMOTE_PROCESS_GROUP_URI_PATTERN

public static final Pattern REMOTE_PROCESS_GROUP_URI_PATTERN

PROCESS_GROUP_URI_PATTERN

public static final Pattern PROCESS_GROUP_URI_PATTERN

TEMPLATE_INSTANCE_URI_PATTERN

public static final Pattern TEMPLATE_INSTANCE_URI_PATTERN

FLOW_SNIPPET_INSTANCE_URI_PATTERN

public static final Pattern FLOW_SNIPPET_INSTANCE_URI_PATTERN

PROVENANCE_URI

public static final String PROVENANCE_URI

See Also:: Constant Field Values

PROVENANCE_QUERY_URI

public static final Pattern PROVENANCE_QUERY_URI

PROVENANCE_EVENT_URI

public static final Pattern PROVENANCE_EVENT_URI

COUNTERS_URI

public static final Pattern COUNTERS_URI

CONTROLLER_SERVICES_URI

public static final String CONTROLLER_SERVICES_URI

See Also:: Constant Field Values

CONTROLLER_SERVICE_URI_PATTERN

public static final Pattern CONTROLLER_SERVICE_URI_PATTERN

CONTROLLER_SERVICE_STATE_URI_PATTERN

public static final Pattern CONTROLLER_SERVICE_STATE_URI_PATTERN

CONTROLLER_SERVICE_REFERENCES_URI_PATTERN

public static final Pattern CONTROLLER_SERVICE_REFERENCES_URI_PATTERN

REPORTING_TASKS_URI

public static final String REPORTING_TASKS_URI

See Also:: Constant Field Values

REPORTING_TASK_URI_PATTERN

public static final Pattern REPORTING_TASK_URI_PATTERN

REPORTING_TASK_STATE_URI_PATTERN

public static final Pattern REPORTING_TASK_STATE_URI_PATTERN

QUEUE_CONTENTS_URI

@Deprecated
public static final Pattern QUEUE_CONTENTS_URI

Deprecated.

DROP_REQUESTS_URI

public static final Pattern DROP_REQUESTS_URI

DROP_REQUEST_URI

public static final Pattern DROP_REQUEST_URI

LISTING_REQUESTS_URI

public static final Pattern LISTING_REQUESTS_URI

LISTING_REQUEST_URI

public static final Pattern LISTING_REQUEST_URI

properties

private final NiFiProperties properties

httpRequestReplicator

private final HttpRequestReplicator httpRequestReplicator

httpResponseMapper

private final HttpResponseMapper httpResponseMapper

dataFlowManagementService

private final DataFlowManagementService dataFlowManagementService

senderListener

private final ClusterManagerProtocolSenderListener senderListener

optimisticLockingManager

private final OptimisticLockingManager optimisticLockingManager

encryptor

private final StringEncryptor encryptor

pendingHeartbeats

private final Queue<Heartbeat> pendingHeartbeats

resourceRWLock

private final ReentrantReadWriteLock resourceRWLock

readLock

private final WebClusterManager.ClusterManagerLock readLock

writeLock

private final WebClusterManager.ClusterManagerLock writeLock

nodes
```
private final Set<Node> nodes
```

reportingTasks

private final ConcurrentMap<String,ReportingTaskNode> reportingTasks

cachedDataFlow

private StandardDataFlow cachedDataFlow

primaryNodeId
```
private NodeIdentifier primaryNodeId
```

heartbeatMonitor
```
private Timer heartbeatMonitor
```

heartbeatProcessor
```
private Timer heartbeatProcessor
```

servicesBroadcaster

private volatile ClusterServicesBroadcaster servicesBroadcaster

eventManager

private volatile EventManager eventManager

clusterFirewall

private volatile ClusterNodeFirewall clusterFirewall

auditService

private volatile AuditService auditService

controllerServiceProvider

private volatile ControllerServiceProvider controllerServiceProvider

remoteSiteListener

private final RemoteSiteListener remoteSiteListener

remoteInputPort
```
private final Integer remoteInputPort
```

remoteCommsSecure

private final Boolean remoteCommsSecure

bulletinRepository

private final BulletinRepository bulletinRepository

instanceId
```
private final String instanceId
```

reportingTaskEngine

private final FlowEngine reportingTaskEngine

componentMetricsRepositoryMap

private final Map<NodeIdentifier,ComponentStatusRepository> componentMetricsRepositoryMap

processScheduler

private final StandardProcessScheduler processScheduler

stateManagerProvider

private final StateManagerProvider stateManagerProvider

componentStatusSnapshotMillis

private final long componentStatusSnapshotMillis

Constructor Detail

WebClusterManager

public WebClusterManager(HttpRequestReplicator httpRequestReplicator,
                         HttpResponseMapper httpResponseMapper,
                         DataFlowManagementService dataFlowManagementService,
                         ClusterManagerProtocolSenderListener senderListener,
                         NiFiProperties properties,
                         StringEncryptor encryptor,
                         OptimisticLockingManager optimisticLockingManager)

Method Detail

start

public void start()
           throws IOException

Throws:: IOException

stop

public void stop()
          throws IOException

Throws:: IOException

isRunning
```
public boolean isRunning()
```

canHandle
```
public boolean canHandle(ProtocolMessage msg)
```
Specified by:

canHandle in interface ProtocolHandler

handle

public ProtocolMessage handle(ProtocolMessage protocolMessage)
                       throws ProtocolException

Specified by:: handle in interface ProtocolHandler
Throws:: ProtocolException

notifyComponentsConfigurationRestored

private void notifyComponentsConfigurationRestored()

requestConnection
```
public ConnectionResponse requestConnection(ConnectionRequest request)
```
Services connection requests. If the data flow management service is unable to provide a current copy of the data flow, then the returned connection response will indicate the node should try later. Otherwise, the connection response will contain the the flow and the node identifier. If this instance is configured with a firewall and the request is blocked, then the response will not contain a node identifier.

Specified by:

requestConnection in interface ClusterManager

Parameters:

request - a connection request

Returns:

a connection response

requestReconnection
```
public void requestReconnection(String nodeId,
                                String userDn)
                         throws UnknownNodeException,
                                IllegalNodeReconnectionException
```
Services reconnection requests for a given node. If the node indicates reconnection failure, then the node will be set to disconnected and if the node has primary role, then the role will be revoked. Otherwise, a reconnection request will be sent to the node, initiating the connection handshake.

Specified by:

requestReconnection in interface ClusterManager

Parameters:

nodeId - a node identifier

userDn - the Distinguished Name of the user requesting the reconnection

Throws:

UnknownNodeException - if the node does not exist

IllegalNodeReconnectionException - if the node cannot be reconnected because the node is not disconnected

NodeReconnectionException - if the reconnection message failed to be sent or the cluster could not provide a current data flow for the reconnection request

requestReconnectionAsynchronously

private void requestReconnectionAsynchronously(Node node,
                                               boolean primaryRole,
                                               int reconnectionAttempts,
                                               int retrySeconds)

loadReportingTasks

private Map<String,ReportingTaskNode> loadReportingTasks(byte[] serialized)

createReportingTask

public ReportingTaskNode createReportingTask(String type,
                                             String id,
                                             boolean firstTimeAdded)
                                      throws ReportingTaskInstantiationException

Specified by:: createReportingTask in interface ReportingTaskProvider
Throws:: ReportingTaskInstantiationException

parse

private Document parse(byte[] serialized)
                throws SAXException,
                       ParserConfigurationException,
                       IOException

Throws:: SAXException; ParserConfigurationException; IOException

addBulletin

private void addBulletin(Node node,
                         Severity severity,
                         String msg)

addBulletin

private void addBulletin(NodeIdentifier nodeId,
                         Severity severity,
                         String msg)

requestDisconnection
```
public void requestDisconnection(String nodeId,
                                 String userDn)
                          throws UnknownNodeException,
                                 IllegalNodeDisconnectionException,
                                 NodeDisconnectionException
```
Services a disconnection request.

Specified by:

requestDisconnection in interface ClusterManager

Parameters:

nodeId - a node identifier

userDn - the DN of the user requesting the disconnection

Throws:

UnknownNodeException - if the node does not exist

IllegalNodeDisconnectionException - if the node cannot be disconnected due to the cluster's state (e.g., node is last connected node or node is primary)

NodeDisconnectionException - if the disconnection message fails to be sent.

requestDisconnectionQuietly

private void requestDisconnectionQuietly(NodeIdentifier nodeId,
                                         String explanation)

Requests a disconnection to the node with the given node ID, but any exception thrown is suppressed.

Parameters:: nodeId - the node ID

requestDisconnection
```
private void requestDisconnection(NodeIdentifier nodeId,
                                  boolean ignoreNodeChecks,
                                  String explanation)
                           throws IllegalNodeDisconnectionException,
                                  NodeDisconnectionException
```
Issues a disconnection message to the node identified by the given node ID. If the node is not known, then a UnknownNodeException is thrown. If the node cannot be disconnected due to the cluster's state and ignoreLastNodeCheck is false, then a IllegalNodeDisconnectionException is thrown. Otherwise, a disconnection message is issued to the node. Whether the disconnection message is successfully sent to the node, the node is marked as disconnected and if the node is the primary node, then the primary role is revoked.

Parameters:

nodeId - the ID of the node

ignoreNodeChecks - if false, checks will be made to ensure the cluster supports the node's disconnection (e.g., the node is not the last connected node in the cluster; the node is not the primary); otherwise, the request is made regardless of the cluster state

explanation -

Throws:

IllegalNodeDisconnectionException - if the node cannot be disconnected due to the cluster's state (e.g., node is last connected node or node is primary). Not thrown if ignoreNodeChecks is true.

NodeDisconnectionException - if the disconnection message fails to be sent.

assignPrimaryRole
```
private boolean assignPrimaryRole(NodeIdentifier nodeId)
```
Messages the node to have the primary role. If the messaging fails, then the node is marked as disconnected.

Parameters:

nodeId - the node ID to assign primary role

Returns:

true if primary role assigned; false otherwise

revokePrimaryRole
```
private boolean revokePrimaryRole(NodeIdentifier nodeId)
```
Messages the node with the given node ID to no longer have the primary role. If the messaging fails, then the node is marked as disconnected.

Returns:

true if the primary role was revoked from the node; false otherwise

addRequestorDn

private NodeIdentifier addRequestorDn(NodeIdentifier nodeId,
                                      String dn)

handleConnectionRequest

private ConnectionResponseMessage handleConnectionRequest(ConnectionRequestMessage requestMessage)

handleControllerStartupFailure

private void handleControllerStartupFailure(ControllerStartupFailureMessage msg)

handleReconnectionFailure

private void handleReconnectionFailure(ReconnectionFailureMessage msg)

createControllerService

public ControllerServiceNode createControllerService(String type,
                                                     String id,
                                                     boolean firstTimeAdded)

Specified by:: createControllerService in interface ControllerServiceProvider

getStateManagerProvider

public StateManagerProvider getStateManagerProvider()

getControllerService
```
public ControllerService getControllerService(String serviceIdentifier)
```
Specified by:

getControllerService 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

isControllerServiceEnabling
```
public boolean isControllerServiceEnabling(String serviceIdentifier)
```
Specified by:

isControllerServiceEnabling in interface ControllerServiceLookup

getControllerServiceName
```
public String getControllerServiceName(String serviceIdentifier)
```
Specified by:

getControllerServiceName in interface ControllerServiceLookup

removeControllerService
```
public void removeControllerService(ControllerServiceNode serviceNode)
```
Specified by:

removeControllerService in interface ControllerServiceProvider

enableControllerService
```
public void enableControllerService(ControllerServiceNode serviceNode)
```
Specified by:

enableControllerService in interface ControllerServiceProvider

enableControllerServices
```
public void enableControllerServices(Collection<ControllerServiceNode> serviceNodes)
```
Specified by:

enableControllerServices in interface ControllerServiceProvider

disableControllerService
```
public void disableControllerService(ControllerServiceNode serviceNode)
```
Specified by:

disableControllerService in interface ControllerServiceProvider

getAllControllerServices
```
public Set<ControllerServiceNode> getAllControllerServices()
```
Specified by:

getAllControllerServices in interface ControllerServiceProvider

disableReferencingServices
```
public void disableReferencingServices(ControllerServiceNode serviceNode)
```
Specified by:

disableReferencingServices in interface ControllerServiceProvider

enableReferencingServices
```
public void enableReferencingServices(ControllerServiceNode serviceNode)
```
Specified by:

enableReferencingServices in interface ControllerServiceProvider

scheduleReferencingComponents
```
public void scheduleReferencingComponents(ControllerServiceNode serviceNode)
```
Specified by:

scheduleReferencingComponents in interface ControllerServiceProvider

unscheduleReferencingComponents
```
public void unscheduleReferencingComponents(ControllerServiceNode serviceNode)
```
Specified by:

unscheduleReferencingComponents in interface ControllerServiceProvider

verifyCanEnableReferencingServices
```
public void verifyCanEnableReferencingServices(ControllerServiceNode serviceNode)
```
Specified by:

verifyCanEnableReferencingServices in interface ControllerServiceProvider

verifyCanScheduleReferencingComponents
```
public void verifyCanScheduleReferencingComponents(ControllerServiceNode serviceNode)
```
Specified by:

verifyCanScheduleReferencingComponents in interface ControllerServiceProvider

verifyCanDisableReferencingServices
```
public void verifyCanDisableReferencingServices(ControllerServiceNode serviceNode)
```
Specified by:

verifyCanDisableReferencingServices in interface ControllerServiceProvider

verifyCanStopReferencingComponents
```
public void verifyCanStopReferencingComponents(ControllerServiceNode serviceNode)
```
Specified by:

verifyCanStopReferencingComponents in interface ControllerServiceProvider

serialize

private byte[] serialize(Document doc)
                  throws TransformerException

Throws:: TransformerException

serializeControllerServices

private byte[] serializeControllerServices()
                                    throws ParserConfigurationException,
                                           TransformerException

Throws:: ParserConfigurationException; TransformerException

serializeReportingTasks

private byte[] serializeReportingTasks()
                                throws ParserConfigurationException,
                                       TransformerException

Throws:: ParserConfigurationException; TransformerException

saveControllerServices
```
public void saveControllerServices()
```

saveReportingTasks
```
public void saveReportingTasks()
```

getAllReportingTasks
```
public Set<ReportingTaskNode> getAllReportingTasks()
```
Specified by:

getAllReportingTasks in interface ReportingTaskProvider

getReportingTaskNode
```
public ReportingTaskNode getReportingTaskNode(String taskId)
```
Specified by:

getReportingTaskNode in interface ReportingTaskProvider

startReportingTask
```
public void startReportingTask(ReportingTaskNode reportingTaskNode)
```
Specified by:

startReportingTask in interface ReportingTaskProvider

stopReportingTask
```
public void stopReportingTask(ReportingTaskNode reportingTaskNode)
```
Specified by:

stopReportingTask in interface ReportingTaskProvider

removeReportingTask
```
public void removeReportingTask(ReportingTaskNode reportingTaskNode)
```
Specified by:

removeReportingTask in interface ReportingTaskProvider

disableReportingTask
```
public void disableReportingTask(ReportingTaskNode reportingTask)
```
Specified by:

disableReportingTask in interface ReportingTaskProvider

enableReportingTask
```
public void enableReportingTask(ReportingTaskNode reportingTask)
```
Specified by:

enableReportingTask in interface ReportingTaskProvider

handleBulletins
```
public void handleBulletins(NodeBulletins bulletins)
```
Handle a bulletins message.

Parameters:

bulletins - bulletins

handleHeartbeat
```
public void handleHeartbeat(Heartbeat heartbeat)
```
Handles a node's heartbeat. If this heartbeat is a node's first heartbeat since its connection request, then the manager will mark the node as connected. If the node was previously disconnected due to a lack of heartbeat, then a reconnection request is issued. If the node was disconnected for other reasons, then a disconnection request is issued. If this instance is configured with a firewall and the heartbeat is blocked, then a disconnection request is issued.

Specified by:

handleHeartbeat in interface ClusterManager

Parameters:

heartbeat - a heartbeat

processPendingHeartbeats

private void processPendingHeartbeats()

createComponentStatusRepository

private ComponentStatusRepository createComponentStatusRepository()

getNodes
```
public Set<Node> getNodes(Node.Status... statuses)
```
Specified by:

getNodes in interface ClusterManager

Parameters:

statuses - the statuses of the nodes

Returns:

the set of nodes

getNode
```
public Node getNode(String nodeId)
```
Specified by:

getNode in interface ClusterManager

Parameters:

nodeId - node identifier

Returns:

returns the node with the given identifier or null if node does not exist

getPrimaryNode
```
public Node getPrimaryNode()
```
Specified by:

getPrimaryNode in interface ClusterManager

Returns:

the primary node of the cluster or null if no primary node exists

deleteNode
```
public void deleteNode(String nodeId,
                       String userDn)
                throws UnknownNodeException,
                       IllegalNodeDeletionException
```
Description copied from interface: ClusterManager

Deletes the node with the given node identifier. If the given node is the primary node, then a subsequent request may be made to the manager to set a new primary node.

Specified by:

deleteNode in interface ClusterManager

Parameters:

nodeId - the node identifier

userDn - the Distinguished Name of the user requesting the node be deleted from the cluster

Throws:

UnknownNodeException - if the node does not exist

IllegalNodeDeletionException - if the node is not in a disconnected state

getNodeIds
```
public Set<NodeIdentifier> getNodeIds(Node.Status... statuses)
```
Specified by:

getNodeIds in interface ClusterManager

Parameters:

statuses - statuses

Returns:

the set of node identifiers with the given node status

setPrimaryNode
```
public void setPrimaryNode(String nodeId,
                           String userDn)
                    throws UnknownNodeException,
                           IneligiblePrimaryNodeException,
                           PrimaryRoleAssignmentException
```
Description copied from interface: ClusterManager

Revokes the primary role from the current primary node and assigns the primary role to given given node ID. If role revocation fails, then the current primary node is set to disconnected while retaining the primary role and no role assignment is performed. If role assignment fails, then the given node is set to disconnected and is given the primary role.

Specified by:

setPrimaryNode in interface ClusterManager

Parameters:

nodeId - the node identifier

userDn - the Distinguished Name of the user requesting that the Primary Node be assigned

Throws:

UnknownNodeException - if the node with the given identifier does not exist

IneligiblePrimaryNodeException - if the node with the given identifier is not eligible to be the primary node

PrimaryRoleAssignmentException - if the cluster was unable to change the primary role to the requested node

getClusterProtocolHeartbeatSeconds

private int getClusterProtocolHeartbeatSeconds()

getHeartbeatMonitoringIntervalSeconds
```
public int getHeartbeatMonitoringIntervalSeconds()
```
Specified by:

getHeartbeatMonitoringIntervalSeconds in interface ClusterManager

Returns:

the time in seconds to wait between successive executions of heartbeat monitoring

getMaxHeartbeatGapSeconds
```
public int getMaxHeartbeatGapSeconds()
```
Specified by:

getMaxHeartbeatGapSeconds in interface ClusterManager

Returns:

the maximum time in seconds that is allowed between successive heartbeats of a node before disconnecting the node

getNodeEvents
```
public List<Event> getNodeEvents(String nodeId)
```
Description copied from interface: ClusterManager

Returns a list of node events for the node with the given identifier. The events will be returned in order of most recent to least recent according to the creation date of the event.

Specified by:

getNodeEvents in interface ClusterManager

Parameters:

nodeId - the node identifier

Returns:

the list of events or an empty list if no node exists with the given identifier

applyRequest
```
public NodeResponse applyRequest(String method,
                                 URI uri,
                                 Map<String,List<String>> parameters,
                                 Map<String,String> headers)
                          throws NoConnectedNodesException,
                                 NoResponseFromNodesException,
                                 UriConstructionException,
                                 ConnectingNodeMutableRequestException,
                                 DisconnectedNodeMutableRequestException,
                                 SafeModeMutableRequestException
```
Description copied from interface: HttpClusterManager

Federates the HTTP request to all connected nodes in the cluster. The given URI's host and port will not be used and instead will be adjusted for each node's host and port. The node URIs are guaranteed to be constructed before issuing any requests, so if a UriConstructionException is thrown, then it is guaranteed that no request was issued.

Specified by:

applyRequest in interface HttpClusterManager

Parameters:

method - the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD)

uri - the base request URI (up to, but not including, the query string)

parameters - the request parameters

headers - the request headers

Returns:

the client response

Throws:

NoConnectedNodesException - if no nodes are connected as results of the request

NoResponseFromNodesException - if no response could be obtained

UriConstructionException - if there was an issue constructing the URIs tailored for each individual node

ConnectingNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is connecting to the cluster

DisconnectedNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is disconnected from the cluster

SafeModeMutableRequestException - if the request was a PUT, POST, DELETE and a the cluster is in safe mode

applyRequest
```
public NodeResponse applyRequest(String method,
                                 URI uri,
                                 Map<String,List<String>> parameters,
                                 Map<String,String> headers,
                                 Set<NodeIdentifier> nodeIdentifiers)
                          throws NoConnectedNodesException,
                                 NoResponseFromNodesException,
                                 UriConstructionException,
                                 ConnectingNodeMutableRequestException,
                                 DisconnectedNodeMutableRequestException,
                                 SafeModeMutableRequestException
```
Description copied from interface: HttpClusterManager

Federates the HTTP request to the nodes specified. The given URI's host and port will not be used and instead will be adjusted for each node's host and port. The node URIs are guaranteed to be constructed before issuing any requests, so if a UriConstructionException is thrown, then it is guaranteed that no request was issued.

Specified by:

applyRequest in interface HttpClusterManager

Parameters:

method - the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD)

uri - the base request URI (up to, but not including, the query string)

parameters - the request parameters

headers - the request headers

nodeIdentifiers - the NodeIdentifier for each node that the request should be replaced to

Returns:

the client response

Throws:

NoConnectedNodesException - if no nodes are connected as results of the request

NoResponseFromNodesException - if no response could be obtained

UriConstructionException - if there was an issue constructing the URIs tailored for each individual node

ConnectingNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is connecting to the cluster

DisconnectedNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is disconnected from the cluster

SafeModeMutableRequestException - if the request was a PUT, POST, DELETE and a the cluster is in safe mode

applyRequest
```
public NodeResponse applyRequest(String method,
                                 URI uri,
                                 Object entity,
                                 Map<String,String> headers)
                          throws NoConnectedNodesException,
                                 NoResponseFromNodesException,
                                 UriConstructionException,
                                 ConnectingNodeMutableRequestException,
                                 DisconnectedNodeMutableRequestException,
                                 SafeModeMutableRequestException
```
Description copied from interface: HttpClusterManager

Federates the HTTP request to all connected nodes in the cluster. The given URI's host and port will not be used and instead will be adjusted for each node's host and port. The node URIs are guaranteed to be constructed before issuing any requests, so if a UriConstructionException is thrown, then it is guaranteed that no request was issued.

Specified by:

applyRequest in interface HttpClusterManager

Parameters:

method - the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD)

uri - the base request URI (up to, but not including, the query string)

entity - the HTTP request entity

headers - the request headers

Returns:

the client response

Throws:

NoConnectedNodesException - if no nodes are connected as results of the request

NoResponseFromNodesException - if no response could be obtained

UriConstructionException - if there was an issue constructing the URIs tailored for each individual node

ConnectingNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is connecting to the cluster

DisconnectedNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is disconnected from the cluster

SafeModeMutableRequestException - if the request was a PUT, POST, DELETE and a the cluster is in safe mode

applyRequest
```
public NodeResponse applyRequest(String method,
                                 URI uri,
                                 Object entity,
                                 Map<String,String> headers,
                                 Set<NodeIdentifier> nodeIdentifiers)
                          throws NoConnectedNodesException,
                                 NoResponseFromNodesException,
                                 UriConstructionException,
                                 ConnectingNodeMutableRequestException,
                                 DisconnectedNodeMutableRequestException,
                                 SafeModeMutableRequestException
```
Description copied from interface: HttpClusterManager

Federates the HTTP request to the nodes specified. The given URI's host and port will not be used and instead will be adjusted for each node's host and port. The node URIs are guaranteed to be constructed before issuing any requests, so if a UriConstructionException is thrown, then it is guaranteed that no request was issued.

Specified by:

applyRequest in interface HttpClusterManager

Parameters:

method - the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD)

uri - the base request URI (up to, but not including, the query string)

entity - the HTTP request entity

headers - the request headers

nodeIdentifiers - the NodeIdentifier for each node that the request should be replaced to

Returns:

the client response

Throws:

NoConnectedNodesException - if no nodes are connected as results of the request

NoResponseFromNodesException - if no response could be obtained

UriConstructionException - if there was an issue constructing the URIs tailored for each individual node

ConnectingNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is connecting to the cluster

DisconnectedNodeMutableRequestException - if the request was a PUT, POST, DELETE and a node is disconnected from the cluster

SafeModeMutableRequestException - if the request was a PUT, POST, DELETE and a the cluster is in safe mode

setServicesBroadcaster

public void setServicesBroadcaster(ClusterServicesBroadcaster servicesBroadcaster)

addBroadcastedService

public boolean addBroadcastedService(org.apache.nifi.io.socket.multicast.DiscoverableService service)

removeBroadcastedService

public boolean removeBroadcastedService(String serviceName)

isBroadcastingConfigured

public boolean isBroadcastingConfigured()

isBroadcasting
```
public boolean isBroadcasting()
```

addEvent

public void addEvent(NodeIdentifier nodeId,
                     String eventMsg)

setEventManager

public void setEventManager(EventManager eventManager)

setClusterFirewall

public void setClusterFirewall(ClusterNodeFirewall clusterFirewall)

isFirewallConfigured
```
public boolean isFirewallConfigured()
```

setAuditService

public void setAuditService(AuditService auditService)

isAuditingConfigured
```
public boolean isAuditingConfigured()
```

isPrimaryNode

private boolean isPrimaryNode(NodeIdentifier nodeId)

isInSafeMode
```
private boolean isInSafeMode()
```

setPrimaryNodeId

private void setPrimaryNodeId(NodeIdentifier primaryNodeId)
                       throws DaoException

Throws:: DaoException

federateRequest

private NodeResponse federateRequest(String method,
                                     URI uri,
                                     Map<String,List<String>> parameters,
                                     Object entity,
                                     Map<String,String> headers,
                                     Set<NodeIdentifier> nodeIds)
                              throws UriConstructionException

Throws:: UriConstructionException

isProcessorsEndpoint

private static boolean isProcessorsEndpoint(URI uri,
                                            String method)

isProcessorEndpoint

private static boolean isProcessorEndpoint(URI uri,
                                           String method)

isProcessorStateEndpoint

private static boolean isProcessorStateEndpoint(URI uri,
                                                String method)

isProcessGroupEndpoint

private static boolean isProcessGroupEndpoint(URI uri,
                                              String method)

isTemplateEndpoint

private static boolean isTemplateEndpoint(URI uri,
                                          String method)

isFlowSnippetEndpoint

private static boolean isFlowSnippetEndpoint(URI uri,
                                             String method)

isRemoteProcessGroupsEndpoint

private static boolean isRemoteProcessGroupsEndpoint(URI uri,
                                                     String method)

isRemoteProcessGroupEndpoint

private static boolean isRemoteProcessGroupEndpoint(URI uri,
                                                    String method)

isProvenanceQueryEndpoint

private static boolean isProvenanceQueryEndpoint(URI uri,
                                                 String method)

isProvenanceEventEndpoint

private static boolean isProvenanceEventEndpoint(URI uri,
                                                 String method)

isListFlowFilesEndpoint

private static boolean isListFlowFilesEndpoint(URI uri,
                                               String method)

isCountersEndpoint

private static boolean isCountersEndpoint(URI uri)

isControllerServicesEndpoint

private static boolean isControllerServicesEndpoint(URI uri,
                                                    String method)

isControllerServiceEndpoint

private static boolean isControllerServiceEndpoint(URI uri,
                                                   String method)

isControllerServiceStateEndpoint

private static boolean isControllerServiceStateEndpoint(URI uri,
                                                        String method)

isControllerServiceReferenceEndpoint

private static boolean isControllerServiceReferenceEndpoint(URI uri,
                                                            String method)

isReportingTasksEndpoint

private static boolean isReportingTasksEndpoint(URI uri,
                                                String method)

isReportingTaskEndpoint

private static boolean isReportingTaskEndpoint(URI uri,
                                               String method)

isReportingTaskStateEndpoint

private static boolean isReportingTaskStateEndpoint(URI uri,
                                                    String method)

isDropRequestEndpoint

private static boolean isDropRequestEndpoint(URI uri,
                                             String method)

isResponseInterpreted

static boolean isResponseInterpreted(URI uri,
                                     String method)

mergeProcessorValidationErrors

private void mergeProcessorValidationErrors(ProcessorDTO processor,
                                            Map<NodeIdentifier,ProcessorDTO> processorMap)

mergeComponentState

private void mergeComponentState(ComponentStateDTO componentState,
                                 Map<NodeIdentifier,ComponentStateDTO> componentStateMap)

mergeProvenanceQueryResults

private void mergeProvenanceQueryResults(ProvenanceDTO provenanceDto,
                                         Map<NodeIdentifier,ProvenanceDTO> resultMap,
                                         Set<NodeResponse> problematicResponses)

mergeRemoteProcessGroup

private void mergeRemoteProcessGroup(RemoteProcessGroupDTO remoteProcessGroup,
                                     Map<NodeIdentifier,RemoteProcessGroupDTO> remoteProcessGroupMap)

mergeControllerServiceReferences

private void mergeControllerServiceReferences(Set<ControllerServiceReferencingComponentDTO> referencingComponents,
                                              Map<NodeIdentifier,Set<ControllerServiceReferencingComponentDTO>> referencingComponentMap)

mergeControllerService

private void mergeControllerService(ControllerServiceDTO controllerService,
                                    Map<NodeIdentifier,ControllerServiceDTO> controllerServiceMap)

mergeReportingTask

private void mergeReportingTask(ReportingTaskDTO reportingTask,
                                Map<NodeIdentifier,ReportingTaskDTO> reportingTaskMap)

mergeValidationErrors

public void mergeValidationErrors(Map<String,Set<NodeIdentifier>> validationErrorMap,
                                  NodeIdentifier nodeId,
                                  Collection<String> nodeValidationErrors)

Merges the validation errors into the specified map, recording the corresponding node identifier.

Parameters:: validationErrorMap - map; nodeId - id; nodeValidationErrors - errors

normalizedMergedValidationErrors
```
public Set<String> normalizedMergedValidationErrors(Map<String,Set<NodeIdentifier>> validationErrorMap,
                                                    int totalNodes)
```
Normalizes the validation errors by prepending the corresponding nodes when the error does not exist across all nodes.

Parameters:

validationErrorMap - map

totalNodes - total

Returns:

normalized errors

mergeListingRequests
```
private void mergeListingRequests(ListingRequestDTO listingRequest,
                                  Map<NodeIdentifier,ListingRequestDTO> listingRequestMap)
```
Merges the listing requests in the specified map into the specified listing request

Parameters:

listingRequest - the target listing request

listingRequestMap - the mapping of all responses being merged

mergeDropRequests
```
private void mergeDropRequests(DropRequestDTO dropRequest,
                               Map<NodeIdentifier,DropRequestDTO> dropRequestMap)
```
Merges the drop requests in the specified map into the specified drop request.

Parameters:

dropRequest - the target drop request

dropRequestMap - the mapping of all responses being merged

mergeResponses

private NodeResponse mergeResponses(URI uri,
                                    String method,
                                    Set<NodeResponse> nodeResponses,
                                    boolean mutableRequest)

isMissingCounter
```
private boolean isMissingCounter(Set<NodeResponse> problematicNodeResponses,
                                 URI uri)
```
Determines if all problematic responses were due to 404 NOT_FOUND. Assumes that problematicNodeResponses is not empty and is not comprised of responses from all nodes in the cluster (at least one node contained the counter in question).

Parameters:

problematicNodeResponses - The problematic node responses

uri - The URI for the request

Returns:

Whether all problematic node responses were due to a missing counter

drainResponses
```
private void drainResponses(Collection<NodeResponse> nodeResponses)
```
Drains the node responses off of the socket to ensure that the socket is appropriately cleaned-up.

Parameters:

nodeResponses - the collection of node responses

disconnectNodes
```
private void disconnectNodes(Set<NodeResponse> nodeResponses,
                             String explanation)
```
A helper method to disconnect nodes that returned unsuccessful HTTP responses because of a replicated request. Disconnection requests are sent concurrently.

isBlockedByFirewall
```
private boolean isBlockedByFirewall(String ip)
```
Returns false if an internal protocol message was received by a node listed in the firewall. If no firewall is configured, then false is always returned.

Parameters:

ip - the IP of the remote machine

Returns:

false if the IP is listed in the firewall or if the firewall is not configured; true otherwise

getRawNodes

private Set<Node> getRawNodes(Node.Status... statuses)

getRawNode

private Node getRawNode(String nodeId)

resolveProposedNodeIdentifier
```
private NodeIdentifier resolveProposedNodeIdentifier(NodeIdentifier proposedNodeId)
                                              throws ConflictingNodeIdException
```
Resolves a proposed node identifier to a node identifier that the manager approves. If the proposed node identifier conflicts with an existing node identifier, then an approved node identifier is generated and returned to the caller.

Parameters:

proposedNodeId - a proposed identifier

Returns:

the node identifier that should be used

Throws:

ConflictingNodeIdException

isHeartbeatMonitorRunning

private boolean isHeartbeatMonitorRunning()

canChangeNodeState

private boolean canChangeNodeState(String method,
                                   URI uri)

notifyDataFlowManagementServiceOfNodeStatusChange

private void notifyDataFlowManagementServiceOfNodeStatusChange()

notifyDataFlowManagmentServiceOfFlowStateChange

private void notifyDataFlowManagmentServiceOfFlowStateChange(PersistedFlowState newState)

logNodes

private void logNodes(String header,
                      org.slf4j.Logger logger)

executeSafeModeTask
```
private void executeSafeModeTask()
```

getNodeInformation
```
public ClusterNodeInformation getNodeInformation()
```
Specified by:

getNodeInformation in interface NodeInformant

getBulletinRepository
```
public BulletinRepository getBulletinRepository()
```
Specified by:

getBulletinRepository in interface ClusterManager

Returns:

the bulletin repository

getProcessGroupStatus
```
public ProcessGroupStatus getProcessGroupStatus(String groupId)
```
Specified by:

getProcessGroupStatus in interface ClusterManager

Parameters:

groupId - groupId

Returns:

a ProcessGroupStatus that represents the status of all nodes with the given Node.Statuses for the given ProcessGroup id, or null if no nodes exist with the given statuses

getProcessGroupStatus

private ProcessGroupStatus getProcessGroupStatus(ProcessGroupStatus parent,
                                                 String groupId)

getSystemDiagnostics
```
public SystemDiagnostics getSystemDiagnostics()
```
Specified by:

getSystemDiagnostics in interface ClusterManager

Returns:

a merged representation of the System Diagnostics for all nodes in the cluster

merge

private void merge(SystemDiagnostics target,
                   SystemDiagnostics sd)

merge

private void merge(StorageUsage target,
                   StorageUsage du)

merge

private void merge(GarbageCollection target,
                   GarbageCollection gc)

normalizeStatusSnapshotDate

public static Date normalizeStatusSnapshotDate(Date toNormalize,
                                               long numMillis)

createNodeDTO

private NodeDTO createNodeDTO(Node node)

aggregate

private List<StatusSnapshotDTO> aggregate(Map<Date,List<StatusSnapshot>> snapshotsToAggregate)

getProcessorStatusHistory

public ClusterStatusHistoryDTO getProcessorStatusHistory(String processorId)

getProcessorStatusHistory

public ClusterStatusHistoryDTO getProcessorStatusHistory(String processorId,
                                                         Date startDate,
                                                         Date endDate,
                                                         int preferredDataPoints)

createStatusHistoryDto

public StatusHistoryDTO createStatusHistoryDto(StatusHistory statusHistory)

getConnectionStatusHistory

public ClusterStatusHistoryDTO getConnectionStatusHistory(String connectionId)

getConnectionStatusHistory

public ClusterStatusHistoryDTO getConnectionStatusHistory(String connectionId,
                                                          Date startDate,
                                                          Date endDate,
                                                          int preferredDataPoints)

getProcessGroupStatusHistory

public ClusterStatusHistoryDTO getProcessGroupStatusHistory(String processGroupId)

getProcessGroupStatusHistory

public ClusterStatusHistoryDTO getProcessGroupStatusHistory(String processGroupId,
                                                            Date startDate,
                                                            Date endDate,
                                                            int preferredDataPoints)

getRemoteProcessGroupStatusHistory

public ClusterStatusHistoryDTO getRemoteProcessGroupStatusHistory(String remoteGroupId)

getRemoteProcessGroupStatusHistory

public ClusterStatusHistoryDTO getRemoteProcessGroupStatusHistory(String remoteGroupId,
                                                                  Date startDate,
                                                                  Date endDate,
                                                                  int preferredDataPoints)

getControllerServiceIdentifiers
```
public Set<String> getControllerServiceIdentifiers(Class<? extends ControllerService> serviceType)
```
Specified by:

getControllerServiceIdentifiers in interface ControllerServiceLookup

Class WebClusterManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ROOT_GROUP_ID_ALIAS

BULLETIN_CATEGORY

logger

heartbeatLogger

CLUSTER_CONTEXT_HTTP_HEADER

REQUEST_ID_HEADER

NCM_EXPECTS_HTTP_HEADER

NODE_CONTINUE_STATUS_CODE

CLUSTER_INVALIDATE_USER_GROUP_HEADER

CLUSTER_INVALIDATE_USER_HEADER

DEFAULT_CONNECTION_REQUEST_TRY_AGAIN_SECONDS

DEFAULT_COMPONENT_STATUS_REPO_IMPLEMENTATION

PROCESSORS_URI_PATTERN

PROCESSOR_URI_PATTERN

PROCESSOR_STATE_URI_PATTERN

CLUSTER_PROCESSOR_URI_PATTERN

REMOTE_PROCESS_GROUPS_URI_PATTERN

REMOTE_PROCESS_GROUP_URI_PATTERN

PROCESS_GROUP_URI_PATTERN

TEMPLATE_INSTANCE_URI_PATTERN

FLOW_SNIPPET_INSTANCE_URI_PATTERN

PROVENANCE_URI

PROVENANCE_QUERY_URI

PROVENANCE_EVENT_URI

COUNTERS_URI

CONTROLLER_SERVICES_URI

CONTROLLER_SERVICE_URI_PATTERN

CONTROLLER_SERVICE_STATE_URI_PATTERN

CONTROLLER_SERVICE_REFERENCES_URI_PATTERN

REPORTING_TASKS_URI

REPORTING_TASK_URI_PATTERN

REPORTING_TASK_STATE_URI_PATTERN

QUEUE_CONTENTS_URI

DROP_REQUESTS_URI

DROP_REQUEST_URI

LISTING_REQUESTS_URI

LISTING_REQUEST_URI

properties

httpRequestReplicator

httpResponseMapper

dataFlowManagementService

senderListener

optimisticLockingManager

encryptor

pendingHeartbeats

resourceRWLock

readLock

writeLock

nodes

reportingTasks

cachedDataFlow

primaryNodeId

heartbeatMonitor

heartbeatProcessor

servicesBroadcaster

eventManager

clusterFirewall

auditService

controllerServiceProvider

remoteSiteListener

remoteInputPort

remoteCommsSecure

bulletinRepository

instanceId

reportingTaskEngine

componentMetricsRepositoryMap

processScheduler

stateManagerProvider

componentStatusSnapshotMillis

Constructor Detail

WebClusterManager

Method Detail

start