org.apache.synapse.commons.vfs

## Class VFSUtils

- java.lang.Object
- - org.apache.synapse.commons.vfs.VFSUtils

-     public class VFSUtils
      extends Object

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `VFSUtils()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static boolean` | `acquireLock(org.apache.commons.vfs2.FileSystemManager fsManager, org.apache.commons.vfs2.FileObject fo, org.apache.commons.vfs2.FileSystemOptions fso, boolean isListener)` Acquires a file item lock before processing the item, guaranteing that the file is not processed while it is being uploaded and/or the item is not processed by two listeners
    `static boolean` | `acquireLock(org.apache.commons.vfs2.FileSystemManager fsManager, org.apache.commons.vfs2.FileObject fo, VFSParamDTO paramDTO, org.apache.commons.vfs2.FileSystemOptions fso, boolean isListener)` Acquires a file item lock before processing the item, guaranteing that the file is not processed while it is being uploaded and/or the item is not processed by two listeners
    `static org.apache.commons.vfs2.FileSystemOptions` | `attachFileSystemOptions(Map<String,String> options, org.apache.commons.vfs2.FileSystemManager fsManager)`
    `static String` | `getFileName(org.apache.axis2.context.MessageContext msgCtx, VFSOutTransportInfo vfsOutInfo)`
    `static Long` | `getLastModified(org.apache.axis2.context.MessageContext msgCtx)` Helper method to get last modified date from msgCtx
    `static String` | `getProperty(org.apache.commons.vfs2.FileContent message, String property)` Get a String property from FileContent message
    `static String` | `getSystemTime(String dateFormat)`
    `static boolean` | `isFailRecord(org.apache.commons.vfs2.FileSystemManager fsManager, org.apache.commons.vfs2.FileObject fo)`
    `static void` | `markFailRecord(org.apache.commons.vfs2.FileSystemManager fsManager, org.apache.commons.vfs2.FileObject fo)`
    `static String` | `maskURLPassword(String url)` Mask the password of the connection url with ***
    `static Map<String,String>` | `parseSchemeFileOptions(String fileURI, org.apache.axis2.description.ParameterInclude params)`
    `static void` | `releaseFail(org.apache.commons.vfs2.FileSystemManager fsManager, org.apache.commons.vfs2.FileObject fo)`
    `static void` | `releaseLock(org.apache.commons.vfs2.FileSystemManager fsManager, org.apache.commons.vfs2.FileObject fo, org.apache.commons.vfs2.FileSystemOptions fso)` Release a file item lock acquired either by the VFS listener or a sender

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### VFSUtils

          public VFSUtils()

  - ### Method Detail

    - #### getProperty

          public static String getProperty(org.apache.commons.vfs2.FileContent message,
                           String property)

      Get a String property from FileContent message
      Parameters:
        `message` - the File message
        `property` - property name
      Returns:
        property value

    - #### getFileName

          public static String getFileName(org.apache.axis2.context.MessageContext msgCtx,
                           VFSOutTransportInfo vfsOutInfo)

    - #### acquireLock

          public static boolean acquireLock(org.apache.commons.vfs2.FileSystemManager fsManager,
                            org.apache.commons.vfs2.FileObject fo,
                            org.apache.commons.vfs2.FileSystemOptions fso,
                            boolean isListener)

      Acquires a file item lock before processing the item, guaranteing that the file is not processed while it is being uploaded and/or the item is not processed by two listeners
      Parameters:
        `fsManager` - used to resolve the processing file
        `fo` - representing the processing file item
        `fso` - represents file system options used when resolving file from file system manager.
      Returns:
        boolean true if the lock has been acquired or false if not

    - #### acquireLock

          public static boolean acquireLock(org.apache.commons.vfs2.FileSystemManager fsManager,
                            org.apache.commons.vfs2.FileObject fo,
                            VFSParamDTO paramDTO,
                            org.apache.commons.vfs2.FileSystemOptions fso,
                            boolean isListener)

      Acquires a file item lock before processing the item, guaranteing that the file is not processed while it is being uploaded and/or the item is not processed by two listeners
      Parameters:
        `fsManager` - used to resolve the processing file
        `fo` - representing the processing file item
        `fso` - represents file system options used when resolving file from file system manager.
      Returns:
        boolean true if the lock has been acquired or false if not

    - #### releaseLock

          public static void releaseLock(org.apache.commons.vfs2.FileSystemManager fsManager,
                         org.apache.commons.vfs2.FileObject fo,
                         org.apache.commons.vfs2.FileSystemOptions fso)

      Release a file item lock acquired either by the VFS listener or a sender
      Parameters:
        `fsManager` - which is used to resolve the processed file
        `fo` - representing the processed file
        `fso` - represents file system options used when resolving file from file system manager.

    - #### maskURLPassword

          public static String maskURLPassword(String url)

      Mask the password of the connection url with ***
      Parameters:
        `url` - the actual url
      Returns:
        the masked url

    - #### getSystemTime

          public static String getSystemTime(String dateFormat)

    - #### getLastModified

          public static Long getLastModified(org.apache.axis2.context.MessageContext msgCtx)

      Helper method to get last modified date from msgCtx
      Parameters:
        `msgCtx` -
      Returns:
        lastModifiedDate

    - #### markFailRecord

          public static void markFailRecord(org.apache.commons.vfs2.FileSystemManager fsManager,
                            org.apache.commons.vfs2.FileObject fo)

    - #### isFailRecord

          public static boolean isFailRecord(org.apache.commons.vfs2.FileSystemManager fsManager,
                             org.apache.commons.vfs2.FileObject fo)

    - #### releaseFail

          public static void releaseFail(org.apache.commons.vfs2.FileSystemManager fsManager,
                         org.apache.commons.vfs2.FileObject fo)

    - #### parseSchemeFileOptions

          public static Map<String,String> parseSchemeFileOptions(String fileURI,
                                                  org.apache.axis2.description.ParameterInclude params)

    - #### attachFileSystemOptions

          public static org.apache.commons.vfs2.FileSystemOptions attachFileSystemOptions(Map<String,String> options,
                                                                          org.apache.commons.vfs2.FileSystemManager fsManager)
                                                                                   throws org.apache.commons.vfs2.FileSystemException,
                                                                                          InstantiationException,
                                                                                          IllegalAccessException

      Throws:
        `org.apache.commons.vfs2.FileSystemException`
        `InstantiationException`
        `IllegalAccessException`

Copyright © 2005–2017 Apache Software Foundation. All rights reserved.