LexURIFile (Cleo VersaLex Java API)

java.lang.Object
- com.cleo.lexicom.beans.LexURIFile

public abstract class LexURIFile
extends java.lang.Object

LexURIFile is a class to be extended to create a SchemeFile class in order to support a URI representation for user-defined files and/or directory objects where the underlying system may be a file system, database, queue, or pipe. All schemes must start with a letter followed by one or more alpha-numeric characters followed by a colon.

Some example URIs are:

jms:jndi:jms/InboxQueue?jndiConnectionFactoryName=jms/ConnFact&filenameProp=filename
msmq:DIRECT=OS:.\private$\Inbox?createQueue=true
VLPipe:FTPPipeDevTest\myMailbox
MyFS:\Inbox
hdfs:\hdfsnamenode:50070\Inbox

Since a SchemeFile represents a file or directory, this abstract class is based on the methods in the java.io.File class with some additional methods.

The implementing class must extend the LexURIFile class and implement all abstract classes.

VersaLex URI File System Interface Description

VLTrader and Harmony have has a method for accessing files using java code outside of the typical VersaLex jars. These custom-written classes are accessed based on the scheme at the start of the URI found in a host Inbox / Outbox or the source / destination specified in an action. A file system type URI may also be used for local user folders.

The Java classes that are called are configured in system properties. These properties are typically configured with -D parameters. These system properties can also be configured in the system.properties file found in the conf/ folder under VersaLex. When VersaLex detects a URI, it will check if associated classes have been configured for that scheme.

Four system properties are used to configure a single scheme. The property name is all lowercase including the scheme name. The property values are mixed case.

System Property	Required	Description
cleo.uri.scheme.file	Yes	This property defines the custom class to be used as the File object. This custom class must extend cleo.lexicom.beans.LexURIFile. LexURIFile is an abstract class that extends java.io.File. The suggested class name for this class is com.companyabc.scheme.SchemeFile. The schemeFile class must implement two constructors: SchemeFile(String uri) SchemeFile(String parentUri, String child) These constructors should first call their respective super(...) methods.
cleo.uri.scheme.inputstream	Yes	This property defines the custom class to be used for the InputStream object. This custom class must extend java.io.InputStream. The SchemeInputStream class must implement one constructor: SchemeInputStream(LexURIFile lexURIFile) NOTE: lexURIFile can be cast to a SchemeFile so that information regarding the SchemeFile can be retrieved. The SchemeInputStream class must override all the java.io.InputStream methods: available() close() mark(int readlimit) markSupported() read() read(byte[] b) read(byte[] b, int off, int len) reset() skip(long n) The suggested class name for this class is com.companyabc.scheme.SchemeInputStream.
cleo.uri.scheme.outputstream	Yes	This property defines the custom class to be used for the OutputStream object. This custom class must extend java.io.OutputStream. The SchemeOutputStream class must implement one constructor: SchemeOutputStream(LexURIFile lexURIFile, boolean append) NOTE: lexURIFile can be cast to a SchemeFile so that information regarding the SchemeFile can be retrieved. The SchemeOutputStream class must override all the java.io.OutputStream methods: close() flush() write(byte[] b) write(byte[] b, int off, int len) write(int b) The suggested class name for this class is com.companyabc.scheme.SchemeOutputStream.
cleo.uri.scheme.classpath	No	This property defines the Java class path to the jars containing this scheme implementation. It can also contain any other jars needed for this scheme. The jar file(s) can be in any location accessible by the VersaLex application. If you wish to locate the jars within the VersaLex software installation folder, the suggested location is the lib\uri\ folder under the VersaLex installation folder. A separate class loader is used for each scheme. If certain jar files need to be loaded by the base class loader (such as GlassFish jar files for the JMS scheme), then these jars should be specified using the system property cleo.additional.classpath (see below).

Example: For the hdfs scheme, the system properties could be defined using the following command line parameters

-Dcleo.uri.hdfs.file=com.companyabc.hdfs.HdfsFile
-Dcleo.uri.hdfs.inputstream=com.companyabc.hdfs.HdfsInputStream
-Dcleo.uri.hdfs.outputstream=com.companyabc.hdfs.HdfsOutputStream
-Dcleo.uri.hdfs.classpath=C:/MyURIs/hdfsuri.jar;D:/Hadoop/hadoop-core.jar

An additional system property can be used to configure other jar files that need to be included the base class path.

System Property	Required	Description
cleo.additional.classpath	No	This property defines a list of additional JAR files that need to be included the base class path. These classes will be appended to the end of the VersaLex class path. The JAR file paths are separated by the path separator character. On UNIX systems, this character is ':' and on Microsoft Windows systems it is ';'.

Example: For a JMS scheme using GlassFish, the system property could be defined using the following command line parameter

-Dcleo.additional.classpath=C:/glassfish3/glassfish/lib/gf-client.jar

Constructor Summary

Constructors
Constructor and Description
`LexURIFile(java.lang.String uri)` Creates a LexURIFile object using the provided URI.
`LexURIFile(java.lang.String parentURI, java.lang.String child)` Creates a LexURIFile object using the provided parent URI and child.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canBeLocalUserRoot()` Returns whether or not this scheme can be used as a Local User Root.
`abstract boolean`	`canRead()` Tests whether the application can read the directory or file represented by this SchemeFile.
`abstract boolean`	`canWrite()` Tests whether the application can modify the directory or file represented by this SchemeFile.
`abstract int`	`compareTo(LexURIFile pathname)` Compares the URIs of two LexURIFiles lexicographically.
`abstract boolean`	`createNewFile()` Creates a new, empty file named by this SchemeFile if and only if a file with this name does not yet exist.
`static void`	`debug(boolean always, java.lang.String message)` Writes a message to the VersaLex debug file.
`static void`	`debug(boolean always, java.lang.String message, java.lang.Throwable ex)` Writes a message and exception to the VersaLex debug file.
`static void`	`debug(java.lang.String message)` Writes a message to the VersaLex debug file.
`static void`	`debug(java.lang.String message, java.lang.Throwable ex)` Writes a message and exception to the VersaLex debug file.
`static void`	`debugWriter(java.lang.String message, java.lang.Throwable ex)`
`abstract boolean`	`delete()` Deletes the file.
`abstract boolean`	`equals(java.lang.Object obj)` Tests this SchemeFile for equality with the given object.
`abstract boolean`	`exists()` Tests whether the directory or file exists.
`abstract LexURIFile`	`getAbsoluteFile()` Returns the absolute form of this SchemeFile.
`abstract java.lang.String`	`getAbsolutePath()` Returns the SchemeFile's absolute URI string of this SchemeFile.
`abstract LexURIFile`	`getCanonicalFile()` Returns the canonical form of this SchemeFile.
`abstract java.lang.String`	`getCanonicalPath()` Returns the canonical pathname string of this SchemeFile.
`abstract LexWildcardInfo`	`getLexWildcardInfo()` Returns an object representing the wildcard information in the URI.
`abstract java.lang.String`	`getName()` Returns the name of the file.
`java.lang.String`	`getParameters()` Returns parameters of the URI.
`abstract java.lang.String`	`getParent()` Returns the parent of the directory or file.
`abstract LexURIFile`	`getParentFile()` Returns the SchemeFile object of this SchemeFile's parent, or `null` if this pathname does not name a parent directory.
`abstract java.lang.String`	`getPath()` Converts this SchemeFile object into a URI string.
`java.lang.String`	`getPathWithoutParameters()` Returns URI with parameters removed.
`abstract LexFileType`	`getType()` Returns the LexFileType for this SchemeFile.
`java.lang.String`	`getUnderlyingPath()` Returns the absolute path of the underlying file (if possible) of this SchemeFile.
`abstract java.lang.Exception`	`getURIException()` Returns an exception generated during the SchemeFile constructor.
`int`	`hashCode()` Computes a hash code for this URI.
`abstract boolean`	`isAbsolute()` Returns `true` since all URI strings will be absolute.
`abstract boolean`	`isDirectory()` Tests whether this SchemeFile represents a directory.
`abstract boolean`	`isFile()` Tests whether this SchemeFile represents a file.
`abstract boolean`	`isHidden()` Tests whether the file named by this SchemeFile is a hidden file.
`abstract long`	`lastModified()` Returns the time that the SchemeFile was last modified.
`abstract long`	`length()` Returns the length of the file represented by this SchemeFile.
`abstract java.lang.String[]`	`list()` Returns an array of strings naming the files and directories in the directory represented by this SchemeFile.
`java.lang.String[]`	`list(java.io.FilenameFilter filter)` Returns an array of strings naming the files and directories in the directory represented by this SchemeFile that satisfy the specified filter.
`abstract LexURIFile[]`	`listFiles()` Returns an array of SchemeFile objects in the directory denoted by this SchemeFile.
`LexURIFile[]`	`listFiles(java.io.FilenameFilter filter)` Returns an array of abstract pathnames denoting the files and directories in the directory denoted by this this SchemeFile that satisfy the specified filter.
`abstract LexURIFile[]`	`listFiles(LexURIFileFilter filter)` Returns an array of SchemeFile objects filtered by the LexURIFileFilter.
`abstract boolean`	`mkdir()` Creates the directory named by this SchemeFile.
`abstract boolean`	`mkdirs()` Creates the directory named by this abstract pathname, including any necessary but nonexistent parent directories.
`static int`	`paramsIndex(java.lang.String uriString)` Finds the index of the ?
`abstract boolean`	`renameTo(LexURIFile dest)` Renames the SchemeFile If renaming is not supported, `true` should be returned.
`static java.lang.String`	`sanitizeFilename(java.lang.String name)` Sanitizes the `name` string so it can be used as a filename.
`abstract boolean`	`setLastModified(long time)` Sets the last-modified time of the file or directory named by this SchemeFile.
`abstract boolean`	`setReadable(boolean readable)` A method to set the owner's read permission for this SchemeFile.
`abstract boolean`	`setReadable(boolean readable, boolean ownerOnly)` Sets the owner's or everybody's read permission for this SchemeFile.
`abstract boolean`	`setReadOnly()` Marks the file or directory named by this SchemeFile so that only read operations are allowed.
`boolean`	`setWritable(boolean writable)` A method to set the owner's write permission for this SchemeFile.
`abstract java.lang.String`	`toString()` Returns the URI string of this SchemeFile.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LexURIFile
```
public LexURIFile(java.lang.String uri)
```
    Creates a LexURIFile object using the provided URI.
    The uri in this case could represent a directory or a file. This constructor should not be called directly but should be called through the super() function of the class extending LexURIFile.
    
    Parameters:
    
    uri - String containing the URI representing the directory or file.
  - LexURIFile
```
public LexURIFile(java.lang.String parentURI,
                  java.lang.String child)
```
    Creates a LexURIFile object using the provided parent URI and child.
    The parentURI in this case represents a directory. The child represents the file within the parent directory. This constructor should not be called directly but should be called through the super() function of the class extending LexURIFile.
    
    Parameters:
    
    parentURI - String containing the URI representing a directory.
    
    child - String containing the filename portion of the URI. This should only be the name and not include the parameter name.
- Method Detail
  - canRead
```
public abstract boolean canRead()
```
    Tests whether the application can read the directory or file represented by this SchemeFile.
    For a queue/pipe/database, this could always return true and let any failures occur through the SchemeInputStream.
    
    Returns:
    
    true if the directory or file represented by this SchemeFile exists and can be read by the application; false otherwise
  - canWrite
```
public abstract boolean canWrite()
```
    Tests whether the application can modify the directory or file represented by this SchemeFile.
    For a queue/pipe/database, this could always return true and let any failures occur through the SchemeOutputStream.
    
    Returns:
    
    true if the scheme system actually contains this directory or file and the application is allowed to write to the directory or file; false otherwise.
  - compareTo
```
public abstract int compareTo(LexURIFile pathname)
```
    Compares the URIs of two LexURIFiles lexicographically.
    
    Parameters:
    
    pathname - The SchemeFile to be compared to this SchemeFile
    
    Returns:
    
    Zero if the argument is equal to this SchemeFile, a value less than zero if this SchemeFile's URI is lexicographically less than the argument, or a value greater than zero if this SchemeFile's URI is lexicographically greater than the argument.
  - createNewFile
```
public abstract boolean createNewFile()
                               throws java.io.IOException
```
    Creates a new, empty file named by this SchemeFile if and only if a file with this name does not yet exist. The check for the existence of the file and the creation of the file if it does not exist are a single operation that is atomic with respect to all other scheme activities that might affect the file.
    For queues, pipes, and databases, this method may do nothing besides return the boolean value.
    
    Returns:
    
    true if the named file does not exist and was successfully created; false if the named file already exists
    
    Throws:
    
    java.io.IOException - If an I/O error occurred
  - delete
```
public abstract boolean delete()
```
    Deletes the file. If this SchemeFile represents directory, then the directory must be empty in order to be deleted.
    
    Returns:
    
    true if the file or directory is successfully deleted; false otherwise
  - equals
```
public abstract boolean equals(java.lang.Object obj)
```
    Tests this SchemeFile for equality with the given object. Returns true if the argument is not null and is a SchemeFile that denotes the same directory or file as this SchemeFile.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - object to be compared with this SchemeFile
    
    Returns:
    
    true if the objects are the same; false otherwise
  - exists
```
public abstract boolean exists()
```
    Tests whether the directory or file exists.
    For queues/pipes/databases: If a specific filename is included in the SchemeFile's URI, then this checks for that specific item in the queue/pipe/database exists. If the SchemeFile represents a directory, then this returns true if the queue/pipe/database table exists.
    
    Returns:
    
    true if the file or directory exists; false otherwise
  - getAbsoluteFile
```
public abstract LexURIFile getAbsoluteFile()
```
    Returns the absolute form of this SchemeFile. Equivalent to new SchemeFile(this.LexURIFile.getAbsolutePath()).
    Since SchemeFile extends LexURIFile, a SchemeFile can and should be returned.
    
    Returns:
    
    The SchemeFile denoting the same directory or file as this SchemeFile
  - getAbsolutePath
```
public abstract java.lang.String getAbsolutePath()
```
    Returns the SchemeFile's absolute URI string of this SchemeFile.
    Since the URI is already absolute, then the pathname string is simply returned as if by the LexURIFile.getPath() method.
    
    Returns:
    
    The SchemeFile's absolute pathname URI string denoting the same directory or file as this URI
  - getUnderlyingPath
```
public java.lang.String getUnderlyingPath()
```
    Returns the absolute path of the underlying file (if possible) of this SchemeFile. This will return the URI path unless overridden by the URI implementation.
    
    Returns:
    
    The path of the underlying path (if possible) of the SchemeFile object.
  - getCanonicalFile
```
public abstract LexURIFile getCanonicalFile()
```
    Returns the canonical form of this SchemeFile. Equivalent to new SchemeFile(this.LexURIFile.getCanonicalPath()).
    Since SchemeFile extends LexURIFile, a SchemeFile can and should be returned.
    
    Returns:
    
    A SchemeFile object with the same URI.
  - getCanonicalPath
```
public abstract java.lang.String getCanonicalPath()
                                           throws java.io.IOException
```
    Returns the canonical pathname string of this SchemeFile.
    Since the SchemeFile is already absolute, then the pathname string is simply returned as if by the LexURIFile.getPath() method.
    
    Returns:
    
    Returns the canonical pathname string of this SchemeFile.
    
    Throws:
    
    java.io.IOException - If an I/O error occurred
  - getName
```
public abstract java.lang.String getName()
```
    Returns the name of the file.
    For a file system, this would be the last portion of the filename path. For a queue/pipe/database, this is filename portion of the URI not including the parameter name.
    Examples:
    - msmq:DIRECT=OS:.\private$\Outbox?msgLabel=test.edi
      getName() would return test.edi
    - msmq:DIRECT=OS:.\private$\Outbox?msgLabel=*.edi
      getName() would return *.edi
    - jms:jndi:jms/InboxQueue?msgFilename=[test.edi]&jndiConnectionFactoryName=jms/ConnectionFactory&filenameProp=filename
      getName() would return [test.edi]
    Returns:
    
    Returns the name of the file represented by this SchemeFile.
  - getParent
```
public abstract java.lang.String getParent()
```
    Returns the parent of the directory or file.
    For a file system, this would be all but the last portion of the filename path.
    For a queue/pipe/database:
    - If the SchemeFile represents a file, then the URI without any file specific parameters is returned.
    - If the SchemeFile represents a folder, then a null is returned.
      Examples:
      
      msmq:DIRECT=OS:.\private$\Outbox?msgLabel=test.edi
      getParent() would return msmq:DIRECT=OS:.\private$\Outbox
      
      msmq:DIRECT=OS:.\private$\Outbox
      getParent() would return null
      
      jms:jndi:jms/InboxQueue?msgFilename=[test.edi]&jndiConnectionFactoryName=jms/ConnectionFactory&filenameProp=filename
      getParent() would return jms:jndi:jms/InboxQueue?jndiConnectionFactoryName=jms/ConnectionFactory&filenameProp=filename
    Returns:
    
    Returns the name of the parent represented by this SchemeFile.
  - getParentFile
```
public abstract LexURIFile getParentFile()
```
    Returns the SchemeFile object of this SchemeFile's parent, or null if this pathname does not name a parent directory.
    Since SchemeFile extends LexURIFile, a SchemeFile can and should be returned.
    If this SchemeFile has a parent, then this is equivalent to new SchemeFile(this.LexURIFile.getParent()).
    
    Returns:
    
    The SchemeFile object of the parent directory named by this SchemeFile, or null if this SchemeFile does not name a parent
  - getPath
```
public abstract java.lang.String getPath()
```
    Converts this SchemeFile object into a URI string.
    
    Returns:
    
    Returns the URI string for the SchemeFile object
  - getPathWithoutParameters
```
public java.lang.String getPathWithoutParameters()
```
    Returns URI with parameters removed. Override this method if the using the last ? is not sufficient.
    
    Returns:
    
    Returns the URI string for the SchemeFile object without any parameters
  - getParameters
```
public java.lang.String getParameters()
```
    Returns parameters of the URI. Override this method if the using the last ? is not sufficient.
    
    Returns:
    
    Returns the parameter portion of the URI string for the SchemeFile object
  - paramsIndex
```
public static int paramsIndex(java.lang.String uriString)
```
    Finds the index of the ? marking the start of the parameters
    
    Parameters:
    
    uriString - String containing the URI NOTE: If wildcards are used within the path, then either URI parameters must be specified or ? must be added at the end of the path. In other words, the right-most ? must signal the start of the parameters (even if there aren't any parameters).
    
    Returns:
    
    Returns the index of the "?" deemed to be the start of the parameters
  - isAbsolute
```
public abstract boolean isAbsolute()
```
    Returns true since all URI strings will be absolute.
    
    Returns:
    
    true
  - isDirectory
```
public abstract boolean isDirectory()
```
    Tests whether this SchemeFile represents a directory.
    For file systems, returns true if this SchemeFile item exists and is a directory.
    For queues/pipes/databases, returns false if the SchemeFile is meant to represent a message/item/record in the queue/pipe/database. It returns true if the SchemeFile is meant to represent the queue/pipe/database table itself.
    
    Returns:
    
    true if the SchemeFile represents a directory; false otherwise
  - isFile
```
public abstract boolean isFile()
```
    Tests whether this SchemeFile represents a file.
    For file systems, returns true if this SchemeFile item exists and is a file.
    For queues/pipes/databases, returns true if the SchemeFile is meant to represent a message/item/record in the queue/pipe/database. It returns false if the SchemeFile is meant to represent the queue/pipe/database table itself.
    
    Returns:
    
    true if the SchemeFile represents a directory; false otherwise
  - isHidden
```
public abstract boolean isHidden()
```
    Tests whether the file named by this SchemeFile is a hidden file.
    For file systems, the definition of hidden is operating system dependant.
    For queues/pipes/databases, this would normally always return false
    
    Returns:
    
    true if the item is hidden; false otherwise
  - lastModified
```
public abstract long lastModified()
```
    Returns the time that the SchemeFile was last modified.
    For file systems, this would be the last modified timestamp on the file.
    For queues/pipes/databases, this could be the time when the message/item/record was added to the queue/pipe/database.
    
    Returns:
    
    A long value representing the time the SchemeFile was last modified, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970), or 0L if the file does not exist or if an I/O error occurs
  - length
```
public abstract long length()
```
    Returns the length of the file represented by this SchemeFile.
    For queues/pipes/databases, this would be the length, in bytes, of the message/item/database field. For file systems, this would be the length, in bytes, of the file.
    
    Returns:
    
    The length, in bytes, of the file represented by this SchemeFile, or 0L if the file does not exist.
  - list
```
public abstract java.lang.String[] list()
```
    Returns an array of strings naming the files and directories in the directory represented by this SchemeFile.
    If this SchemeFile does not represent a directory, then this method returns null. Otherwise an array of strings is returned, one for each file or directory in the directory.
    For file systems, names denoting the directory itself and the directory's parent directory are not included in the result. Each string is a file name rather than a complete path.
    For queues/pipes/databases, each string is a complete path including the file name. The URI should also include any additional information uniquely identifying the item such as a message ID or database primary key. This is because the filename is not necessarily unique in these systems.
    For example:
    If the list() was called for a URI of msmq:DIRECT=OS:.\private$\Outbox
    The following is an example of return values:
    - msmq:DIRECT=OS:.\private$\Outbox?msgLabel=test.edi&msgID=aced99d8-1e38-41c1-855f-26d13e977e7e\7893370&length=1533&arrival=20120315-160240
    - msmq:DIRECT=OS:.\private$\Outbox?msgLabel=abc.edi&msgID=aced99d8-1e38-41c1-855f-26d13e977e7e\7893376&length=1533&arrival=20120315-160240
    - msmq:DIRECT=OS:.\private$\Outbox?msgLabel=test100K.edi&msgID=aced99d8-1e38-41c1-855f-26d13e977e7e\7893361&length=102400&arrival=20120315-160240
    - msmq:DIRECT=OS:.\private$\Outbox?msgLabel=test100K.edi&msgID=aced99d8-1e38-41c1-855f-26d13e977e7e\7893364&length=102400&arrival=20120315-160240
    There is no guarantee that the name strings in the resulting array will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.
    Returns:
    
    An array of strings naming the files and directories in the directory denoted by this SchemeFile. The array will be empty if the directory is empty. Returns null if this SchemeFile does not represent a directory, or if an I/O error occurs.
  - listFiles
```
public abstract LexURIFile[] listFiles()
```
    Returns an array of SchemeFile objects in the directory denoted by this SchemeFile.
    If this SchemeFile does not denote a directory, then this method returns null. Otherwise an array of SchemeFile objects is returned, one for each file or directory in the directory. Pathnames denoting the directory itself and the directory's parent directory are not included in the result.
    There is no guarantee that the name strings in the resulting array will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.
    Since SchemeFile extends LexURIFile, an array of SchemeFile can and should be returned.
    
    Returns:
    
    An array of SchemeFiles denoting the files and directories in the directory denoted by this SchemeFile. The array will be empty if the directory is empty. Returns null if this SchemeFile does not denote a directory, or if an I/O error occurs.
  - listFiles
```
public abstract LexURIFile[] listFiles(LexURIFileFilter filter)
```
    Returns an array of SchemeFile objects filtered by the LexURIFileFilter.
    Since SchemeFile extends LexURIFile, an array of SchemeFile can and should be returned.
    The SchemeFile code should perform something similar to the following to determine if the LexURIFile (SchemeFile) is acceptable to be returned in the array.
    The following example is for an Hdfs scheme.
```
 
  public HdfsFile[] listFiles(LexURIFileFilter filter) {
    // Throw SecurityException if URI was bad in constructor
    if (this.uriSyntaxException != null) 
      throw new SecurityException(this.uriSyntaxException);

    // Build list of all items
    String[] uriFileList = this.list();
    if (uriFileList == null)
      return null;

    // Build list of acceptable items
    ArrayList<HdfsFile> fileList = new ArrayList<HdfsFile>();
    for (int ii = 0; ii < uriFileList.length; ii++) {
      HdfsFile hdfsFile = new HdfsFile(uriFileList[ii]);
      if ((filter == null) || (filter.accept(hdfsFile)))
        fileList.add(hdfsFile);
    }

    // Return array of accepted items
    return fileList.toArray(new HdfsFile[fileList.size()]);
  }
 
 
```
    Parameters:
    
    filter - A LexURIFileFilter implemented with VersaLex. The SchemeFile implementation should call filter.accept(lexURIFile) method to determine if this SchemeFile should be included in the return array.
    
    Returns:
    
    Returns an array of SchemeFile objects filtered by filter.
  - mkdir
```
public abstract boolean mkdir()
```
    Creates the directory named by this SchemeFile.
    For SchemeFile types that do not support subdirectories, such as queues/pipes/databases, this should return true.
    
    Returns:
    
    true if the directory was created; false otherwise
  - mkdirs
```
public abstract boolean mkdirs()
```
    Creates the directory named by this abstract pathname, including any necessary but nonexistent parent directories. Note that if this operation fails it may have succeeded in creating some of the necessary parent directories.
    For SchemeFile types that do not support subdirectories, such as queues/pipes/databases, this should return true.
    
    Returns:
    
    true if the directory was created, along with all necessary parent directories; false otherwise
  - renameTo
```
public abstract boolean renameTo(LexURIFile dest)
```
    Renames the SchemeFile
    If renaming is not supported, true should be returned.
    
    Parameters:
    
    dest - The new name (contained within the SchemeFile) for the named file
    
    Returns:
    
    true if the renaming succeeded or is not supported; false otherwise
  - setLastModified
```
public abstract boolean setLastModified(long time)
```
    Sets the last-modified time of the file or directory named by this SchemeFile.
    If setting the last modified time is not supported, then either true can be returned or a SecurityException may be thrown.
    
    Parameters:
    
    time - The new last-modified time, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970)
    
    Returns:
    
    true if the operation succeeded; false otherwise
  - setReadable
```
public abstract boolean setReadable(boolean readable)
```
    A method to set the owner's read permission for this SchemeFile.
    If this is not supported for the scheme, then either true can be returned or a SecurityException may be thrown.
    
    Parameters:
    
    readable - If true, sets the access permission to allow read operations; if false to disallow read operations
    
    Returns:
    
    true if the operation succeeded or is not supported
  - setReadable
```
public abstract boolean setReadable(boolean readable,
                                    boolean ownerOnly)
```
    Sets the owner's or everybody's read permission for this SchemeFile.
    If this is not supported for the scheme, then either true can be returned or a SecurityException may be thrown.
    
    Parameters:
    
    readable - If true, sets the access permission to allow read operations; if false to disallow read operations
    
    ownerOnly - If true, the read permission applies only to the owner's read permission; otherwise, it applies to everybody. If the underlying file system can not distinguish the owner's read permission from that of others, then the permission will apply to everybody, regardless of this value.
    
    Returns:
    
    true if the operation succeeded or is not supported
  - setReadOnly
```
public abstract boolean setReadOnly()
```
    Marks the file or directory named by this SchemeFile so that only read operations are allowed.
    If this is not supported for the scheme, then either true can be returned or a SecurityException may be thrown.
    
    Returns:
    
    true if the operation succeeded or is not supported; false otherwise
  - setWritable
```
public boolean setWritable(boolean writable)
```
    A method to set the owner's write permission for this SchemeFile.
    If this is not supported for the scheme, then either true can be returned or a SecurityException may be thrown. *
    NOTE: The default implementation of this method ALWAYS throws an exception.
    
    Parameters:
    
    writable - If true, sets the access permission to allow write operations; if false to disallow write operations
    
    Returns:
    
    true if the operation succeeded or is not supported
  - toString
```
public abstract java.lang.String toString()
```
    Returns the URI string of this SchemeFile. This is the same string returned by the LexURIFile.getPath() method.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The string form of this SchemeFile
  - list
```
public java.lang.String[] list(java.io.FilenameFilter filter)
```
    Returns an array of strings naming the files and directories in the directory represented by this SchemeFile that satisfy the specified filter. The behavior of this method is the same as that of the LexURIFile.list() method, except that the strings in the returned array must satisfy the filter. If the given filter is null then all names are accepted. Otherwise, a name satisfies the filter if and only if the value true results when the FilenameFilter.accept() method of the filter is invoked on this abstract pathname and the name of a file or directory in the directory that it denotes.
    NOTES:
    - The default implementation of this method ALWAYS throws an exception.
    - This method should be overridden when this scheme is being used for local user folders.
    Parameters:
    
    filter - A filename filter
    
    Returns:
    
    An array of strings naming the files and directories in the directory denoted by this this SchemeFile that were accepted by the given filter. The array will be empty if the directory is empty or if no names were accepted by the filter. Returns null if this abstract pathname does not denote a directory, or if an I/O error occurs.
  - listFiles
```
public LexURIFile[] listFiles(java.io.FilenameFilter filter)
```
    Returns an array of abstract pathnames denoting the files and directories in the directory denoted by this this SchemeFile that satisfy the specified filter. The behavior of this method is the same as that of the LexURIFile.listFiles() method, except that the pathnames in the returned array must satisfy the filter. If the given filter is null then all pathnames are accepted. Otherwise, a pathname satisfies the filter if and only if the value true results when the FilenameFilter.accept() method of the filter is invoked on this abstract pathname and the name of a file or directory in the directory that it denotes.
    NOTE: The default implementation of this method ALWAYS throws an exception.
    
    Parameters:
    
    filter - A filename filter
    
    Returns:
    
    An array of abstract pathnames denoting the files and directories in the directory denoted by this abstract pathname. The array will be empty if the directory is empty. Returns null if this abstract pathname does not denote a directory, or if an I/O error occurs.
  - hashCode
```
public int hashCode()
```
    Computes a hash code for this URI.
    This is implemented in LexURIFile and can be overridden if needed.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    A hash code for this URI
  - getType
```
public abstract LexFileType getType()
```
    Returns the LexFileType for this SchemeFile.
    This should return one of the following depending on the type of the implemented scheme:
    - LexFileType.DATABASE
    - LexFileType.FILESYSTEM
    - LexFileType.PIPE
    - LexFileType.QUEUE
    Although databases are described in the javadocs as not having subdirectories, it would be possible to have a directory-like structure by storing the directory path in the database. If your intent is to support subdirectories using a database, then the LexFileType returned should be LexFileType.FILESYSTEM and the URI should be something that resembles a file system. Such as:
    myDB:\SomeDir\SubDir1\SubDir2\filename
    Returns:
    
    Returns the appropriate LexFileType for this SchemeFile.
  - getURIException
```
public abstract java.lang.Exception getURIException()
```
    Returns an exception generated during the SchemeFile constructor.
    If there is a problem with the URI, an exception should not be thrown during the constructor. Instead the exception should be saved and getURIException() should return this exception. In addition, if any method is called after a constructor with a bad URI, the saved exception should be thrown at the time the method is called.
    
    Returns:
    
    The exception generated during the SchemeFile constructor. Otherwise a null should be returned.
  - getLexWildcardInfo
```
public abstract LexWildcardInfo getLexWildcardInfo()
```
    Returns an object representing the wildcard information in the URI.
    This should interrogate the URI and return a LexWildcardInfo object created with LexWildcardInfo(String path, String wildcard). If there is no wildcard ('*', '?', or '[regex]') in the filename portion of the URI, then a null object should be returned. If a wildcard exists in the filename portion of the URI, the path should be a valid URI without the filename parameter. The wildcard would be the value portion of the filename parameter.
    Examples:
    - msmq:DIRECT=OS:.\private$\Outbox?msgLabel=test.edi
      This would return a null object as there is no wildcard.
    - msmq:DIRECT=OS:.\private$\Outbox?msgLabel=*.edi
      This would return a new LexWildcardInfo( "msmq:DIRECT=OS:.\private$\Outbox", "*.edi" ) object.
    - jms:jndi:jms/InboxQueue?msgFilename=[test.edi]&jndiConnectionFactoryName=jms/ConnectionFactory&filenameProp=filename
      This would return a new LexWildcardInfo( "jms:jndi:jms/InboxQueue?jndiConnectionFactoryName=jms/ConnectionFactory&filenameProp=filename", "[test.edi]" ) object.
    Returns:
    
    Returns a LexWildcardInfo object if a wildcard is present or null otherwise.
  - canBeLocalUserRoot
```
public boolean canBeLocalUserRoot()
```
    Returns whether or not this scheme can be used as a Local User Root. This can be overridden if necessary in the URI.
    
    Returns:
    
    Returns whether or not this scheme can be used as a Local User Root.
  - sanitizeFilename
```
public static java.lang.String sanitizeFilename(java.lang.String name)
```
    Sanitizes the name string so it can be used as a filename.
    This function returns a string with the following characters replaced with an underscore ( _ ):
    : \ / * ? | < > "
    
    Parameters:
    
    name - String to sanitize to become a valid filename.
    
    Returns:
    
    Returns a sanitized string than can be used as a filename.
  - debug
```
public static void debug(java.lang.String message)
```
    Writes a message to the VersaLex debug file.
    Writes to the VersaLex debug file if the Debug Option, URI, is enabled and the System Debug Level is Debug or higher.
    
    Parameters:
    
    message - Message to write to the debug file.
  - debug
```
public static void debug(boolean always,
                         java.lang.String message)
```
    Writes a message to the VersaLex debug file.
    If always is true, then it writes to the VersaLex debug file even if the Debug Option, URI, is not enabled. However, the System Debug Level must be Debug or higher in order for the message to be logged.
    
    Parameters:
    
    always - Set to true if you want to write to the debug file regardless of the state of the URI Debug Option.
    
    message - Message to write to the debug file.
  - debug
```
public static void debug(java.lang.String message,
                         java.lang.Throwable ex)
```
    Writes a message and exception to the VersaLex debug file.
    Writes the message and execption to the VersaLex debug file if the Debug Option, URI, is enabled and the System Debug Level is Debug or higher.
    
    Parameters:
    
    message - Message to write to the debug file.
    
    ex - Exception to be logged.
  - debug
```
public static void debug(boolean always,
                         java.lang.String message,
                         java.lang.Throwable ex)
```
    Writes a message and exception to the VersaLex debug file.
    If always is true, then it writes the message and exception to the VersaLex debug file even if the Debug Option, URI, is not enabled. However, the System Debug Level must be Debug or higher in order for the message to be logged.
    
    Parameters:
    
    always - Set to true if you want to write to the debug file regardless of the state of the URI Debug Option.
    
    message - Message to write to the debug file.
    
    ex - Exception to be logged.
  - debugWriter
```
public static void debugWriter(java.lang.String message,
                               java.lang.Throwable ex)
```

Class LexURIFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LexURIFile

LexURIFile

Method Detail

canRead

canWrite

compareTo

createNewFile

delete

equals

exists

getAbsoluteFile

getAbsolutePath

getUnderlyingPath

getCanonicalFile

getCanonicalPath

getName

getParent

getParentFile

getPath

getPathWithoutParameters

getParameters

paramsIndex

isAbsolute

isDirectory

isFile

isHidden

lastModified

length

list

listFiles

listFiles

mkdir

mkdirs

renameTo

setLastModified

setReadable

setReadable

setReadOnly

setWritable

toString

list

listFiles

hashCode

getType

getURIException

getLexWildcardInfo

canBeLocalUserRoot

sanitizeFilename

debug

debug

debug

debug

debugWriter