org.apache.nifi.processors.standard

Class DistributeLoad

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.DistributeLoad

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching(defaultDuration=TWENTY_FIVE_MILLIS)
 @InputRequirement(value=INPUT_REQUIRED)
 @TriggerWhenAnyDestinationAvailable
 @Tags(value={"distribute","load balance","route","round robin","weighted"})
 @CapabilityDescription(value="Distributes FlowFiles to downstream processors based on a Distribution Strategy. If using the Round Robin strategy, the default is to assign each destination a weighting of 1 (evenly distributed). However, optional properties can be added to the change this; adding a property with the name \'5\' and value \'10\' means that the relationship with name \'5\' will be receive 10 FlowFiles in each iteration instead of 1.")
 @DynamicProperty(name="The relationship name (positive number)",
                 value="The relationship Weight (positive number)",
                 description="Adding a property with the name \'5\' and value \'10\' means that the relationship with name \'5\' will receive 10 FlowFiles in each iteration instead of 1.")
 @DynamicRelationship(name="A number 1..<Number Of Relationships>",
                     description="FlowFiles are sent to this relationship per the <Distribution Strategy>")
 @WritesAttributes(value=@WritesAttribute(attribute="distribute.load.relationship",description="The name of the specific relationship the FlowFile has been routed through"))
public class DistributeLoad
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static interface	DistributeLoad.DistributionStrategy Implementations must be thread-safe.
private static class	DistributeLoad.InvalidPropertyNameValidator
private class	DistributeLoad.LoadDistributionStrategy
private class	DistributeLoad.NextAvailableStrategy
private class	DistributeLoad.OverflowStrategy
private class	DistributeLoad.RoundRobinStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	DISTRIBUTION_STRATEGY
private AtomicBoolean	doCustomValidate
private AtomicBoolean	doSetProps
static PropertyDescriptor	HOSTNAMES
static String	LOAD_DISTRIBUTION_SERVICE
static PropertyDescriptor	LOAD_DISTRIBUTION_SERVICE_TEMPLATE
private LoadDistributionListener	myListener
static String	NEXT_AVAILABLE
static PropertyDescriptor	NUM_RELATIONSHIPS
static String	OVERFLOW
private List<PropertyDescriptor>	properties
static String	RELATIONSHIP_ATTRIBUTE
private AtomicReference<Set<Relationship>>	relationshipsRef
static String	ROUND_ROBIN
static AllowableValue	STRATEGY_LOAD_DISTRIBUTION_SERVICE
static AllowableValue	STRATEGY_NEXT_AVAILABLE
static AllowableValue	STRATEGY_OVERFLOW
static AllowableValue	STRATEGY_ROUND_ROBIN
private AtomicReference<DistributeLoad.DistributionStrategy>	strategyRef
private AtomicReference<List<Relationship>>	weightedRelationshipListRef

Constructor Summary

Constructors

Constructor and Description
DistributeLoad()

Method Summary

Modifier and Type	Method and Description
private static Relationship	createRelationship(int num)
void	createWeightedList(ProcessContext context)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onTrigger(ProcessContext context, ProcessSession session)
private void	updateWeightedRelationships(Map<Integer,Integer> weightings)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, validate

Field Detail

ROUND_ROBIN

public static final String ROUND_ROBIN

See Also:

Constant Field Values

NEXT_AVAILABLE

public static final String NEXT_AVAILABLE

See Also:

Constant Field Values

LOAD_DISTRIBUTION_SERVICE

public static final String LOAD_DISTRIBUTION_SERVICE

See Also:

Constant Field Values

OVERFLOW

public static final String OVERFLOW

See Also:

Constant Field Values

STRATEGY_ROUND_ROBIN

public static final AllowableValue STRATEGY_ROUND_ROBIN

STRATEGY_NEXT_AVAILABLE

public static final AllowableValue STRATEGY_NEXT_AVAILABLE

STRATEGY_LOAD_DISTRIBUTION_SERVICE

public static final AllowableValue STRATEGY_LOAD_DISTRIBUTION_SERVICE

STRATEGY_OVERFLOW

public static final AllowableValue STRATEGY_OVERFLOW

NUM_RELATIONSHIPS

public static final PropertyDescriptor NUM_RELATIONSHIPS

DISTRIBUTION_STRATEGY

public static final PropertyDescriptor DISTRIBUTION_STRATEGY

HOSTNAMES

public static final PropertyDescriptor HOSTNAMES

LOAD_DISTRIBUTION_SERVICE_TEMPLATE

public static final PropertyDescriptor LOAD_DISTRIBUTION_SERVICE_TEMPLATE

RELATIONSHIP_ATTRIBUTE

public static final String RELATIONSHIP_ATTRIBUTE

See Also:

Constant Field Values

properties

private List<PropertyDescriptor> properties

relationshipsRef

private final AtomicReference<Set<Relationship>> relationshipsRef

strategyRef

private final AtomicReference<DistributeLoad.DistributionStrategy> strategyRef

weightedRelationshipListRef

private final AtomicReference<List<Relationship>> weightedRelationshipListRef

doCustomValidate

private final AtomicBoolean doCustomValidate

myListener

private volatile LoadDistributionListener myListener

doSetProps

private final AtomicBoolean doSetProps

Constructor Detail

DistributeLoad

public DistributeLoad()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

createRelationship

private static Relationship createRelationship(int num)

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
                               String oldValue,
                               String newValue)

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

createWeightedList

@OnScheduled
public void createWeightedList(ProcessContext context)

updateWeightedRelationships

private void updateWeightedRelationships(Map<Integer,Integer> weightings)

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor