org.apache.nifi.processors.standard

Class PutDistributedMapCache

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.PutDistributedMapCache

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SupportsBatching
 @Tags(value={"map","cache","put","distributed"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Gets the content of a FlowFile and puts it to a distributed map cache, using a cache key computed from FlowFile attributes. If the cache already contains the entry and the cache update strategy is \'keep original\' the entry is not replaced.\'")
 @WritesAttribute(attribute="cached",
                 description="All FlowFiles will have an attribute \'cached\'. The value of this attribute is true, is the FlowFile is cached, otherwise false.")
 @SeeAlso(classNames={"org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService","org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer","org.apache.nifi.processors.standard.FetchDistributedMapCache"})
public class PutDistributedMapCache
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PutDistributedMapCache.CacheValueDeserializer
static class	PutDistributedMapCache.CacheValueSerializer
static class	PutDistributedMapCache.StringSerializer Simple string serializer, used for serializing the cache key

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	CACHE_ENTRY_IDENTIFIER
static PropertyDescriptor	CACHE_ENTRY_MAX_BYTES
static AllowableValue	CACHE_UPDATE_KEEP_ORIGINAL
static AllowableValue	CACHE_UPDATE_REPLACE
static PropertyDescriptor	CACHE_UPDATE_STRATEGY
static String	CACHED_ATTRIBUTE_NAME
static PropertyDescriptor	DISTRIBUTED_CACHE_SERVICE
private Serializer<String>	keySerializer
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
private Deserializer<byte[]>	valueDeserializer
private Serializer<byte[]>	valueSerializer

Constructor Summary

Constructors

Constructor and Description
PutDistributedMapCache()

Method Summary

Modifier and Type	Method and Description
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(ProcessContext context, ProcessSession session)

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

onTrigger

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

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

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, 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, onPropertyModified, validate

Field Detail

CACHED_ATTRIBUTE_NAME

public static final String CACHED_ATTRIBUTE_NAME

See Also:

Constant Field Values

DISTRIBUTED_CACHE_SERVICE

public static final PropertyDescriptor DISTRIBUTED_CACHE_SERVICE

CACHE_ENTRY_IDENTIFIER

public static final PropertyDescriptor CACHE_ENTRY_IDENTIFIER

CACHE_UPDATE_REPLACE

public static final AllowableValue CACHE_UPDATE_REPLACE

CACHE_UPDATE_KEEP_ORIGINAL

public static final AllowableValue CACHE_UPDATE_KEEP_ORIGINAL

CACHE_UPDATE_STRATEGY

public static final PropertyDescriptor CACHE_UPDATE_STRATEGY

CACHE_ENTRY_MAX_BYTES

public static final PropertyDescriptor CACHE_ENTRY_MAX_BYTES

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

relationships

private final Set<Relationship> relationships

keySerializer

private final Serializer<String> keySerializer

valueSerializer

private final Serializer<byte[]> valueSerializer

valueDeserializer

private final Deserializer<byte[]> valueDeserializer

Constructor Detail

PutDistributedMapCache

public PutDistributedMapCache()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException