Package org.apache.nifi.processors.standard

Class FetchDistributedMapCache

java.lang.Object
org.apache.nifi.components.AbstractConfigurableComponent
org.apache.nifi.processor.AbstractSessionFactoryProcessor
org.apache.nifi.processor.AbstractProcessor
org.apache.nifi.processors.standard.FetchDistributedMapCache
All Implemented Interfaces:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor
@SupportsBatching @Tags({"map","cache","fetch","distributed"}) @InputRequirement(INPUT_REQUIRED) @CapabilityDescription("Computes cache key(s) from FlowFile attributes, for each incoming FlowFile, and fetches the value(s) from the Distributed Map Cache associated with each key. If configured without a destination attribute, the incoming FlowFile\'s content is replaced with the binary data received by the Distributed Map Cache. If there is no value stored under that key then the flow file will be routed to \'not-found\'. Note that the processor will always attempt to read the entire cached value into memory before placing it in it\'s destination. This could be potentially problematic if the cached value is very large.") @WritesAttribute(attribute="user-defined", description="If the \'Put Cache Value In Attribute\' property is set then whatever it is set to will become the attribute key and the value would be whatever the response was from the Distributed Map Cache. If multiple cache entry identifiers are selected, multiple attributes will be written, using the evaluated value of this property, appended by a period (.) and the name of the cache entry identifier. For example, if the Cache Entry Identifier property is set to \'id,name\', and the user-defined property is named \'fetched\', then two attributes will be written, fetched.id and fetched.name, containing their respective values.") @SeeAlso(classNames={"org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService","org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer","org.apache.nifi.processors.standard.PutDistributedMapCache"}) public class FetchDistributedMapCache extends org.apache.nifi.processor.AbstractProcessor

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    FetchDistributedMapCache.CacheValueDeserializer
     
    static class 
    FetchDistributedMapCache.StringSerializer
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.apache.nifi.components.PropertyDescriptor
    CACHE_ENTRY_IDENTIFIER
     
    static final org.apache.nifi.components.PropertyDescriptor
    CHARACTER_SET
     
    static final org.apache.nifi.components.PropertyDescriptor
    DISTRIBUTED_CACHE_SERVICE
     
    private final Serializer<String>
    keySerializer
     
    private static final List<org.apache.nifi.components.PropertyDescriptor>
    PROPERTY_DESCRIPTORS
     
    static final org.apache.nifi.components.PropertyDescriptor
    PUT_ATTRIBUTE_MAX_LENGTH
     
    static final org.apache.nifi.components.PropertyDescriptor
    PUT_CACHE_VALUE_IN_ATTRIBUTE
     
    static final org.apache.nifi.processor.Relationship
    REL_FAILURE
     
    static final org.apache.nifi.processor.Relationship
    REL_NOT_FOUND
     
    static final org.apache.nifi.processor.Relationship
    REL_SUCCESS
     
    private static final Set<org.apache.nifi.processor.Relationship>
    RELATIONSHIPS
     
    private final Deserializer<byte[]>
    valueDeserializer
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    FetchDistributedMapCache()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Collection<org.apache.nifi.components.ValidationResult>
    customValidate(org.apache.nifi.components.ValidationContext validationContext)
     
    Set<org.apache.nifi.processor.Relationship>
    getRelationships()
     
    protected List<org.apache.nifi.components.PropertyDescriptor>
    getSupportedPropertyDescriptors()
     
    void
    onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.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

    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.components.ConfigurableComponent

    getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

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

    isStateful, migrateProperties, migrateRelationships

  • Field Details

    • DISTRIBUTED_CACHE_SERVICE

      public static final org.apache.nifi.components.PropertyDescriptor DISTRIBUTED_CACHE_SERVICE

    • CACHE_ENTRY_IDENTIFIER

      public static final org.apache.nifi.components.PropertyDescriptor CACHE_ENTRY_IDENTIFIER

    • PUT_CACHE_VALUE_IN_ATTRIBUTE

      public static final org.apache.nifi.components.PropertyDescriptor PUT_CACHE_VALUE_IN_ATTRIBUTE

    • PUT_ATTRIBUTE_MAX_LENGTH

      public static final org.apache.nifi.components.PropertyDescriptor PUT_ATTRIBUTE_MAX_LENGTH

    • CHARACTER_SET

      public static final org.apache.nifi.components.PropertyDescriptor CHARACTER_SET

    • PROPERTY_DESCRIPTORS

      private static final List<org.apache.nifi.components.PropertyDescriptor> PROPERTY_DESCRIPTORS

    • REL_SUCCESS

      public static final org.apache.nifi.processor.Relationship REL_SUCCESS

    • REL_NOT_FOUND

      public static final org.apache.nifi.processor.Relationship REL_NOT_FOUND

    • REL_FAILURE

      public static final org.apache.nifi.processor.Relationship REL_FAILURE

    • RELATIONSHIPS

      private static final Set<org.apache.nifi.processor.Relationship> RELATIONSHIPS

    • keySerializer

      private final Serializer<String> keySerializer

    • valueDeserializer

      private final Deserializer<byte[]> valueDeserializer

  • Constructor Details

    • FetchDistributedMapCache

      public FetchDistributedMapCache()

  • Method Details

    • getSupportedPropertyDescriptors

      protected List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()
      Overrides:
      getSupportedPropertyDescriptors in class org.apache.nifi.components.AbstractConfigurableComponent

    • getRelationships

      public Set<org.apache.nifi.processor.Relationship> getRelationships()
      Specified by:
      getRelationships in interface org.apache.nifi.processor.Processor
      Overrides:
      getRelationships in class org.apache.nifi.processor.AbstractSessionFactoryProcessor

    • customValidate

      protected Collection<org.apache.nifi.components.ValidationResult> customValidate(org.apache.nifi.components.ValidationContext validationContext)
      Overrides:
      customValidate in class org.apache.nifi.components.AbstractConfigurableComponent

    • onTrigger

      public void onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session) throws org.apache.nifi.processor.exception.ProcessException
      Specified by:
      onTrigger in class org.apache.nifi.processor.AbstractProcessor
      Throws:
      org.apache.nifi.processor.exception.ProcessException