Package org.apache.nifi.registry.flow

Class FlowAnalyzingRegistryClientNode

java.lang.Object

org.apache.nifi.registry.flow.FlowAnalyzingRegistryClientNode

All Implemented Interfaces:

Authorizable, ComponentAuthorizable, ComponentNode, FlowRegistryClientNode

public final class FlowAnalyzingRegistryClientNode
extends Object
implements FlowRegistryClientNode

Field Summary

Fields

Modifier and Type	Field	Description
private final FlowAnalyzer	flowAnalyzer
private final FlowManager	flowManager
private final NiFiRegistryFlowMapper	flowMapper
private static final org.slf4j.Logger	LOGGER
private final FlowRegistryClientNode	node
private final RuleViolationsManager	ruleViolationsManager
private final ControllerServiceProvider	serviceProvider

Constructor Summary

Constructors

Constructor	Description
FlowAnalyzingRegistryClientNode(FlowRegistryClientNode node, ControllerServiceProvider serviceProvider, FlowAnalyzer flowAnalyzer, RuleViolationsManager ruleViolationsManager, FlowManager flowManager, NiFiRegistryFlowMapper flowMapper)

Method Summary

Modifier and Type	Method	Description
private boolean	analyzeProcessGroupToRegister(org.apache.nifi.flow.VersionedProcessGroup snapshot)
RegisteredFlow	deregisterFlow(FlowRegistryClientUserContext context, FlowLocation flowLocation)
String	generateFlowId(String flowName)
Set<URL>	getAdditionalClasspathResources(List<PropertyDescriptor> propertyDescriptors)
String	getAnnotationData()
Set<FlowRegistryBranch>	getBranches(FlowRegistryClientUserContext context)
FlowRegistryBucket	getBucket(FlowRegistryClientUserContext context, BucketLocation bucketLocation)
Set<FlowRegistryBucket>	getBuckets(FlowRegistryClientUserContext context, String branch)
BundleCoordinate	getBundleCoordinate()
String	getCanonicalClassName()
ConfigurableComponent	getComponent()
Class<?>	getComponentClass()
String	getComponentType()
FlowRegistryBranch	getDefaultBranch(FlowRegistryClientUserContext context)
String	getDescription()
String	getEffectivePropertyValue(PropertyDescriptor property)
Map<PropertyDescriptor,String>	getEffectivePropertyValues()
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)
String	getIdentifier()
Optional<String>	getLatestVersion(FlowRegistryClientUserContext context, FlowLocation flowLocation)
TerminationAwareLogger	getLogger()
String	getName()
ParameterLookup	getParameterLookup()
Authorizable	getParentAuthorizable()
Optional<ProcessGroup>	getParentProcessGroup()
String	getProcessGroupIdentifier()
Map<PropertyDescriptor,PropertyConfiguration>	getProperties()
PropertyConfiguration	getProperty(PropertyDescriptor property)
PropertyDescriptor	getPropertyDescriptor(String name)
List<PropertyDescriptor>	getPropertyDescriptors()
String	getRawPropertyValue(PropertyDescriptor property)
Map<PropertyDescriptor,String>	getRawPropertyValues()
Set<String>	getReferencedAttributeNames()
Set<String>	getReferencedParameterNames()
Resource	getResource()
Collection<ValidationResult>	getValidationErrors()
ValidationStatus	getValidationStatus()
ValidationStatus	getValidationStatus(long timeout, TimeUnit unit)
boolean	isBranchingSupported()
boolean	isDeprecated()
boolean	isExtensionMissing()
boolean	isReferencingParameter()
boolean	isReferencingParameter(String parameterName)
boolean	isReloadAdditionalResourcesNecessary()
boolean	isRestricted()
boolean	isSensitiveDynamicProperty(String name)
boolean	isStorageLocationApplicable(String location)
boolean	isValidationNecessary()
void	onParametersModified(Map<String,ParameterUpdate> parameterUpdates)
void	pauseValidationTrigger()
ValidationStatus	performValidation()
ValidationState	performValidation(Map<PropertyDescriptor,PropertyConfiguration> properties, String annotationData, ParameterContext parameterContext)
ValidationState	performValidation(ValidationContext validationContext)
void	refreshProperties()
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	reloadAdditionalResourcesIfNecessary()
void	resetValidationState()
void	resumeValidationTrigger()
void	setAnnotationData(String data)
void	setComponent(LoggableComponent<FlowRegistryClient> component)
void	setDescription(String description)
void	setExtensionMissing(boolean extensionMissing)
void	setName(String name)
void	setProperties(Map<String,String> properties, boolean allowRemovalOfRequiresProperties, Set<String> sensitiveDynamicPropertyNames)
void	verifyCanUpdateBundle(BundleCoordinate bundleCoordinate)
void	verifyCanUpdateProperties(Map<String,String> properties)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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, getClassLoaderIsolationKey, isSupportsSensitiveDynamicProperties, setProperties

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

node

private final FlowRegistryClientNode node

serviceProvider

private final ControllerServiceProvider serviceProvider

flowAnalyzer

private final FlowAnalyzer flowAnalyzer

ruleViolationsManager

private final RuleViolationsManager ruleViolationsManager

flowManager

private final FlowManager flowManager

flowMapper

private final NiFiRegistryFlowMapper flowMapper

Constructor Details

FlowAnalyzingRegistryClientNode

public FlowAnalyzingRegistryClientNode(FlowRegistryClientNode node,
 ControllerServiceProvider serviceProvider,
 FlowAnalyzer flowAnalyzer,
 RuleViolationsManager ruleViolationsManager,
 FlowManager flowManager,
 NiFiRegistryFlowMapper flowMapper)

Method Details

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

analyzeProcessGroupToRegister

private boolean analyzeProcessGroupToRegister(org.apache.nifi.flow.VersionedProcessGroup snapshot)

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

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface ComponentAuthorizable

Specified by:

getIdentifier in interface ComponentNode

getName

public String getName()

Specified by:

getName in interface ComponentNode

setName

public void setName(String name)

Specified by:

setName in interface ComponentNode

getAnnotationData

public String getAnnotationData()

Specified by:

getAnnotationData in interface ComponentNode

setAnnotationData

public void setAnnotationData(String data)

Specified by:

setAnnotationData in interface ComponentNode

setProperties

public void setProperties(Map<String,String> properties,
 boolean allowRemovalOfRequiresProperties,
 Set<String> sensitiveDynamicPropertyNames)

Specified by:

setProperties in interface ComponentNode

verifyCanUpdateProperties

public void verifyCanUpdateProperties(Map<String,String> properties)

Specified by:

verifyCanUpdateProperties in interface ComponentNode

getReferencedParameterNames

public Set<String> getReferencedParameterNames()

Specified by:

getReferencedParameterNames in interface ComponentNode

isReferencingParameter

public boolean isReferencingParameter()

Specified by:

isReferencingParameter in interface ComponentNode

isReferencingParameter

public boolean isReferencingParameter(String parameterName)

Specified by:

isReferencingParameter in interface ComponentNode

onParametersModified

public void onParametersModified(Map<String,ParameterUpdate> parameterUpdates)

Specified by:

onParametersModified in interface ComponentNode

getReferencedAttributeNames

public Set<String> getReferencedAttributeNames()

Specified by:

getReferencedAttributeNames in interface ComponentNode

pauseValidationTrigger

public void pauseValidationTrigger()

Specified by:

pauseValidationTrigger in interface ComponentNode

resumeValidationTrigger

public void resumeValidationTrigger()

Specified by:

resumeValidationTrigger in interface ComponentNode

getRawPropertyValues

public Map<PropertyDescriptor,String> getRawPropertyValues()

Specified by:

getRawPropertyValues in interface ComponentNode

getEffectivePropertyValues

public Map<PropertyDescriptor,String> getEffectivePropertyValues()

Specified by:

getEffectivePropertyValues in interface ComponentNode

getProperty

public PropertyConfiguration getProperty(PropertyDescriptor property)

Specified by:

getProperty in interface ComponentNode

getEffectivePropertyValue

public String getEffectivePropertyValue(PropertyDescriptor property)

Specified by:

getEffectivePropertyValue in interface ComponentNode

getRawPropertyValue

public String getRawPropertyValue(PropertyDescriptor property)

Specified by:

getRawPropertyValue in interface ComponentNode

getProperties

public Map<PropertyDescriptor,PropertyConfiguration> getProperties()

Specified by:

getProperties in interface ComponentNode

reload

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

Specified by:

reload in interface ComponentNode

Throws:

Exception

refreshProperties

public void refreshProperties()

Specified by:

refreshProperties in interface ComponentNode

getAdditionalClasspathResources

public Set<URL> getAdditionalClasspathResources(List<PropertyDescriptor> propertyDescriptors)

Specified by:

getAdditionalClasspathResources in interface ComponentNode

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

isExtensionMissing

public boolean isExtensionMissing()

Specified by:

isExtensionMissing in interface ComponentNode

setExtensionMissing

public void setExtensionMissing(boolean extensionMissing)

Specified by:

setExtensionMissing in interface ComponentNode

verifyCanUpdateBundle

public void verifyCanUpdateBundle(BundleCoordinate bundleCoordinate)
                           throws IllegalStateException

Specified by:

verifyCanUpdateBundle in interface ComponentNode

Throws:

IllegalStateException

isReloadAdditionalResourcesNecessary

public boolean isReloadAdditionalResourcesNecessary()

Specified by:

isReloadAdditionalResourcesNecessary in interface ComponentNode

reloadAdditionalResourcesIfNecessary

public void reloadAdditionalResourcesIfNecessary()

Specified by:

reloadAdditionalResourcesIfNecessary in interface ComponentNode

resetValidationState

public void resetValidationState()

Specified by:

resetValidationState in interface ComponentNode

getValidationErrors

public Collection<ValidationResult> getValidationErrors()

Specified by:

getValidationErrors in interface ComponentNode

getComponentType

public String getComponentType()

Specified by:

getComponentType in interface ComponentNode

getComponentClass

public Class<?> getComponentClass()

Specified by:

getComponentClass in interface ComponentNode

getCanonicalClassName

public String getCanonicalClassName()

Specified by:

getCanonicalClassName 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

getValidationStatus

public ValidationStatus getValidationStatus()

Specified by:

getValidationStatus in interface ComponentNode

getValidationStatus

public ValidationStatus getValidationStatus(long timeout,
 TimeUnit unit)

Specified by:

getValidationStatus in interface ComponentNode

performValidation

public ValidationStatus performValidation()

Specified by:

performValidation in interface ComponentNode

performValidation

public ValidationState performValidation(ValidationContext validationContext)

Specified by:

performValidation in interface ComponentNode

performValidation

public ValidationState performValidation(Map<PropertyDescriptor,PropertyConfiguration> properties,
 String annotationData,
 ParameterContext parameterContext)

Specified by:

performValidation in interface ComponentNode

getPropertyDescriptors

public List<PropertyDescriptor> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in interface ComponentNode

getPropertyDescriptor

public PropertyDescriptor getPropertyDescriptor(String name)

Specified by:

getPropertyDescriptor in interface ComponentNode

isSensitiveDynamicProperty

public boolean isSensitiveDynamicProperty(String name)

Specified by:

isSensitiveDynamicProperty 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

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