Package org.apache.nifi.fileresource.service

Class StandardFileResourceService

java.lang.Object
org.apache.nifi.components.AbstractConfigurableComponent
org.apache.nifi.controller.AbstractControllerService
org.apache.nifi.fileresource.service.StandardFileResourceService
All Implemented Interfaces:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.controller.ControllerService, FileResourceService
@Tags({"file","resource"}) @CapabilityDescription("Provides a file resource for other components. The file needs to be available locally by Nifi (e.g. local disk or mounted storage). NiFi needs to have read permission to the file.") @Restricted(restrictions=@Restriction(requiredPermission=READ_FILESYSTEM,explanation="Provides operator the ability to read from any file that NiFi has access to.")) public class StandardFileResourceService extends org.apache.nifi.controller.AbstractControllerService implements FileResourceService

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private org.apache.nifi.context.PropertyContext
    context
     
    static final org.apache.nifi.components.PropertyDescriptor
    FILE_PATH
     
    private static final List<org.apache.nifi.components.PropertyDescriptor>
    PROPERTY_DESCRIPTORS
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    StandardFileResourceService()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    FileResource
    getFileResource(Map<String,String> attributes)
     
    protected List<org.apache.nifi.components.PropertyDescriptor>
    getSupportedPropertyDescriptors()
     
    void
    onDisabled()
     
    void
    onEnabled(org.apache.nifi.controller.ConfigurationContext context)
     

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

    abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, init, initialize, isEnabled

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

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

    getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

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

    initialize, isStateful, migrateProperties

  • Field Details

    • FILE_PATH

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

    • PROPERTY_DESCRIPTORS

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

    • context

      private volatile org.apache.nifi.context.PropertyContext context

  • Constructor Details

    • StandardFileResourceService

      public StandardFileResourceService()

  • Method Details

    • getSupportedPropertyDescriptors

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

    • onEnabled

      @OnEnabled public void onEnabled(org.apache.nifi.controller.ConfigurationContext context)

    • onDisabled

      @OnDisabled public void onDisabled()

    • getFileResource

      public FileResource getFileResource(Map<String,String> attributes)
      Specified by:
      getFileResource in interface FileResourceService