Field Detail

• UTF8

  public static final String UTF8

  Deprecated. 
  The UTF-8 Character encoding which is recommended for most message handling.

  See Also:

  Constant Field Values

Method Detail

• bootstrap

  public static void bootstrap(ClassLoader cl,
                               com.pushtechnology.diffusion.manifest.ProductManifest manifest)

  Deprecated. 

• getResourceAsStream

  public static InputStream getResourceAsStream(String resourceName)
                                         throws APIException

  Deprecated. 
  Open for reading, a resource of the specified name from the search path used to load classes.

  Parameters:

  resourceName - for example a file name.

  Returns:

  an input stream for the resource.

  Throws:

  APIException - if the resource could not be found.

• loadProperties

  public static PropertyHandler loadProperties(String resourceName)
                                        throws APIException

  Deprecated. 
  Load properties from a resource of the specified name from the search path used to load classes.

  Parameters:

  resourceName - the resource name.

  Returns:

  loaded properties.

  Throws:

  APIException - if unable to load properties.

• getFile

  public static File getFile(String fileName)
                      throws APIException

  Deprecated. 
  Gets a File object corresponding to a file that is loadable from the system classpath.

  This could be used, for example, to obtain a handle for a file in the data directory.

  Parameters:

  fileName - the file name (e.g. "myFile.txt")

  Returns:

  a File object that represents an existing named file.

  Throws:

  APIException - if no file with the specified name could be found on the system classpath.

• createResourceReader

  public static LineNumberReader createResourceReader(String resourceName)
                                               throws APIException

  Deprecated. 
  Creates a reader for a named resource using UTF-8.

  Parameters:

  resourceName - the resource name which should be the path of a resource that can be loaded from the classpath, for example a file from the data directory.

  Returns:

  a buffered reader for the named resource.

  Throws:

  APIException - if the resource could not be found.

• createResourceReader

  public static LineNumberReader createResourceReader(String resourceName,
                                                      String charset)
                                               throws APIException

  Deprecated. 
  Creates a reader for a named resource.

  Parameters:

  resourceName - the resource name which should be the path of a resource that can be loaded from the classpath, for example a file from the data directory.

  charset - the character set to use for converting bytes read from the file into characters.

  Returns:

  a buffered reader for the named resource.

  Throws:

  APIException - if the resource could not be found.

• createFileReader

  public static LineNumberReader createFileReader(File file)
                                           throws APIException

  Deprecated. 
  Creates a reader for a given file.

  Parameters:

  file - the file to read.

  Returns:

  a reader which will perform character conversion using UTF-8.

  Throws:

  APIException - if unable to create a reader for the file.

• createFileReader

  public static LineNumberReader createFileReader(File file,
                                                  String charset)
                                           throws APIException

  Deprecated. 
  Creates a reader for a given file.

  Parameters:

  file - the file to read.

  charset - the character set to use for converting bytes read from the file into characters.

  Returns:

  a reader.

  Throws:

  APIException - if unable to create a reader for the given file.

• createFileReader

  public static LineNumberReader createFileReader(FileInputStream fileInputStream)
                                           throws APIException

  Deprecated. 
  Creates a reader for a given file input stream.

  Parameters:

  fileInputStream - the file input stream to read.

  Returns:

  a reader which will perform character conversion using the UTF-8.

  Throws:

  APIException - if unable to create a reader for the file input stream.

• createFileReader

  public static LineNumberReader createFileReader(FileInputStream fileInputStream,
                                                  String charset)
                                           throws APIException

  Deprecated. 
  Creates a reader for a given file input stream.

  Parameters:

  fileInputStream - the file input stream to read.

  charset - the character set to use for converting bytes read from the file into characters.

  Returns:

  a reader.

  Throws:

  APIException - if unable to create a reader for the given file.

• readFileAsString

  public static String readFileAsString(File file)
                                 throws APIException

  Deprecated. 
  Reads the entire contents of a file into a String using UTF-8 conversion.

  This will only cater for files of up to 8Kb in size.

  Parameters:

  file - the file to read.

  Returns:

  a string containing the entire file content.

  Throws:

  APIException - if unable to read the file.

• readFileAsString

  public static String readFileAsString(File file,
                                        String charset)
                                 throws APIException

  Deprecated. 
  Reads the entire contents of a file into a String.

  This will only cater for files of up to 8Kb in size.

  Parameters:

  file - the file to read.

  charset - the character set to use for byte to character conversion.

  Returns:

  a string containing the entire file content.

  Throws:

  APIException - if unable to read the file.

• createFileWriter

  public static BufferedWriter createFileWriter(File file)
                                         throws APIException

  Deprecated. 
  Creates a buffered writer for a given file.

  Parameters:

  file - the file to write to.

  Returns:

  a writer which will perform character conversion using UTF-8.

  Throws:

  APIException - if unable to create a writer for the file.

• createFileWriter

  public static BufferedWriter createFileWriter(File file,
                                                String charset)
                                         throws APIException

  Deprecated. 
  Creates a writer for a given file.

  Parameters:

  file - the file to write to.

  charset - the character set to use for converting characters to bytes written to the file.

  Returns:

  a writer.

  Throws:

  APIException - if unable to create a writer for the given file.

• createFileWriter

  public static BufferedWriter createFileWriter(FileOutputStream fileOutputStream)
                                         throws APIException

  Deprecated. 
  Creates a writer for a given file output stream.

  Parameters:

  fileOutputStream - the file output stream.

  Returns:

  a writer which will perform character conversion using UTF-8.

  Throws:

  APIException - if unable to create a writer for the given file.

• createFileWriter

  public static BufferedWriter createFileWriter(FileOutputStream fileOutputStream,
                                                String charset)
                                         throws APIException

  Deprecated. 
  Creates a writer for a given file output stream.

  Parameters:

  fileOutputStream - the file output stream.

  charset - the character set to use for converting characters to bytes written.

  Returns:

  a buffered writer.

  Throws:

  APIException - if unable to create a writer for the given file.

• convertInputStreamToString

  public static String convertInputStreamToString(InputStream is)
                                           throws APIException

  Deprecated. 
  Returns the input stream as a string, read as UTF-8.

  Parameters:

  is - the input stream

  Returns:

  a string representation of the contents

  Throws:

  APIException - if unable to read stream

• convertInputStreamToString

  public static String convertInputStreamToString(InputStream is,
                                                  String charSet)
                                           throws APIException

  Deprecated. 
  Returns the input stream as a string, using the specified charset.

  Parameters:

  is - the input stream

  charSet - the character set

  Returns:

  a string representation of the contents

  Throws:

  APIException - if unable to read stream

• formatDate

  public static String formatDate(Date date)

  Deprecated. 
  Formats a date.

  The supplied date is formatted using the date formatting pattern specified in Server.xml.

  Parameters:

  date - the date to format

  Returns:

  a formatted date string.

• formatDate

  public static String formatDate(long millis)

  Deprecated. 
  Formats a milliseconds date.

  The supplied date is formatted using the date formatting pattern specified in Server.xml.

  Parameters:

  millis - a date represented as the number of milliseconds, between a point in time and midnight, January 1, 1970 UTC.

  Returns:

  a formatted date string.

• formatTime

  public static String formatTime(Date date)

  Deprecated. 
  Formats a time value.

  The time part of the supplied date is formatted using the time formatting pattern specified in Server.xml.

  Parameters:

  date - a date object for which the time part is to be formatted.

  Returns:

  a formatted time string.

• formatTime

  public static String formatTime(long millis)

  Deprecated. 
  Formats the time from a milliseconds date value.

  The time part of the supplied date is formatted using the time formatting pattern specified in Server.xml.

  Parameters:

  millis - a time represented as the number of milliseconds, between a point in time and midnight, January 1, 1970 UTC.

  Returns:

  a formatted time string.

• formatDateTime

  public static String formatDateTime(Date date)

  Deprecated. 
  Formats a date and time.

  The supplied date is formatted using the dateTime formatting pattern specified in Server.xml.

  Parameters:

  date - the date to format

  Returns:

  a formatted date and time string.

• formatDateTime

  public static String formatDateTime(long millis)

  Deprecated. 
  Formats a milliseconds date and time.

  The supplied date is formatted using the dateTime formatting pattern specified in Server.xml.

  Parameters:

  millis - a time represented as the number of milliseconds, between a point in time and midnight, January 1, 1970 UTC.

  Returns:

  a formatted date and time string.

• formatTimeStamp

  public static String formatTimeStamp(Date date)

  Deprecated. 
  Formats a time stamp.

  The supplied date is formatted using the timeStamp formatting pattern specified in Server.xml.

  Parameters:

  date - the date to format

  Returns:

  a formatted time stamp string.

• formatTimeStamp

  public static String formatTimeStamp(long millis)

  Deprecated. 
  Formats a milliseconds value into a timestamp.

  The supplied value is formatted using the timeStamp formatting pattern specified in Server.xml.

  Parameters:

  millis - a time represented as the number of milliseconds, between a point in time and midnight, January 1, 1970 UTC.

  Returns:

  a formatted time stamp string.

• formatElapsedTime

  public static String formatElapsedTime(long millis)

  Deprecated. 
  Formats an elapsed time in milliseconds into a display format string.

  For example "3 hour(s) 4 minute(s) 23 second(s)"

  Parameters:

  millis - elapsed time in milliseconds.

  Returns:

  a formatted elapsed time.

• formatNumber

  public static String formatNumber(Number number)

  Deprecated. 
  Formats a number using default decimal formatting.

  Parameters:

  number - the number.

  Returns:

  a formatted string.

• bytesToHex

  public static String bytesToHex(byte[] byteArray,
                                  int offset,
                                  int length)

  Deprecated. 
  Converts all or part of a byte array to hexadecimal representation for diagnostic purposes.

  Parameters:

  byteArray - the byte array.

  offset - the offset within the byte array from which to start converting to hex.

  length - the number of bytes, starting from the offset to convert.

  Returns:

  a string containing the hex representation of the bytes, each byte as 2 hex digits separated by spaces.

• bytesToHex

  public static String bytesToHex(byte[] byteArray)

  Deprecated. 
  Converts all or part of a byte array to hexadecimal representation for diagnostic purposes.

  Parameters:

  byteArray - the byte array.

  Returns:

  a string containing the hex representation of the bytes, each byte as 2 hex digits separated by spaces.

• byteBufferToHex

  public static String byteBufferToHex(ByteBuffer buffer)

  Deprecated. 
  Converts the contents of a ByteBuffer to a Hexadecimal String for diagnostic purposes.

  The content of the buffer between the start and the current limit will be converted.

  Parameters:

  buffer - the buffer.

  Returns:

  String representation of the bytes in hex.

• byteBufferToHex

  public static String byteBufferToHex(ByteBuffer buffer,
                                       int length)

  Deprecated. 
  Converts part of a ByteBuffer to a Hexadecimal String representation for diagnostic purposes.

  The content of the buffer between the start and the specified length (or limit if shorter) will be converted.

  Parameters:

  buffer - the buffer.

  length - the maximum number of bytes to convert.

  Returns:

  String representation of the bytes in hex.

• byteBufferToAscii

  public static String byteBufferToAscii(ByteBuffer buffer)

  Deprecated. 
  Converts the ByteBuffer in the default Character set for diagnostic purposes from the current buffer position.

  Parameters:

  buffer - the buffer

  Returns:

  String representation of the buffer

• byteBufferToAscii

  public static String byteBufferToAscii(ByteBuffer buffer,
                                         int limit)

  Deprecated. 
  Converts the ByteBuffer in the default Character set for diagnostic purposes from the current buffer position, up to a limit.

  Parameters:

  buffer - the buffer

  limit - of bytes to dump

  Returns:

  String representation of the buffer

• getDefaultCharsetDecoder

  public static CharsetDecoder getDefaultCharsetDecoder()

  Deprecated. 
  Get a Charset decoder based off the default charset.

  Returns:

  A Thread safe charset decoder

• millisNumberConverter

  public static long millisNumberConverter(String time)
                                    throws APIException

  Deprecated. 
  Append the letter h or H to indicate hours, or m or M to indicate minutes or s or S to indicate seconds.

  Parameters:

  time - string representation of time

  Returns:

  the number of milliseconds

  Throws:

  APIException - if unable to convert

• byteNumberConverter

  public static int byteNumberConverter(String number)
                                 throws APIException

  Deprecated. 
  Converts a size into bytes. Append the letter k or K to indicate kilobytes, or m or M to indicate megabytes. Examples: 6291456 6144k 6m

  Parameters:

  number - the string representing the number of bytes

  Returns:

  the number representation in bytes

  Throws:

  APIException - if unable to convert string to number

• base64Encode

  public static String base64Encode(String toEncode)

  Deprecated. 
  Encodes a String in Base64 notation.

  Parameters:

  toEncode - the string to encode

  Returns:

  a Base64 encoded string

• base64Decode

  public static String base64Decode(String toDecode)

  Deprecated. 
  Decodes a Base 64 encoded string.

  Parameters:

  toDecode - the string to decode

  Returns:

  a decoding String

• join

  public static String join(List<? extends CharSequence> list,
                            String delimiter)

  Deprecated. 
  Joins all of a list into a string, and returns the string. The elements will be separated by a specified separator.

  Parameters:

  list - of Strings to join

  delimiter - to delimit the list of Strings

  Returns:

  a delimited list

• join

  public static String join(String[] strings,
                            String delimiter)

  Deprecated. 
  Joins an array of Strings to make a single string.

  Parameters:

  strings - the strings

  delimiter - a delimiter to separate the strings so that the resulting string can be split again. If null is supplied then there will be no delimiter and the strings will simply be concatenated.

  Returns:

  the joined strings

  Since:

  4.5

• padString

  public static String padString(String string,
                                 int length)

  Deprecated. 
  Pads a string with spaces to the right up to a specified length.

  If the string is already equal to or longer than the specified length then it is left at the same length.

  Parameters:

  string - the string

  length - the desired length to pad to

  Returns:

  the new string

• getProductVersion

  public static String getProductVersion()

  Deprecated. 
  Returns the Diffusion Product Version.

  Returns:

  a string representation of the Diffusion Product version.

  Since:

  5.0