Module datarush.commons
Package com.pervasive.datarush.io

Class URLFileSystemProvider

java.lang.Object
com.pervasive.datarush.io.URLFileSystemProvider
All Implemented Interfaces:
FileSystemProvider
public class URLFileSystemProvider extends Object implements FileSystemProvider
Provides generic access to URL resources. Paths for this provider wrap URL objects. As such, the available set of functions on these paths may be constrained. If richer function is required, a scheme-specific provider should be created for the scheme.

This provider is used as the provider of last resort when parsing path strings. Any path with an unrecognized scheme will be parsed as a URL (paths lacking schemes are always parsed as local file paths). If path is a supported URL, this provider is used.

  • Constructor Details

    • URLFileSystemProvider

      public URLFileSystemProvider()
      Creates a new provider for URLs.

      This constructor is public as a matter of implementation only. Users should not construct a provider directly, but instead use the static methods contained in FileClient and Paths.

  • Method Details

    • isPathSupported

      public boolean isPathSupported(String path)
      Description copied from interface: FileSystemProvider
      Indicates whether the given scheme is handled by the provider.
      Specified by:
      isPathSupported in interface FileSystemProvider
      Parameters:
      path - an identifier for a path scheme
      Returns:
      true if this provider handles paths using the scheme, false otherwise.

    • getFileSystemPath

      public Path getFileSystemPath(Path path)
      Description copied from interface: FileSystemProvider
      Returns the filesystem root path associated with the given path.
      Specified by:
      getFileSystemPath in interface FileSystemProvider
      Parameters:
      path - the path
      Returns:
      the root path

    • getFileSystem

      public FileSystem getFileSystem(FileClient client, FileConfiguration configuration, Path path)
      Description copied from interface: FileSystemProvider
      Gets the file system identified by the path. The path identifies a file on the file system; the file's file system is returned. This is equivalent to calling getPath(path).getFileSystem(), but may be faster.
      Specified by:
      getFileSystem in interface FileSystemProvider
      Parameters:
      client - a file client. most implementations will ignore this parameter. "meta-filesystems" ( those than can span filesystems ) may need the file client.
      configuration - the configuration for this filesystem
      path - a path identifying a file on the file system
      Returns:
      the requested file system object

    • getPath

      public Path getPath(String path)
      Description copied from interface: FileSystemProvider
      Gets the path identified by the given string. The resulting path represents a location in an abstract file system. Use the methods in FileClient to perform operations on the files and directories represented by paths.
      Specified by:
      getPath in interface FileSystemProvider
      Parameters:
      path - the path name to resolve into a path object
      Returns:
      the requested path object

    • getConfigurationTemplate

      public FileConfiguration getConfigurationTemplate()
      Description copied from interface: FileSystemProvider
      Returns a non-populated configuration object to server as a template that the user must fill-in.
      Specified by:
      getConfigurationTemplate in interface FileSystemProvider
      Returns:
      a configuration template

    • getDefaultConfiguration

      public Map<String,FileConfiguration> getDefaultConfiguration()
      Description copied from interface: FileSystemProvider
      Gets default configuration for the schemes handled by the provider. Default configuration is inherited from the execution environment.

      A provider should return a map with entries only for schemes having default configuration; if no schemes do, an empty map should be returned.

      Specified by:
      getDefaultConfiguration in interface FileSystemProvider
      Returns:
      a mapping of schemes to default configuration