Utilities (Oracle WebCenter Sites Java API Reference)

java.lang.Object
- COM.FutureTense.Interfaces.Utilities

```
@Exported
public class Utilities
extends Object
```
Utility methods. These methods provide an easy to use interface to for some commonly needed functionality.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`msgbody` Use this to locate the body portion of a returned getPOP3Messages() element
`static String`	`product` For finding out the IPS product name

Constructor Summary

Constructors
Modifier Constructor and Description

protected Utilities()

Constructors
Modifier	Constructor and Description
`protected`	`Utilities()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static boolean`	`appendFile(String fname, byte[] bytes, int size)` Appends to a file to disk.
`static boolean`	`appendFile(String fname, String str)` Appends to a file to disk.
`static long`	`availableDisk(String pathDir)`
`static Calendar`	`calendarFromJDBCString(String s)` Returns a calendar object from JDBC date/time.
`static Path`	`createTempFile(boolean bManageDelete)` Method to create a temporary file
`static boolean`	`cryptoEnabled()` Checks if encryption is enabled.
`static String`	`deBabble(String s)` Replaces %20,%22,%19,%3c,%3e,%26 in input string with the characters they represent.
`static String`	`decryptString(String s)` Decrypts a string with the default key.
`static String`	`decryptString(String s, byte[] key)` Decrypts a string with the supplied key.
`static boolean`	`deleteFile(String fname)` Deletes a file from disk.
`static Vector`	`directoryList(String path, String filter, boolean recurse, int maxcount)` Returns a vector of filenames given a path and a filter.
`static Vector`	`directoryList(String path, String filter, boolean recurse, int maxcount, COM.FutureTense.Interfaces.IDirectoryObserver ido)` Returns a vector of filenames given a path and a filter.
`static int`	`emptyFolder(String path, boolean bDelete)` Delete a folder (optional) and all the contents within, recursively.
`static int`	`emptyfolder(String path, String pattern)` Delete all the files which match the pattern from the specified directory tree, recursively.
`static String`	`encryptPlatformString(String s)` Encrypts a string with the default key.
`static String`	`encryptPlatformString(String s, byte[] key)` Encrypts a string with the supplied key.
`static String`	`encryptString(String s)` Encrypts a string with the default key.
`static String`	`encryptString(String s, byte[] key)` Encrypts a string with the supplied key.
`static boolean`	`ensureFolder(Path path)` Make sure a path exists, creating sub-folders as needed.
`static boolean`	`ensureFolder(String path)` Make sure a path exists, creating subfolders as needed
`static boolean`	`equals(String createddate, String updateddate)` Sometimes java get this from database 2014-05-01 10:39:17.333 2014-05-01 10:39:17.332 but they are exactly the same in database
`static Vector`	`fetchPOP3Messages(String host, String user, char[] password, boolean bRemove)` Retrieves a vector of messages from a POP3 server; default connection timeout is 190 seconds.
`static Vector`	`fetchPOP3Messages(String host, String user, char[] password, boolean bRemove, int ctimeout)` Retrieves a vector of messages from a POP3 server; specify the connection timeout on checking for new mail.
`static boolean`	`fileExists(String name)` Does a verification of a file existing on disk.
`static String`	`fileFromSpec(String spec)` Returns a file from a file specification.
`static boolean`	`fileLockLoadOK()` Check to see if the file lock native library loaded successfully.
`static String`	`fileName(String folder, String fname)` Creates a full path including file name, given a folder and file name.
`static String`	`generateUUID()`
`static String`	`genID()` Deprecated. use ICS.genID(boolean) instead
`static String`	`genID(ICS icsThread)` Deprecated. use ICS.genID(boolean) instead
`static String`	`getBLOBDir(String seed)` Generate hash-based directory based on given seed.
`static Comparator<String>`	`getCaseInSensitiveStringComparator()` Returns a comparator for string objects, which compares strings in case insensitive way.
`static char[]`	`getCharArray(String value)` Converts String to char[]
`static String`	`getNameNoTrailingNumber(String name)` Returns normalized name after removing the trailing comma number from name.
`static FTValList`	`getParams(String in)` Build a vallist of parameters given input in the form of a=b and c=d
`static void`	`getParams(String sInput, Map map, boolean bDecode)` Build a map of parameters given input in the form of a=b and c=d
`static Vector`	`getPOP3Messages(String host, String user, String password, boolean bRemove)` Deprecated. fetchPOP3Messages
`static Vector`	`getPOP3Messages(String host, String user, String password, boolean bRemove, int ctimeout)` Deprecated. use fetchPOP3Messages
`static String`	`getWebRoot()`
`static boolean`	`goodString(char[] s)`
`static boolean`	`goodString(String s)` Return if a string is empty or null
`static String`	`handleOSCharacters(String input)` Handles characters reserved by supported OS.
`static boolean`	`isAllowedHeader(String headerStr)` The method is used to check whether the passed header is valid or not.
`static int`	`isFile(String p)` Verify a file
`static int`	`isFolder(String p)` Verify a folder
`static boolean`	`isText(String sContentType)` Method to determine whether sContentType is a text mime-type Note: the standard is evolving Reference: 1.
`static boolean`	`isValidEmail(String email)` Check if the email is a valid email, this enforces the same check that is enforced by the UI pages.
`static boolean`	`itemIsInList(Vector l, String s, boolean c)` Determines if a given string is in a vector.
`static String`	`jdbcDateFromCal(Calendar c)` Returns a JDBC formatted date from a calendar object.
`static String`	`jdbcTimeFrom(Calendar cal)` Returns a JDBC formatted time from a calendar object.
`static String`	`keysFromMap(Map map)` Return a string of keys from the Map
`static boolean`	`lockFile(String file)` Lock a file name for exclusive use by this thread.
`static boolean`	`osIgnoreFileCase()` Return if the server OS has case specific versus case preserve file system naming.
`static String`	`osSafeSpec(String spec)` Returns a filespec where the "/" or "\" characters have been replaced by the system specific paths.
`static String`	`pathFromSpec(String spec)` Returns a path from a file specification.
`static byte[]`	`readByteFile(String spec)` Reads in the file indicated by the passed file path, and returns the bytes.
`static byte[]`	`readByteURL(String spec)` Reads the passed URL, and returns its bytes.
`static byte[]`	`readByteURL(String spec, boolean secure)` Reads the passed URL, and returns its bytes.
`static String`	`readFile(Path spec)` Reads in the file indicated by the passed file path, and returns its contents.
`static String`	`readFile(String spec)` Reads in the file indicated by the passed file path, and returns its contents.
`static boolean`	`readFile(String spec, OutputStream os)` Reads in the file indicated by the passed file path, and writes the bytes to the stream.
`static String`	`readFile(String spec, String sEncoding)` Reads in the file indicated by the passed file path, and returns its contents.
`static String`	`readURL(String url)` Reads the passed URL, and returns its contents.
`static String`	`readURL(String url, boolean secure)` Reads the passed URL, and returns its contents.
`static String`	`replaceAll(String source, String what, String with)` Replaces a strings contents (all occurrences) with specified values.
`static boolean`	`sendMail(String from, String[] to, String sub, String replyto, String messagestr, String server, StringBuffer err)` Sends an SMTP mail
`static boolean`	`sendMail(String from, String[] to, String sub, String replyto, String messagestr, String server, String contenttype, StringBuffer err)` Deprecated. use sendMail which includes charset instead
`static boolean`	`sendMail(String from, String[] to, String sub, String replyto, String messagestr, String server, String contenttype, String charset, StringBuffer err)` Sends an SMTP mail
`static boolean`	`sendMail(String from, String to, String sub, String replyto, String messagestr, String server, StringBuffer err)` Sends an SMTP mail message.
`static boolean`	`sendMail(String from, String to, String sub, String replyto, String messagestr, String server, String contenttype, StringBuffer err)` Deprecated. use sendMail which includes charset instead
`static boolean`	`sendMail(String from, String to, String sub, String replyto, String messagestr, String server, String contenttype, String charset, StringBuffer err)` Sends an SMTP mail message.
`static Vector`	`sortWords(Vector words)` Sort a list of strings, longest to shortest
`static Vector`	`sortWordsAlpha(Vector words)` Sort a list of strings alphanumerically
`static String`	`sqlDate(Calendar cal)` Returns a string formatted as JDBC date/time from a calendar object.
`static String`	`stringFromList(List list)` Method to convert a collection into a comma separated list
`static String`	`stringFromValList(Map map)` Create a url-like set of name/values from a map ie x=y and a=b and c=d
`static String`	`stringFromValList(Map map, boolean bEncode)` Create a url-like set of name/values from a map ie x=y and a=b and c=d
`static String`	`tempFolder()`
`static boolean`	`unlockFile(String file)` Unlock a file name from exclusive use by this thread
`static int`	`unzip2(String basedir, InputStream in)`
`static int`	`unzipFile(String zip, String folder)` Unzips a file into a folder.
`static boolean`	`validateZip(String zip)` Validates a zip file's zip integrity.
`static Vector`	`words(String str, int sep)` Parses a string into a vector of words.
`static Vector`	`words(String cmd, String sep)` Parses a string into a vector of words.
`static boolean`	`writeFile(String fname, byte[] bytes, int len)` Writes a file to disk, given an OS specific path and the contents of the file.
`static boolean`	`writeFile(String fname, String str)` Writes a file to disk, given an OS specific path and the contents of the file.
`static boolean`	`writeFile2(String fname, byte[] bytes, int len)`
`static boolean`	`zip(Map map, String file)` Takes for each entry in the map makes a zip entry, and then creates the zip in a location specified by sOutputFile.
`static boolean`	`zip2(Map<String,Path> files, OutputStream out)`
`static boolean`	`zipDirectory(String zipfile, String dirname, boolean recursive, String files)` Takes for each entry in the map makes a zip entry, and then creates the zip in a location specified by sOutputFile.

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

- Field Detail
  - product
```
public static String product
```
    For finding out the IPS product name
  - msgbody
```
public static String msgbody
```
    Use this to locate the body portion of a returned getPOP3Messages() element
- Constructor Detail
  - Utilities
```
protected Utilities()
```
- Method Detail
  - getWebRoot
```
public static String getWebRoot()
```
  - osSafeSpec
```
public static final String osSafeSpec(String spec)
```
    Returns a filespec where the "/" or "\" characters have been replaced by the system specific paths.
    
    Parameters:
    
    spec - The input file specification.
    
    Returns:
    
    The converted, OS-specific string.
  - pathFromSpec
```
public static final String pathFromSpec(String spec)
```
    Returns a path from a file specification. The specification does not have to be a complete or proper file path.
    
    Parameters:
    
    spec - file specification
    
    Returns:
    
    path to file
    
    Since:
    
    4.0
    
    See Also:
    
    Utilities.fileFromSpec(String)
  - fileFromSpec
```
public static final String fileFromSpec(String spec)
```
    Returns a file from a file specification. The specification does not have to be a complete or proper file path.
    
    Parameters:
    
    spec - file specification
    
    Returns:
    
    file name
    
    Since:
    
    4.0
    
    See Also:
    
    Utilities.pathFromSpec(String)
  - createTempFile
```
public static final Path createTempFile(boolean bManageDelete)
                                 throws IOException
```
    Method to create a temporary file
    
    Parameters:
    
    bManageDelete - true to indicate that call will not delete the file
    
    Returns:
    
    file object of file or null on error
    
    Throws:
    
    IOException - on error
    
    Since:
    
    5.0
  - readFile
```
public static final String readFile(String spec,
                                    String sEncoding)
```
    Reads in the file indicated by the passed file path, and returns its contents. The path is converted to the appropriate OS safe path.
    
    Parameters:
    
    spec - The path and file name of the file to read.
    
    sEncoding - The character encoding of the file data
    
    Returns:
    
    The data in the file.
  - readFile
```
public static final String readFile(String spec)
```
    Reads in the file indicated by the passed file path, and returns its contents. The path is converted to the appropriate OS safe path. Will strip out characters returned by java.lang.Character.isIdentifierIgnorable().
    
    Parameters:
    
    spec - The path and file name of the file to read.
    
    Returns:
    
    The data in the file.
  - readFile
```
public static final String readFile(Path spec)
```
    Reads in the file indicated by the passed file path, and returns its contents. The path is converted to the appropriate OS safe path. Will strip out characters returned by java.lang.Character.isIdentifierIgnorable().
    
    Parameters:
    
    spec - The path of the file to read
    
    Returns:
    
    The data in the file.
  - readByteFile
```
public static final byte[] readByteFile(String spec)
```
    Reads in the file indicated by the passed file path, and returns the bytes. The path is converted to the appropriate OS safe path.
    
    Parameters:
    
    spec - The path and file name of the file to read.
    
    Returns:
    
    An byte array of the files contents or null.
  - fileExists
```
public static final boolean fileExists(String name)
```
    Does a verification of a file existing on disk.
    
    Parameters:
    
    name - The path and file name of the file to verify.
    
    Returns:
    
    File exists true or false.
  - readFile
```
public static final boolean readFile(String spec,
                                     OutputStream os)
                              throws IOException
```
    Reads in the file indicated by the passed file path, and writes the bytes to the stream. The path is converted to the appropriate OS safe path.
    
    Parameters:
    
    spec - The path and file name of the file to read. Stream may throw an exception.
    
    os - An OutputStream
    
    Returns:
    
    success/failure
    
    Throws:
    
    IOException - on error
  - readURL
```
public static final String readURL(String url)
```
    Reads the passed URL, and returns its contents.
    
    Parameters:
    
    url - The URL to read, that is, "http://www.futuretense.com/".
    
    Returns:
    
    The contents of the URL in a string.
  - readByteURL
```
public static final byte[] readByteURL(String spec)
```
    Reads the passed URL, and returns its bytes.
    
    Parameters:
    
    spec - The URL to read, that is, "http://www.futuretense.com/".
    
    Returns:
    
    The contents of the URL in a byte array.
  - readURL
```
public static final String readURL(String url,
                                   boolean secure)
```
    Reads the passed URL, and returns its contents. Validating the contents using ESAPI validator
    
    Parameters:
    
    url - The URL to read, that is, "http://www.futuretense.com/".
    
    secure - If true will validate the content using ESAPI validator
    
    Returns:
    
    The contents of the URL in a string.
  - readByteURL
```
public static final byte[] readByteURL(String spec,
                                       boolean secure)
```
    Reads the passed URL, and returns its bytes.
    
    Parameters:
    
    spec - The URL to read, that is, "http://www.futuretense.com/".
    
    secure - If true will validate the content using ESAPI validator
    
    Returns:
    
    The contents of the URL in a byte array.
  - fileName
```
public static final String fileName(String folder,
                                    String fname)
```
    Creates a full path including file name, given a folder and file name. If fname is full path of the file then folder is ignored.
    
    Parameters:
    
    folder - The folder for the file.
    
    fname - The name of the file.
    
    Returns:
    
    The full name and path of the file.
  - writeFile
```
public static final boolean writeFile(String fname,
                                      String str)
```
    Writes a file to disk, given an OS specific path and the contents of the file.
    
    Parameters:
    
    fname - The path and name of the file.
    
    str - The data to write to the file.
    
    Returns:
    
    Returns true on success, false on failure.
  - unzipFile
```
public static final int unzipFile(String zip,
                                  String folder)
```
    Unzips a file into a folder.
    
    Parameters:
    
    zip - The path and name of the file to unzip.
    
    folder - The folder to unzip the file into.
    
    Returns:
    
    Returns 0 on success, or error code on error.
  - zip2
```
public static boolean zip2(Map<String,Path> files,
                           OutputStream out)
                    throws Exception
```
    Throws:
    
    Exception
  - unzip2
```
public static int unzip2(String basedir,
                         InputStream in)
                  throws IOException
```
    Throws:
    
    IOException
  - zip
```
public static final boolean zip(Map map,
                                String file)
                         throws Exception
```
    Takes for each entry in the map makes a zip entry, and then creates the zip in a location specified by sOutputFile.
    
    Parameters:
    
    map - Entries to zip up in the form String, blob
    
    file - The full path to target zip file.
    
    Returns:
    
    Returns true on success.
    
    Throws:
    
    Exception - on error
  - zipDirectory
```
public static final boolean zipDirectory(String zipfile,
                                         String dirname,
                                         boolean recursive,
                                         String files)
                                  throws Exception
```
    Takes for each entry in the map makes a zip entry, and then creates the zip in a location specified by sOutputFile.
    
    Parameters:
    
    zipfile - Target file
    
    dirname - Directory to zip
    
    recursive - Whether to recurse into subdirectories
    
    files - File selector such as (*.*, *.class, etc)
    
    Returns:
    
    Returns true on success.
    
    Throws:
    
    IOException - on error
    
    Exception
  - validateZip
```
public static final boolean validateZip(String zip)
```
    Validates a zip file's zip integrity.
    
    Parameters:
    
    zip - The path/name of the file to unzip.
    
    Returns:
    
    Returns boolean if zip is good.
  - writeFile
```
public static final boolean writeFile(String fname,
                                      byte[] bytes,
                                      int len)
```
    Writes a file to disk, given an OS specific path and the contents of the file. The contents are a byte array.
    
    Parameters:
    
    fname - The path and name of the file.
    
    bytes - The byte array to write to the file.
    
    len - The number of bytes to write.
    
    Returns:
    
    Returns true on success, false on failure.
  - writeFile2
```
public static final boolean writeFile2(String fname,
                                       byte[] bytes,
                                       int len)
```
  - isFolder
```
public static final int isFolder(String p)
```
    Verify a folder
    
    Parameters:
    
    p - folder path
    
    Returns:
    
    int 0 or error
  - isFile
```
public static final int isFile(String p)
```
    Verify a file
    
    Parameters:
    
    p - file name
    
    Returns:
    
    int 0 or error
  - deleteFile
```
public static final boolean deleteFile(String fname)
```
    Deletes a file from disk.
    
    Parameters:
    
    fname - The path and file name of the file to delete.
    
    Returns:
    
    Returns true on success, false on failure.
  - emptyFolder
```
public static final int emptyFolder(String path,
                                    boolean bDelete)
```
    Delete a folder (optional) and all the contents within, recursively.
    
    Parameters:
    
    path - name
    
    bDelete - boolean - delete folder too
    
    Returns:
    
    0 if success, else error code
  - ensureFolder
```
public static final boolean ensureFolder(String path)
```
    Make sure a path exists, creating subfolders as needed
    
    Parameters:
    
    path - name
    
    Returns:
    
    if folder exists
  - ensureFolder
```
public static final boolean ensureFolder(Path path)
```
    Make sure a path exists, creating sub-folders as needed.
    
    Parameters:
    
    path -
    
    Returns:
    
    if folder exists
  - emptyfolder
```
public static final int emptyfolder(String path,
                                    String pattern)
```
    Delete all the files which match the pattern from the specified directory tree, recursively.
    
    Parameters:
    
    path - name
    
    pattern - file wildcard pattern to match
    
    Returns:
    
    0 if success, else error code
  - appendFile
```
public static final boolean appendFile(String fname,
                                       String str)
```
    Appends to a file to disk.
    
    Parameters:
    
    fname - The path and file name of the file to delete.
    
    str - The file data to append, in string form.
    
    Returns:
    
    Returns true on success, false on failure.
  - appendFile
```
public static final boolean appendFile(String fname,
                                       byte[] bytes,
                                       int size)
```
    Appends to a file to disk.
    
    Parameters:
    
    fname - The path and file name of the file to delete.
    
    bytes - The file data to append, in a byte array.
    
    size - The number of bits to append.
    
    Returns:
    
    Returns true on success, false on failure.
  - deBabble
```
public static final String deBabble(String s)
```
    Replaces %20,%22,%19,%3c,%3e,%26 in input string with the characters they represent.
    
    Parameters:
    
    s - string to convert
    
    Returns:
    
    Returns the new, converted string, or the same string if no conversion was done.
  - replaceAll
```
public static final String replaceAll(String source,
                                      String what,
                                      String with)
```
    Replaces a strings contents (all occurrences) with specified values.
    
    Parameters:
    
    source - The source string. NULL or empty returns same
    
    what - What to replace. NULL or empty returns source.
    
    with - The replacement values (may be null to erase).
    
    Returns:
    
    Returns the new string.
  - genID
```
public static final String genID(ICS icsThread)
```
    Deprecated. use ICS.genID(boolean) instead
    
    Generate a unique number based on the current time.
    
    Parameters:
    
    icsThread - An interface object used to synchronize this number across VM's and/or the cluster.
    
    Returns:
    
    Returns the string containing the number, or null on error.
    
    See Also:
    
    Utilities.genID(), ICS.genID(boolean)
  - genID
```
public static final String genID()
```
    Deprecated. use ICS.genID(boolean) instead
    
    Generates a unique number based on the current time. Not safe outside the VM.
    
    Returns:
    
    Returns the string containing the number, or null on error.
    
    See Also:
    
    Utilities.genID(ICS), ICS.genID(boolean)
  - words
```
public static final Vector words(String str,
                                 int sep)
```
    Parses a string into a vector of words.
    
    Parameters:
    
    str - String of words to parse.
    
    sep - The separator character.
    
    Returns:
    
    Returns a vector of words, may be empty.
  - sortWords
```
public static final Vector sortWords(Vector words)
```
    Sort a list of strings, longest to shortest
    
    Parameters:
    
    words - Vector of strings
    
    Returns:
    
    new vector of strings, original untouched
  - sortWordsAlpha
```
public static final Vector sortWordsAlpha(Vector words)
```
    Sort a list of strings alphanumerically
    
    Parameters:
    
    words - Vector of strings
    
    Returns:
    
    new vector of strings, original untouched
  - words
```
public static final Vector words(String cmd,
                                 String sep)
```
    Parses a string into a vector of words.
    
    Parameters:
    
    cmd - String of words to parse.
    
    sep - String of separating characters.
    
    Returns:
    
    Returns a vector of words, may be empty.
  - goodString
```
public static final boolean goodString(String s)
```
    Return if a string is empty or null
    
    Parameters:
    
    s - input string
    
    Returns:
    
    boolean true if not null, length greater than 0
  - goodString
```
public static final boolean goodString(char[] s)
```
  - stringFromList
```
public static final String stringFromList(List list)
```
    Method to convert a collection into a comma separated list
    
    Parameters:
    
    list - a list
    
    Returns:
    
    a string from list
  - getParams
```
public static FTValList getParams(String in)
```
    Build a vallist of parameters given input in the form of a=b and c=d
    
    Parameters:
    
    in - The input string containing the parameters.
    
    Returns:
    
    Returns an FTValList of parameters.
  - getParams
```
public static void getParams(String sInput,
                             Map map,
                             boolean bDecode)
```
    Build a map of parameters given input in the form of a=b and c=d
    
    Parameters:
    
    sInput - The input string containing the parameters.
    
    map - The output map of key/value pairs
    
    bDecode - true to indicate that decoding is desired
    
    Since:
    
    4.0
  - jdbcDateFromCal
```
public static final String jdbcDateFromCal(Calendar c)
```
    Returns a JDBC formatted date from a calendar object.
    
    Parameters:
    
    c - Calendar with date.
    
    Returns:
    
    Returns the JDBC formatted date string .
    
    See Also:
    
    Util
  - jdbcTimeFrom
```
public static final String jdbcTimeFrom(Calendar cal)
```
    Returns a JDBC formatted time from a calendar object.
    
    Parameters:
    
    cal - Calendar with date.
    
    Returns:
    
    Returns the JDBC formatted time string.
    
    See Also:
    
    Util
  - sqlDate
```
public static final String sqlDate(Calendar cal)
```
    Returns a string formatted as JDBC date/time from a calendar object.
    
    Parameters:
    
    cal - Calendar with date and time.
    
    Returns:
    
    Returns the date and time in form YYYY-MM-DD HH24:MI:SS
    
    See Also:
    
    Util
  - calendarFromJDBCString
```
public static Calendar calendarFromJDBCString(String s)
```
    Returns a calendar object from JDBC date/time.
    
    Parameters:
    
    s - String in the form of YYYY-MM-DD HH24:MI:SS
    
    Returns:
    
    Returns the appropriate Calendar object.
    
    See Also:
    
    Util
  - itemIsInList
```
public static final boolean itemIsInList(Vector l,
                                         String s,
                                         boolean c)
```
    Determines if a given string is in a vector.
    
    Parameters:
    
    l - The Vector list of strings.
    
    s - The String item to find.
    
    c - boolean True for caseless check, false otherwise.
    
    Returns:
    
    Returns true if the string is in the vector, false if it is not.
  - directoryList
```
public static Vector directoryList(String path,
                                   String filter,
                                   boolean recurse,
                                   int maxcount)
```
    Returns a vector of filenames given a path and a filter.
    
    Parameters:
    
    path - OS specific path.
    
    filter - File filter, as in *.bat, *.*. Not all OS specific filter characters are supported.
    
    recurse - A "true" value specifies to look for matching files (based on filter) in subdirectories of the supplied path.
    
    maxcount - Specifies the maximum number of files that will be returned in the vector. Note that it is possible to generate outofmemory exceptions by specifying a very large number.
    
    Returns:
    
    Returns the vector of filenames in the path that meet the filter.
  - directoryList
```
public static Vector directoryList(String path,
                                   String filter,
                                   boolean recurse,
                                   int maxcount,
                                   COM.FutureTense.Interfaces.IDirectoryObserver ido)
```
    Returns a vector of filenames given a path and a filter.
    
    Parameters:
    
    path - OS specific path.
    
    filter - File filter, as in *.bat, *.*. Not all OS specific filter characters are supported.
    
    recurse - A "true" value specifies to look for matching files (based on filter) in subdirectories of the supplied path.
    
    maxcount - Specifies the maximum number of files that will be returned in the vector. Note that it is possible to generate outofmemory exceptions by specifying a very large number.
    
    ido - an IDirectoryObserver
    
    Returns:
    
    Returns the vector of filenames in the path that meet the filter.
    
    Since:
    
    4.0
  - sendMail
```
public static final boolean sendMail(String from,
                                     String to,
                                     String sub,
                                     String replyto,
                                     String messagestr,
                                     String server,
                                     StringBuffer err)
```
    Sends an SMTP mail message.
    
    Parameters:
    
    from - The FROM field.
    
    to - One or more email addresses, comma seperated.
    
    sub - The SUBJECT field.
    
    replyto - The REPLY TO field.
    
    messagestr - The message BODY.
    
    server - The name of the mail server.
    
    err - Error string, set on failure.
    
    Returns:
    
    Returns true on success, false on failure.
  - sendMail
```
public static final boolean sendMail(String from,
                                     String to,
                                     String sub,
                                     String replyto,
                                     String messagestr,
                                     String server,
                                     String contenttype,
                                     StringBuffer err)
```
    Deprecated. use sendMail which includes charset instead
    
    Sends an SMTP mail message.
    
    Parameters:
    
    from - The FROM field.
    
    to - One or more email addresses, comma seperated.
    
    sub - The SUBJECT field.
    
    replyto - The REPLY TO field.
    
    messagestr - The message BODY.
    
    server - The name of the mail server.
    
    contenttype - The content-type of the message body
    
    err - Error string, set on failure.
    
    Returns:
    
    Returns true on success, false on failure.
  - sendMail
```
public static final boolean sendMail(String from,
                                     String to,
                                     String sub,
                                     String replyto,
                                     String messagestr,
                                     String server,
                                     String contenttype,
                                     String charset,
                                     StringBuffer err)
```
    Sends an SMTP mail message.
    
    Parameters:
    
    from - The FROM field.
    
    to - One or more email addresses, comma seperated.
    
    sub - The SUBJECT field.
    
    replyto - The REPLY TO field.
    
    messagestr - The message BODY.
    
    server - The name of the mail server.
    
    contenttype - The content-type of the message body
    
    charset - The character set of the message subject
    
    err - Error string, set on failure.
    
    Returns:
    
    Returns true on success, false on failure.
  - sendMail
```
public static final boolean sendMail(String from,
                                     String[] to,
                                     String sub,
                                     String replyto,
                                     String messagestr,
                                     String server,
                                     StringBuffer err)
```
    Sends an SMTP mail
    
    Parameters:
    
    from - The FROM field.
    
    to - An array of email addresses.
    
    sub - The SUBJECT field.
    
    replyto - The REPLY TO field.
    
    messagestr - The message BODY.
    
    server - The name of the mail server.
    
    err - Error string, set on failure.
    
    Returns:
    
    Returns true on success, false on failure.
  - sendMail
```
public static final boolean sendMail(String from,
                                     String[] to,
                                     String sub,
                                     String replyto,
                                     String messagestr,
                                     String server,
                                     String contenttype,
                                     StringBuffer err)
```
    Deprecated. use sendMail which includes charset instead
    
    Sends an SMTP mail
    
    Parameters:
    
    from - The FROM field.
    
    to - An array of email addresses.
    
    sub - The SUBJECT field.
    
    replyto - The REPLY TO field.
    
    messagestr - The message BODY.
    
    server - The name of the mail server.
    
    contenttype - The content-type of the message body
    
    err - Error string, set on failure.
    
    Returns:
    
    Returns true on success, false on failure.
  - sendMail
```
public static final boolean sendMail(String from,
                                     String[] to,
                                     String sub,
                                     String replyto,
                                     String messagestr,
                                     String server,
                                     String contenttype,
                                     String charset,
                                     StringBuffer err)
```
    Sends an SMTP mail
    
    Parameters:
    
    from - The FROM field.
    
    to - An array of email addresses.
    
    sub - The SUBJECT field.
    
    replyto - The REPLY TO field.
    
    messagestr - The message BODY.
    
    server - The name of the mail server.
    
    contenttype - The content-type of the message body
    
    charset - The character set of the message subject
    
    err - Error string, set on failure.
    
    Returns:
    
    Returns true on success, false on failure.
  - getPOP3Messages
```
public static Vector getPOP3Messages(String host,
                                     String user,
                                     String password,
                                     boolean bRemove)
```
    Deprecated. fetchPOP3Messages
    
    Retrieves a vector of messages from a POP3 server; default connection timeout is 190 seconds.
    
    Parameters:
    
    host - Host server.
    
    user - User account.
    
    password - User password.
    
    bRemove - Set to "true" to remove the messages from the server after get.
    
    Returns:
    
    Returns a vector of message bodies or null. The vector contains a hashtable of header fields and body (as Utilities.msgbody, etc) where the header field text is downcased.
  - fetchPOP3Messages
```
public static Vector fetchPOP3Messages(String host,
                                       String user,
                                       char[] password,
                                       boolean bRemove)
```
    Retrieves a vector of messages from a POP3 server; default connection timeout is 190 seconds.
    
    Parameters:
    
    host - Host server.
    
    user - User account.
    
    password - User password.
    
    bRemove - Set to "true" to remove the messages from the server after get.
    
    Returns:
    
    Returns a vector of message bodies or null. The vector contains a hashtable of header fields and body (as Utilities.msgbody, etc) where the header field text in downcase.
  - getPOP3Messages
```
public static Vector getPOP3Messages(String host,
                                     String user,
                                     String password,
                                     boolean bRemove,
                                     int ctimeout)
```
    Deprecated. use fetchPOP3Messages
    
    Retrieves a vector of messages from a POP3 server; specify the connection timeout on checking for new mail.
    
    Parameters:
    
    host - Host server.
    
    user - User account.
    
    password - User password.
    
    bRemove - Set to "true" to remove the messages from the server after get.
    
    ctimeout - timeout (seconds) to fail during first connect
    
    Returns:
    
    Returns a vector of message bodies or null. The vector contains a hashtable of header fields and body (as Utilities.msgbody, etc) where the header field text is downcased.
  - fetchPOP3Messages
```
public static Vector fetchPOP3Messages(String host,
                                       String user,
                                       char[] password,
                                       boolean bRemove,
                                       int ctimeout)
```
    Retrieves a vector of messages from a POP3 server; specify the connection timeout on checking for new mail.
    
    Parameters:
    
    host - Host server.
    
    user - User account.
    
    password - User password.
    
    bRemove - Set to "true" to remove the messages from the server after get.
    
    ctimeout - timeout (seconds) to fail during first connect
    
    Returns:
    
    Returns a vector of message bodies or null. The vector contains a hashtable of header fields and body (as Utilities.msgbody, etc) where the header field text is downcased.
  - cryptoEnabled
```
public static final boolean cryptoEnabled()
```
    Checks if encryption is enabled.
    
    Returns:
    
    Returns true if encryption is enabled, false otherwise.
  - encryptPlatformString
```
public static final String encryptPlatformString(String s)
```
    Encrypts a string with the default key.
    
    Parameters:
    
    s - The string to encrypt. String is converted to bytes using default platform encoding before encrypting it.
    
    Returns:
    
    Returns the encrypted string.
  - encryptPlatformString
```
public static final String encryptPlatformString(String s,
                                                 byte[] key)
```
    Encrypts a string with the supplied key.
    
    Parameters:
    
    s - The string to encrypt. String is converted to bytes using default platform encoding before encrypting it.
    
    key - a key supplied for encrypting a string
    
    Returns:
    
    Returns the encrypted string.
  - encryptString
```
public static final String encryptString(String s)
```
    Encrypts a string with the default key.
    
    Parameters:
    
    s - The string to encrypt. This method limits the input string to ascii characters. If non-ascii characters are used in the input, the decrypt() utility will not return original value.
    
    Returns:
    
    Returns the encrypted string.
  - encryptString
```
public static final String encryptString(String s,
                                         byte[] key)
```
    Encrypts a string with the supplied key.
    
    Parameters:
    
    s - The string to encrypt. This method limits the input string to ascii characters. If non-ascii characters are used in the input, the decrypt() utility will not return original value.
    
    key - a key supplied for encrypting a string
    
    Returns:
    
    Returns the encrypted string.
  - decryptString
```
public static String decryptString(String s)
```
    Decrypts a string with the default key.
    
    Parameters:
    
    s - The string to decrypt.
    
    Returns:
    
    Returns the decrypted string.
  - decryptString
```
public static String decryptString(String s,
                                   byte[] key)
```
    Decrypts a string with the supplied key.
    
    Parameters:
    
    key - a key supplied for encrypting a string
    
    s - The string to decrypt.
    
    Returns:
    
    Returns the decrypted string.
  - lockFile
```
public static boolean lockFile(String file)
```
    Lock a file name for exclusive use by this thread. No other threads can create a file with this name if it has been locked using this mechanism (and the other threads bother to check). Don't forget to release the lock otherwise it is held until the vm shuts down.
    
    Parameters:
    
    file - filename to lock
    
    Returns:
    
    success or failure
  - unlockFile
```
public static boolean unlockFile(String file)
```
    Unlock a file name from exclusive use by this thread
    
    Parameters:
    
    file - filename to unlock
    
    Returns:
    
    success or failure
  - osIgnoreFileCase
```
public static boolean osIgnoreFileCase()
```
    Return if the server OS has case specific versus case preserve file system naming.
    
    Returns:
    
    true if case does not matter or false if it can not be determined that it does not matter.
  - stringFromValList
```
public static String stringFromValList(Map map)
```
    Create a url-like set of name/values from a map ie x=y and a=b and c=d
    
    Parameters:
    
    map - Map to compress to string
    
    Returns:
    
    String but needs encoding to be url safe. Note empty strings are not preserved.
    
    See Also:
    
    Utilities.stringFromValList(Map, boolean)
  - stringFromValList
```
public static String stringFromValList(Map map,
                                       boolean bEncode)
```
    Create a url-like set of name/values from a map ie x=y and a=b and c=d
    
    Parameters:
    
    map - Map to compress to string
    
    bEncode - true to encode keys and values
    
    Returns:
    
    String output. Note empty strings are not preserved.
    
    Since:
    
    4.0
    
    See Also:
    
    Utilities.stringFromValList(Map)
  - keysFromMap
```
public static String keysFromMap(Map map)
```
    Return a string of keys from the Map
    
    Parameters:
    
    map - input Map
    
    Returns:
    
    string in form "key1,key2,key3"
    
    Since:
    
    4.0
  - fileLockLoadOK
```
public static boolean fileLockLoadOK()
```
    Check to see if the file lock native library loaded successfully.
    
    Returns:
    
    boolean true on success
    
    Since:
    
    4.0
  - getBLOBDir
```
public static String getBLOBDir(String seed)
```
    Generate hash-based directory based on given seed. This can be used to spread out files across multiple directories and avoid stressing the filesystem.
    
    Parameters:
    
    seed - Value based on which the folder structure will be generated. It is suggested to use the filename as seed, but not necessary.
    
    Returns:
    
    Relative directory path.
  - getNameNoTrailingNumber
```
public static String getNameNoTrailingNumber(String name)
```
    Returns normalized name after removing the trailing comma number from name.
    
    Parameters:
    
    name - a name
    
    Returns:
    
    'normalized' name
  - generateUUID
```
public static String generateUUID()
```
    Returns:
    
    Returns a randomly-generated UUID.
  - isAllowedHeader
```
public static final boolean isAllowedHeader(String headerStr)
```
    The method is used to check whether the passed header is valid or not.
    
    Parameters:
    
    headerStr - header string
    
    Returns:
    
    boolean return true if the header name or value is valid.
  - tempFolder
```
public static final String tempFolder()
```
  - handleOSCharacters
```
public static String handleOSCharacters(String input)
```
    Handles characters reserved by supported OS. Replaces each such character with .
    
    Parameters:
    
    input - string on which the manipulation is to be performed.
    
    Returns:
    
    string where the OS reserved characters have been handled.
  - getCaseInSensitiveStringComparator
```
public static final Comparator<String> getCaseInSensitiveStringComparator()
```
    Returns a comparator for string objects, which compares strings in case insensitive way.
    
    Returns:
    
    the singleton CaseInsensitiveStringComparator object
  - isValidEmail
```
public static final boolean isValidEmail(String email)
```
    Check if the email is a valid email, this enforces the same check that is enforced by the UI pages.
    
    Parameters:
    
    email - the email address
    
    Returns:
    
    true if valid, false otherwise
  - isText
```
public static final boolean isText(String sContentType)
```
    Method to determine whether sContentType is a text mime-type Note: the standard is evolving Reference: 1. http://en.wikipedia.org/wiki/Internet_media_type
    
    Parameters:
    
    sContentType - content type
    
    Returns:
    
    true when sContentType is a text mime-type
  - equals
```
public static final boolean equals(String createddate,
                                   String updateddate)
```
    Sometimes java get this from database 2014-05-01 10:39:17.333 2014-05-01 10:39:17.332 but they are exactly the same in database
    
    Parameters:
    
    createddate - a date from database
    
    updateddate - a date from database
    
    Returns:
    
    a boolean
  - availableDisk
```
public static long availableDisk(String pathDir)
                          throws IOException
```
    Throws:
    
    IOException
  - getCharArray
```
public static char[] getCharArray(String value)
```
    Converts String to char[]
    
    Parameters:
    
    value -
    
    Returns:
    
    char[]

Class Utilities

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

product

msgbody

Constructor Detail

Utilities

Method Detail

getWebRoot

osSafeSpec

pathFromSpec

fileFromSpec

createTempFile

readFile

readFile

readFile

readByteFile

fileExists

readFile

readURL

readByteURL

readURL

readByteURL

fileName

writeFile

unzipFile

zip2

unzip2

zip

zipDirectory

validateZip

writeFile

writeFile2

isFolder

isFile

deleteFile

emptyFolder

ensureFolder

ensureFolder

emptyfolder

appendFile

appendFile

deBabble

replaceAll

genID

genID

words

sortWords

sortWordsAlpha

words

goodString

goodString

stringFromList

getParams

getParams

jdbcDateFromCal

jdbcTimeFrom

sqlDate

calendarFromJDBCString

itemIsInList

directoryList

directoryList

sendMail

sendMail

sendMail

sendMail

sendMail

sendMail

getPOP3Messages

fetchPOP3Messages

getPOP3Messages

fetchPOP3Messages

cryptoEnabled

encryptPlatformString

encryptPlatformString

encryptString

encryptString