Field Detail

• public static final char[] ALPHA

• public static final java.util.regex.Pattern URL_PROTOCOL

Method Detail

• static java.nio.file.Path asPath(java.lang.String str)

  Given an hierarchical file URI path returns a java.nio.file.Path object eventually creating the associated file system if required.

  An hierarchical URI is either an absolute URI whose scheme-specific part begins with a slash character (e.g. file:/some/file.txt), or a relative URI, that is, a URI that does not specify a scheme (e.g. some/file.txt). See http://docs.oracle.com/javase/7/docs/api/java/net/URI.html

  Parameters:

  str - A path string eventually qualified with the scheme prefix

  Returns:

  A java.nio.file.Path object

• static java.nio.file.Path asPath(java.net.URI uri)

  Given a java.net.URI return a java.nio.file.Path object eventually creating the associated file system if required

  Parameters:

  uri - A URI for identifying the requested path

  Returns:

  A java.nio.file.Path object

• static java.nio.file.Path checkIfExists(java.nio.file.Path path, java.util.Map opts)

• static java.nio.file.Path copyPath(java.nio.file.Path source, java.nio.file.Path target, java.nio.file.CopyOption... options)

  Move a path to a target destination. It handles file or directory both to a local or to a foreign file system.

  Parameters:

  source

  target

  options

  Returns:

  @throws IOException

• static final java.nio.file.Path createLocalDir(java.lang.String prefix = 'nxf-')

• static final java.nio.file.Path createTempFolder(java.nio.file.Path basePath)

• static void deletePath(java.nio.file.Path path)

  Delete a path or a directory. If the directory is not empty delete all the content of the directory. Note when the path is a symlink, it only remove the link without following affecting the target path

  Parameters:

  path

• static boolean empty(java.io.File file)

  Check whenever a file or a directory is empty

  Parameters:

  file - The file path to

• static boolean empty(java.nio.file.Path path)

• @groovy.transform.Memoized protected static java.util.Map envFor(java.lang.String scheme)

  Lazy create and memoize this object since it will never change

  Returns:

  A map holding the current session

• static java.io.FileSystem fileSystemForScheme(java.lang.String scheme)

• static java.nio.file.PathMatcher getDefaultPathMatcher(java.lang.String syntaxAndInput)

  Returns a PathMatcher that performs match operations on the String representation of java.nio.file.Path objects by interpreting a given pattern.

  See Also:

  FileSystem#getPathMatcher(java.lang.String)

  Parameters:

  syntaxAndInput

  Returns:

• static java.lang.String getIdentifier(java.nio.file.Path script, java.lang.String prefix = null)

  Parameters:

  script

  Returns:

• static java.nio.file.Path getLocalCachePath(java.nio.file.Path sourcePath, java.nio.file.Path cacheDir, java.util.UUID sessionId = null )

  Given a path look for an existing file with that name in the cacheDir folder. If exists will return the path to it, otherwise make a copy of it in the cache folder and returns to the path to it.

  Parameters:

  sourcePath - A java.nio.file.Path object to an existing file or directory

  cacheDir - A java.nio.file.Path to the folder containing the cached objects

  sessionId - An option java.util.UUID used to create the object invalidation key

  Returns:

  A java.nio.file.Path to the cached version of the specified object

• static final java.nio.file.Path getLocalTempPath()

• static java.io.FileSystem getOrCreateFileSystemFor(java.net.URI uri, java.util.Map env = null )

  Acquire or create the file system for the given java.net.URI

  throws:

  IllegalArgumentException if does not exist a valid provider for the given URI scheme

  Parameters:

  uri - A java.net.URI locating a file into a file system

  env - An option environment specification that may be used to instantiate the underlying file system. As defined by FileSystemProvider#newFileSystem(java.net.URI, java.util.Map)

  Returns:

  The corresponding java.io.FileSystem object

• static java.io.FileSystem getOrCreateFileSystemFor(java.lang.String scheme, java.util.Map env = null )

• <T extends FileSystemProvider> @java.lang.Deprecated static T getOrInstallProvider(java.lang.Class<T> clazz)

  Get the instance of the specified FileSystemProvider class. If the provider is not in the list of installed provided, it creates a new instance and add it to the list

  This method has been deprecated use getOrCreateFileSystemFor(java.lang.String) instead

  See Also:

  <CODE>FileSystemProvider#installedProviders</CODE>

  Parameters:

  clazz - A class extending FileSystemProvider

  Returns:

  An instance of the specified class

• @groovy.transform.Memoized static java.lang.String getPathFsType(java.nio.file.Path path)

• static java.nio.file.PathMatcher getPathMatcherFor(java.lang.String syntaxAndPattern, java.io.FileSystem fileSystem)

  Get a path matcher for the specified file system and file pattern. It tries to get the matcher returned by java.io.FileSystem#getPathMatcher and falling back to getDefaultPathMatcher(java.lang.String) when it return a null or an java.lang.UnsupportedOperationException

  Parameters:

  fileSystem

  syntaxAndPattern

  Returns:

  A java.nio.file.PathMatcher instance for the specified file pattern

• static java.nio.file.spi.FileSystemProvider getProviderFor(java.lang.String scheme)

  Returns a java.nio.file.spi.FileSystemProvider for a file scheme

  Parameters:

  scheme - A file system scheme e.g. file, s3, dxfs, etc.

  Returns:

  A java.nio.file.spi.FileSystemProvider instance for the specified scheme

• static java.lang.String getUrlProtocol(java.lang.String str)

• @groovy.transform.Memoized @java.lang.Deprecated static java.io.FileSystem getWorkDirFileSystem()

  NOTE: this cannot be accessed by a remote system

  Returns:

  The file system defined by the Session#workDir attribute

• static boolean getWorkDirIsNFS()

  Returns:

  true when the current session working directory is a NFS mounted path false otherwise

• static final java.nio.file.Path getWorkFolder(java.nio.file.Path bashPath, com.google.common.hash.HashCode hash)

  Defines a cacheable path for the specified HashCode instance.

  Parameters:

  hash

  Returns:

• static boolean isGlobAllowed(java.nio.file.Path path)

• @groovy.transform.Memoized static boolean isPathNFS(java.nio.file.Path path)

  Check if the specified path is a NFS mount

  Parameters:

  path - The path to verify

  Returns:

  The true when the path is a NFS mount false otherwise

• static java.lang.String listDirectory(java.nio.file.Path path)

  List the content of a file system path

  Parameters:

  path - The system system directory to list

  Returns:

  The stdout produced the execute `ls -la` command. NOTE: this output is not supposed to be exhaustive, only the first 50 lines will be returned.

• static java.nio.file.Path movePath(java.nio.file.Path source, java.nio.file.Path target, java.nio.file.CopyOption... options)

  Move a path to a target destination. It handles file or directory both to a local or to a foreign file system

  throws:

  IOException

  Parameters:

  source - The source path

  target - The target path

  options - The copy options

  Returns:

  The resulting target path

• static java.util.List nameParts(java.lang.String name)

• static java.lang.String normalizePath(java.lang.String path)

• static java.lang.String randomString(int len, char[] alphabet)

  Creates a random string with the number of character specified e.g. s8hm2nxt3

  Parameters:

  len - The len of the final random string

  alphabet - The set of characters allowed in the random string

  Returns:

  The generated random string

• static java.lang.String randomString(int len)

• static java.nio.file.attribute.BasicFileAttributes readAttributes(java.nio.file.Path path, java.nio.file.LinkOption... options)

• protected static java.nio.file.Path relativize0(java.nio.file.Path folder, java.nio.file.Path fullPath)

• static void visitFiles(java.util.Map options = null, java.nio.file.Path folder, java.lang.String filePattern, groovy.lang.Closure action)

  Applies the specified action on one or more files and directories matching the specified glob pattern

  throws:

  java.nio.file.NoSuchFileException if the specified folder does not exist

  Parameters:

  folder

  filePattern

  action