Package org.apache.nifi.processors.smb

Class PutSmbFile

java.lang.Object
org.apache.nifi.components.AbstractConfigurableComponent
org.apache.nifi.processor.AbstractSessionFactoryProcessor
org.apache.nifi.processor.AbstractProcessor
org.apache.nifi.processors.smb.PutSmbFile
All Implemented Interfaces:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor
@InputRequirement(INPUT_REQUIRED) @Tags("samba, smb, cifs, files, put") @CapabilityDescription("Writes the contents of a FlowFile to a samba network location. Use this processor instead of a cifs mounts if share access control is important.Configure the Hostname, Share and Directory accordingly: \\\\[Hostname]\\[Share]\\[path\\to\\Directory]") @SeeAlso({GetSmbFile.class,ListSmb.class,FetchSmb.class}) @ReadsAttributes(@ReadsAttribute(attribute="filename",description="The filename to use when writing the FlowFile to the network folder.")) public class PutSmbFile extends org.apache.nifi.processor.AbstractProcessor

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.apache.nifi.components.PropertyDescriptor
    BATCH_SIZE
     
    static final org.apache.nifi.components.PropertyDescriptor
    CONFLICT_RESOLUTION
     
    static final org.apache.nifi.components.PropertyDescriptor
    CREATE_DIRS
     
    static final org.apache.nifi.components.PropertyDescriptor
    DIRECTORY
     
    static final org.apache.nifi.components.PropertyDescriptor
    DOMAIN
     
    static final String
    FAIL_RESOLUTION
     
    static final org.apache.nifi.components.PropertyDescriptor
    HOSTNAME
     
    static final String
    IGNORE_RESOLUTION
     
    static final org.apache.nifi.components.PropertyDescriptor
    PASSWORD
     
    private static final List<org.apache.nifi.components.PropertyDescriptor>
    PROPERTY_DESCRIPTORS
     
    static final org.apache.nifi.processor.Relationship
    REL_FAILURE
     
    static final org.apache.nifi.processor.Relationship
    REL_SUCCESS
     
    private static final Set<org.apache.nifi.processor.Relationship>
    RELATIONSHIPS
     
    static final org.apache.nifi.components.PropertyDescriptor
    RENAME_SUFFIX
     
    static final String
    REPLACE_RESOLUTION
     
    static final org.apache.nifi.components.PropertyDescriptor
    SHARE
     
    static final org.apache.nifi.components.PropertyDescriptor
    SHARE_ACCESS
     
    static final String
    SHARE_ACCESS_NONE
     
    static final String
    SHARE_ACCESS_READ
     
    static final String
    SHARE_ACCESS_READDELETE
     
    static final String
    SHARE_ACCESS_READWRITEDELETE
     
    private Set<com.hierynomus.mssmb2.SMB2ShareAccess>
    sharedAccess
     
    private com.hierynomus.smbj.SMBClient
    smbClient
     
    static final org.apache.nifi.components.PropertyDescriptor
    USERNAME
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    PutSmbFile()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    private void
    createMissingDirectoriesRecursevly(org.apache.nifi.logging.ComponentLog logger, com.hierynomus.smbj.share.DiskShare share, String pathToCreate)
     
    protected Collection<org.apache.nifi.components.ValidationResult>
    customValidate(org.apache.nifi.components.ValidationContext validationContext)
     
    Set<org.apache.nifi.processor.Relationship>
    getRelationships()
     
    final List<org.apache.nifi.components.PropertyDescriptor>
    getSupportedPropertyDescriptors()
     
    (package private) com.hierynomus.smbj.SMBClient
    initSmbClient(org.apache.nifi.processor.ProcessContext context)
     
    void
    onScheduled(org.apache.nifi.processor.ProcessContext context)
     
    void
    onStopped()
     
    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

    • SHARE_ACCESS_NONE

      public static final String SHARE_ACCESS_NONE
      See Also:

    • SHARE_ACCESS_READ

      public static final String SHARE_ACCESS_READ
      See Also:

    • SHARE_ACCESS_READDELETE

      public static final String SHARE_ACCESS_READDELETE
      See Also:

    • SHARE_ACCESS_READWRITEDELETE

      public static final String SHARE_ACCESS_READWRITEDELETE
      See Also:

    • REPLACE_RESOLUTION

      public static final String REPLACE_RESOLUTION
      See Also:

    • IGNORE_RESOLUTION

      public static final String IGNORE_RESOLUTION
      See Also:

    • FAIL_RESOLUTION

      public static final String FAIL_RESOLUTION
      See Also:

    • HOSTNAME

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

    • SHARE

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

    • DIRECTORY

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

    • DOMAIN

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

    • USERNAME

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

    • PASSWORD

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

    • CREATE_DIRS

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

    • SHARE_ACCESS

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

    • CONFLICT_RESOLUTION

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

    • BATCH_SIZE

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

    • RENAME_SUFFIX

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

    • REL_SUCCESS

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

    • REL_FAILURE

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

    • PROPERTY_DESCRIPTORS

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

    • RELATIONSHIPS

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

    • smbClient

      private com.hierynomus.smbj.SMBClient smbClient

    • sharedAccess

      private Set<com.hierynomus.mssmb2.SMB2ShareAccess> sharedAccess

  • Constructor Details

    • PutSmbFile

      public PutSmbFile()

  • Method Details

    • 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

    • getSupportedPropertyDescriptors

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

    • onScheduled

      @OnScheduled public void onScheduled(org.apache.nifi.processor.ProcessContext context)

    • onStopped

      @OnStopped public void onStopped()

    • customValidate

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

    • initSmbClient

      com.hierynomus.smbj.SMBClient initSmbClient(org.apache.nifi.processor.ProcessContext context)

    • createMissingDirectoriesRecursevly

      private void createMissingDirectoriesRecursevly(org.apache.nifi.logging.ComponentLog logger, com.hierynomus.smbj.share.DiskShare share, String pathToCreate)

    • 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