Package org.apache.nifi.registry.flow

Class StandardFlowRegistryClientNode

java.lang.Object

org.apache.nifi.controller.AbstractComponentNode

org.apache.nifi.registry.flow.StandardFlowRegistryClientNode

All Implemented Interfaces:

Authorizable, ComponentAuthorizable, ComponentNode, FlowRegistryClientNode

public final class StandardFlowRegistryClientNode
extends AbstractComponentNode
implements FlowRegistryClientNode

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	StandardFlowRegistryClientNode.FlowRegistryClientAction<T>

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicReference<LoggableComponent<FlowRegistryClient>>	client
private String	description
private final FlowManager	flowManager
private static final org.slf4j.Logger	logger
private final Authorizable	parent
private final ControllerServiceProvider	serviceProvider

Constructor Summary

Constructors

Constructor

Description

StandardFlowRegistryClientNode(Authorizable parent, FlowManager flowManager, LoggableComponent<FlowRegistryClient> client, String id, ValidationContextFactory validationContextFactory, ControllerServiceProvider serviceProvider, String componentType, String componentCanonicalClass, ReloadComponent reloadComponent, ExtensionManager extensionManager, ValidationTrigger validationTrigger, boolean isExtensionMissing)

Method Summary

Modifier and Type	Method	Description
private RegisteredFlowSnapshot	createRegisteredFlowSnapshot(FlowRegistryClientUserContext context, RegisteredFlow flow, org.apache.nifi.flow.VersionedProcessGroup snapshot, Map<String,org.apache.nifi.flow.ExternalControllerServiceReference> externalControllerServices, Map<String,org.apache.nifi.flow.VersionedParameterContext> parameterContexts, Map<String,org.apache.nifi.flow.ParameterProviderReference> parameterProviderReferences, String comments, String expectedVersion)
RegisteredFlow	deregisterFlow(FlowRegistryClientUserContext context, FlowLocation flowLocation)
private <T> T	execute(StandardFlowRegistryClientNode.FlowRegistryClientAction<T> action)
private String	extractIdentity(FlowRegistryClientUserContext context)
private RegisteredFlowSnapshot	fetchFlowContents(FlowRegistryClientUserContext context, org.apache.nifi.flow.VersionedFlowCoordinates coordinates, boolean fetchRemoteFlows)
String	generateFlowId(String flowName)
Set<FlowRegistryBranch>	getBranches(FlowRegistryClientUserContext context)
FlowRegistryBucket	getBucket(FlowRegistryClientUserContext context, BucketLocation bucketLocation)
Set<FlowRegistryBucket>	getBuckets(FlowRegistryClientUserContext context, String branch)
BundleCoordinate	getBundleCoordinate()
ConfigurableComponent	getComponent()
Class<?>	getComponentClass()
private FlowRegistryClientConfigurationContext	getConfigurationContext()
private FlowRegistryClientConfigurationContext	getConfigurationContext(FlowRegistryClientUserContext clientContext)
FlowRegistryBranch	getDefaultBranch(FlowRegistryClientUserContext context)
String	getDescription()
RegisteredFlow	getFlow(FlowRegistryClientUserContext context, FlowLocation flowLocation)
FlowSnapshotContainer	getFlowContents(FlowRegistryClientUserContext context, FlowVersionLocation flowVersionLocation, boolean fetchRemoteFlows)
Set<RegisteredFlow>	getFlows(FlowRegistryClientUserContext context, BucketLocation bucketLocation)
Set<RegisteredFlowSnapshotMetadata>	getFlowVersions(FlowRegistryClientUserContext context, FlowLocation flowLocation)
Optional<String>	getLatestVersion(FlowRegistryClientUserContext context, FlowLocation flowLocation)
TerminationAwareLogger	getLogger()
protected ParameterContext	getParameterContext()
ParameterLookup	getParameterLookup()
Authorizable	getParentAuthorizable()
Optional<ProcessGroup>	getParentProcessGroup()
String	getProcessGroupIdentifier()
private List<FlowRegistryClientNode>	getRegistryClientsForInternalFlow(String storageLocation)
Resource	getResource()
boolean	isBranchingSupported()
boolean	isDeprecated()
boolean	isRestricted()
boolean	isStorageLocationApplicable(String location)
boolean	isValidationNecessary()
private Map<String,org.apache.nifi.flow.VersionedParameterContext>	populateVersionedContentsRecursively(FlowRegistryClientUserContext context, org.apache.nifi.flow.VersionedProcessGroup group, FlowSnapshotContainer snapshotContainer)
RegisteredFlow	registerFlow(FlowRegistryClientUserContext context, RegisteredFlow flow)
RegisteredFlowSnapshot	registerFlowSnapshot(FlowRegistryClientUserContext context, RegisteredFlow flow, org.apache.nifi.flow.VersionedProcessGroup snapshot, Map<String,org.apache.nifi.flow.ExternalControllerServiceReference> externalControllerServices, Map<String,org.apache.nifi.flow.VersionedParameterContext> parameterContexts, Map<String,org.apache.nifi.flow.ParameterProviderReference> parameterProviderReferences, String comments, String expectedVersion, RegisterAction registerAction)
void	reload(Set<URL> additionalUrls)
void	setComponent(LoggableComponent<FlowRegistryClient> component)
void	setDescription(String description)
protected List<ValidationResult>	validateConfig()
void	verifyModifiable()

Methods inherited from class org.apache.nifi.controller.AbstractComponentNode

computeValidationErrors, decrementReferenceCounts, determineClasloaderIsolationKey, equals, getAdditionalClasspathResources, getAdditionalClasspathResources, getAdditionalClasspathResources, getAnnotationData, getCanonicalClassName, getComponentType, getEffectivePropertyValue, getEffectivePropertyValues, getExtensionManager, getIdentifier, getName, getProperties, getProperty, getPropertyDescriptor, getPropertyDescriptors, getRawPropertyValue, getRawPropertyValues, getReferencedAttributeNames, getReferencedParameterNames, getReloadComponent, getValidationContext, getValidationContextFactory, getValidationErrors, getValidationErrors, getValidationState, getValidationStatus, getValidationStatus, hashCode, incrementReferenceCounts, isClasspathDifferent, isExtensionMissing, isReferencingParameter, isReferencingParameter, isReloadAdditionalResourcesNecessary, isSensitiveDynamicProperty, mapRawValueToEffectiveValue, onParametersModified, onPropertyModified, overwriteProperties, pauseValidationTrigger, performFlowAnalysisOnThis, performValidation, performValidation, performValidation, refreshProperties, reloadAdditionalResourcesIfNecessary, resetValidationState, resumeValidationTrigger, setAdditionalResourcesFingerprint, setAnnotationData, setExtensionMissing, setName, setProperties, toString, validateReferencedControllerServices, verifyCanUpdateBundle, verifyCanUpdateProperties, verifyConfig

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.authorization.resource.Authorizable

authorize, checkAuthorization, getRequestedResource, isAuthorized

Methods inherited from interface org.apache.nifi.controller.ComponentNode

authorize, checkAuthorization, getAdditionalClasspathResources, getAnnotationData, getCanonicalClassName, getClassLoaderIsolationKey, getComponentType, getEffectivePropertyValue, getEffectivePropertyValues, getIdentifier, getName, getProperties, getProperty, getPropertyDescriptor, getPropertyDescriptors, getRawPropertyValue, getRawPropertyValues, getReferencedAttributeNames, getReferencedParameterNames, getValidationErrors, getValidationStatus, getValidationStatus, isExtensionMissing, isReferencingParameter, isReferencingParameter, isReloadAdditionalResourcesNecessary, isSensitiveDynamicProperty, isSupportsSensitiveDynamicProperties, onParametersModified, pauseValidationTrigger, performValidation, performValidation, performValidation, refreshProperties, reloadAdditionalResourcesIfNecessary, resetValidationState, resumeValidationTrigger, setAnnotationData, setExtensionMissing, setName, setProperties, setProperties, verifyCanUpdateBundle, verifyCanUpdateProperties

Field Details

logger

private static final org.slf4j.Logger logger

flowManager

private final FlowManager flowManager

parent

private final Authorizable parent

client

private final AtomicReference<LoggableComponent<FlowRegistryClient>> client

serviceProvider

private final ControllerServiceProvider serviceProvider

description

private volatile String description

Constructor Details

StandardFlowRegistryClientNode

public StandardFlowRegistryClientNode(Authorizable parent,
 FlowManager flowManager,
 LoggableComponent<FlowRegistryClient> client,
 String id,
 ValidationContextFactory validationContextFactory,
 ControllerServiceProvider serviceProvider,
 String componentType,
 String componentCanonicalClass,
 ReloadComponent reloadComponent,
 ExtensionManager extensionManager,
 ValidationTrigger validationTrigger,
 boolean isExtensionMissing)

Method Details

getParentAuthorizable

public Authorizable getParentAuthorizable()

Specified by:

getParentAuthorizable in interface Authorizable

getResource

public Resource getResource()

Specified by:

getResource in interface Authorizable

getProcessGroupIdentifier

public String getProcessGroupIdentifier()

Specified by:

getProcessGroupIdentifier in interface ComponentAuthorizable

validateConfig

protected List<ValidationResult> validateConfig()

Specified by:

validateConfig in class AbstractComponentNode

verifyModifiable

public void verifyModifiable()
                      throws IllegalStateException

Specified by:

verifyModifiable in class AbstractComponentNode

Throws:

IllegalStateException

getParameterContext

protected ParameterContext getParameterContext()

Specified by:

getParameterContext in class AbstractComponentNode

reload

public void reload(Set<URL> additionalUrls)
            throws Exception

Specified by:

reload in interface ComponentNode

Throws:

Exception

getBundleCoordinate

public BundleCoordinate getBundleCoordinate()

Specified by:

getBundleCoordinate in interface ComponentNode

getComponent

public ConfigurableComponent getComponent()

Specified by:

getComponent in interface ComponentNode

getLogger

public TerminationAwareLogger getLogger()

Specified by:

getLogger in interface ComponentNode

getComponentClass

public Class<?> getComponentClass()

Specified by:

getComponentClass in interface ComponentNode

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface ComponentNode

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface ComponentNode

isValidationNecessary

public boolean isValidationNecessary()

Specified by:

isValidationNecessary in interface ComponentNode

getParentProcessGroup

public Optional<ProcessGroup> getParentProcessGroup()

Specified by:

getParentProcessGroup in interface ComponentNode

getParameterLookup

public ParameterLookup getParameterLookup()

Specified by:

getParameterLookup in interface ComponentNode

getDescription

public String getDescription()

Specified by:

getDescription in interface FlowRegistryClientNode

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface FlowRegistryClientNode

isStorageLocationApplicable

public boolean isStorageLocationApplicable(String location)

Specified by:

isStorageLocationApplicable in interface FlowRegistryClientNode

isBranchingSupported

public boolean isBranchingSupported()

Specified by:

isBranchingSupported in interface FlowRegistryClientNode

getBranches

public Set<FlowRegistryBranch> getBranches(FlowRegistryClientUserContext context)
                                    throws FlowRegistryException,
IOException

Specified by:

getBranches in interface FlowRegistryClientNode

Throws:

FlowRegistryException

IOException

getDefaultBranch

public FlowRegistryBranch getDefaultBranch(FlowRegistryClientUserContext context)
                                    throws FlowRegistryException,
IOException

Specified by:

getDefaultBranch in interface FlowRegistryClientNode

Throws:

FlowRegistryException

IOException

getBuckets

public Set<FlowRegistryBucket> getBuckets(FlowRegistryClientUserContext context,
 String branch)
                                   throws FlowRegistryException,
IOException

Specified by:

getBuckets in interface FlowRegistryClientNode

Throws:

FlowRegistryException

IOException

getBucket

public FlowRegistryBucket getBucket(FlowRegistryClientUserContext context,
 BucketLocation bucketLocation)
                             throws FlowRegistryException,
IOException

Specified by:

getBucket in interface FlowRegistryClientNode

Throws:

FlowRegistryException

IOException

registerFlow

public RegisteredFlow registerFlow(FlowRegistryClientUserContext context,
 RegisteredFlow flow)
                            throws FlowRegistryException,
IOException

Specified by:

registerFlow in interface FlowRegistryClientNode

Throws:

FlowRegistryException

IOException

deregisterFlow

public RegisteredFlow deregisterFlow(FlowRegistryClientUserContext context,
 FlowLocation flowLocation)
                              throws FlowRegistryException,
IOException

Specified by:

deregisterFlow in interface FlowRegistryClientNode

Throws:

FlowRegistryException

IOException

getFlow

public RegisteredFlow getFlow(FlowRegistryClientUserContext context,
 FlowLocation flowLocation)
                       throws FlowRegistryException,
IOException

Specified by:

getFlow in interface FlowRegistryClientNode

Throws:

FlowRegistryException

IOException

getFlows

public Set<RegisteredFlow> getFlows(FlowRegistryClientUserContext context,
 BucketLocation bucketLocation)
                             throws FlowRegistryException,
IOException

Specified by:

getFlows in interface FlowRegistryClientNode

Throws:

FlowRegistryException

IOException

getFlowContents

public FlowSnapshotContainer getFlowContents(FlowRegistryClientUserContext context,
 FlowVersionLocation flowVersionLocation,
 boolean fetchRemoteFlows)
                                      throws FlowRegistryException,
IOException

Specified by:

getFlowContents in interface FlowRegistryClientNode

Throws:

FlowRegistryException

IOException

registerFlowSnapshot

public RegisteredFlowSnapshot registerFlowSnapshot(FlowRegistryClientUserContext context,
 RegisteredFlow flow,
 org.apache.nifi.flow.VersionedProcessGroup snapshot,
 Map<String,org.apache.nifi.flow.ExternalControllerServiceReference> externalControllerServices,
 Map<String,org.apache.nifi.flow.VersionedParameterContext> parameterContexts,
 Map<String,org.apache.nifi.flow.ParameterProviderReference> parameterProviderReferences,
 String comments,
 String expectedVersion,
 RegisterAction registerAction)
                                            throws FlowRegistryException,
IOException

Specified by:

registerFlowSnapshot in interface FlowRegistryClientNode

Throws:

FlowRegistryException

IOException

getFlowVersions

public Set<RegisteredFlowSnapshotMetadata> getFlowVersions(FlowRegistryClientUserContext context,
 FlowLocation flowLocation)
                                                    throws FlowRegistryException,
IOException

Specified by:

getFlowVersions in interface FlowRegistryClientNode

Throws:

FlowRegistryException

IOException

getLatestVersion

public Optional<String> getLatestVersion(FlowRegistryClientUserContext context,
 FlowLocation flowLocation)
                                  throws FlowRegistryException,
IOException

Specified by:

getLatestVersion in interface FlowRegistryClientNode

Throws:

FlowRegistryException

IOException

generateFlowId

public String generateFlowId(String flowName)
                      throws IOException,
FlowRegistryException

Specified by:

generateFlowId in interface FlowRegistryClientNode

Throws:

IOException

FlowRegistryException

setComponent

public void setComponent(LoggableComponent<FlowRegistryClient> component)

Specified by:

setComponent in interface FlowRegistryClientNode

execute

private <T> T execute(StandardFlowRegistryClientNode.FlowRegistryClientAction<T> action)
               throws FlowRegistryException,
IOException

Throws:

FlowRegistryException

IOException

getConfigurationContext

private FlowRegistryClientConfigurationContext getConfigurationContext()

getConfigurationContext

private FlowRegistryClientConfigurationContext getConfigurationContext(FlowRegistryClientUserContext clientContext)

extractIdentity

private String extractIdentity(FlowRegistryClientUserContext context)

populateVersionedContentsRecursively

private Map<String,org.apache.nifi.flow.VersionedParameterContext> populateVersionedContentsRecursively(FlowRegistryClientUserContext context,
 org.apache.nifi.flow.VersionedProcessGroup group,
 FlowSnapshotContainer snapshotContainer)
                                                                                                 throws FlowRegistryException

Throws:

FlowRegistryException

fetchFlowContents

private RegisteredFlowSnapshot fetchFlowContents(FlowRegistryClientUserContext context,
 org.apache.nifi.flow.VersionedFlowCoordinates coordinates,
 boolean fetchRemoteFlows)
                                          throws FlowRegistryException

Throws:

FlowRegistryException

getRegistryClientsForInternalFlow

private List<FlowRegistryClientNode> getRegistryClientsForInternalFlow(String storageLocation)

createRegisteredFlowSnapshot

private RegisteredFlowSnapshot createRegisteredFlowSnapshot(FlowRegistryClientUserContext context,
 RegisteredFlow flow,
 org.apache.nifi.flow.VersionedProcessGroup snapshot,
 Map<String,org.apache.nifi.flow.ExternalControllerServiceReference> externalControllerServices,
 Map<String,org.apache.nifi.flow.VersionedParameterContext> parameterContexts,
 Map<String,org.apache.nifi.flow.ParameterProviderReference> parameterProviderReferences,
 String comments,
 String expectedVersion)