Utilities (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.common.Utilities

```
public class Utilities
extends Object
```
This is a utility class containing static helper functions.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ISO_CODE_PAGE` The string used for the ISO 8859-1 codepage: "8859_1".
`static char[]`	`HEXES_CA` The hex characters as a character array.
`static String`	`HEXES_S` The hex characters as a String.
`static boolean`	`isVerbose` Flag for verbose output.
`static String`	`LINE_SEPARATOR` The Line separator ("\r\n" for Windows, "\n" for Unix).
`static String`	`PROGRAM_DOMAIN`
`static String`	`PROGRAM_NAME`
`static String`	`PROGRAM_NAME_CLIENT`
`static String`	`PROGRAM_NAME_EDITOR`
`static String`	`PROGRAM_NAME_SERVER`
`static String`	`PROGRAM_NAME_UPPER`

Constructor Summary

Constructors
Constructor and Description

Utilities()

Constructors
Constructor and Description
`Utilities()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static URLClassLoader`	`createClassLoader(String spec, boolean doVerifyJarZip, ClassLoader parent)` Creates a class loader from a specification of JAR/ZIP files or directories in a string that is either comma or colon separated.
`static URLClassLoader`	`createClassLoader(String spec, boolean doVerifyJarZip, ClassLoader parentClassLoader, StringBuilder parsedClassPath)` Creates a class loader from a specification of JAR/ZIP files or directories in a string that is either comma or colon separated.
`static Transformer`	`createDefaultTransformer()` Creates a default transformer using UTF-8 encoding and indenting.
`static Document`	`createDocument()` Creates an empty name-space aware Document.
`static String`	`createString(byte[] data)` Helper function for non-initialized byte-to-string conversion using ISO 8859-1 character set.
`static String`	`createString(byte[] data, int offset, int length)` Helper function for non-initialized byte-to-string conversion using ISO 8859-1 character set.
`static void`	`disposeInternalFrame(JInternalFrame f)` Disposes of a JInternalFrame window inside a JDesktopPane.
`static String`	`enableUnlimitedCryptography()` Make sure to enable unlimited cryptography (try to enable it for Java 8 update 152 or better).
`static String`	`enableUnlimitedCryptography(boolean allowLegacySSL)` Make sure to enable unlimited cryptography (try to enable it for Java 8 update 152 or better).
`static boolean`	`endsWith(byte[] source, byte[] suffix)` Tests if the source byte array ends with the specified suffix byte array.
`static boolean`	`equals(Object o1, Object o2)` Checks for equality of two objects, e.g.
`static String`	`formatDurationMillis(long duration)` Formats a String from a duration in milliseconds as hhhhh:mm:ss.mmm.
`static InetAddress[]`	`getAllByName(String host)` Given the name of a host, returns an array of its IP addresses, based on the configured name service on the system.
`static String`	`getBuild()` Get the program build number from the program version string.
`static int`	`getBuildNumber()` Gets the program build number.
`static InetAddress`	`getByName(String host)` Determines the IP address of a host, given the host's name.
`static byte[]`	`getBytes(Document document)` Gets the byte data from an XML document.
`static byte[]`	`getBytes(String data)` Helper function for non-initialized string-to-byte conversion using ISO 8859-1 character set.
`static TransformerFactory`	`getDefaultTransformerFactory()` Creates the default transformer factory.
`static String`	`getEnglishSize(long size)` Gets a size as nn.m TB/GB/MB/KB or bytes.
`static String`	`getHostName(InetAddress ina)` Gets the host name backed up by a cache so that it is only retrieved once.
`static String`	`getHTMLString(String s)` Converts a string so that it doesn't include HTML tags that may affect the display of the text.
`static byte[]`	`getIPv4Address(String name)` Gets the IPv4 byte address.
`static String`	`getStackTrace(Throwable e)` After an exception, call this method to get the stack trace.
`static String`	`getTS()` Gets a timestamp string in format "HH:MM:SS.mmm".
`static String`	`getUserPrivateDirectory()` Gets the directory used to store private information for the user.
`static String`	`getUserPrivateDirectory(boolean doSystemOut)` Gets the directory used to store private information for the user.
`static String`	`getVersion()` Get the version number from the program version string, e.g.
`static int`	`hashCode(byte[] source)` Returns a hash code for the byte array.
`static int`	`indexOf(byte[] source, byte[] search)` Returns the index within the `source` array of the first occurrence of the specified `search` byte array.
`static int`	`indexOf(byte[] source, byte[] search, int fromIndex)` Returns the index within the source byte array of the first occurrence of the specified search byte array, starting at the specified index.
`static boolean`	`isJarOrZip(String fn)` Checks if this file is a JAR or ZIP file (by the extension).
`static boolean`	`isLocalAddress(String host)` Checks if it's a local (intranet) host address.
`static boolean`	`isLocalhost(String name)` Check if it's localhost.
`static int`	`lastIndexOf(byte[] source, byte[] search)` Returns the index within the source byte array of the rightmost occurrence of the specified search byte array.
`static int`	`lastIndexOf(byte[] source, byte[] search, int fromIndex)` Returns the index within the source byte array of the last occurrence of the specified search byte array, searching backward starting at the specified index.
`static ArrayList<String>`	`parseArgs(String cmdline)` Parses the arguments divided by spaces but kept together by quotes.
`static void`	`setToolTipText(JComponent parent, ArrayList<JComponent> listOrNull, String s)` Sets the tool-tip text for the JComponent all children, except the ones and its children that may be in a non-null "listOrNull" array.
`static void`	`setToolTipText(JComponent parent, String s)` Sets the tool-tip text for the JComponent all children, but not the JComponent "parent" itself!
`static boolean`	`startsWith(byte[] source, byte[] prefix)` Tests if the source byte array starts with the specified prefix byte array.
`static boolean`	`startsWith(byte[] source, byte[] prefix, int sourceIndex)` Tests if the source sub-byte array of a byte array beginning at the specified source index starts with the specified prefix.
`static String`	`toHex(byte[] ab)` Converts to hex.

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

- Field Detail
  - DEFAULT_ISO_CODE_PAGE
```
public static final String DEFAULT_ISO_CODE_PAGE
```
    The string used for the ISO 8859-1 codepage: "8859_1".
    
    See Also:
    
    Constant Field Values
  - LINE_SEPARATOR
```
public static final String LINE_SEPARATOR
```
    The Line separator ("\r\n" for Windows, "\n" for Unix).
  - isVerbose
```
public static boolean isVerbose
```
    Flag for verbose output. Must be set by the starting program.
  - PROGRAM_NAME
```
public static String PROGRAM_NAME
```
  - PROGRAM_NAME_UPPER
```
public static String PROGRAM_NAME_UPPER
```
  - PROGRAM_NAME_CLIENT
```
public static String PROGRAM_NAME_CLIENT
```
  - PROGRAM_NAME_SERVER
```
public static String PROGRAM_NAME_SERVER
```
  - PROGRAM_NAME_EDITOR
```
public static String PROGRAM_NAME_EDITOR
```
  - PROGRAM_DOMAIN
```
public static String PROGRAM_DOMAIN
```
  - HEXES_S
```
public static final String HEXES_S
```
    The hex characters as a String.
    
    See Also:
    
    Constant Field Values
  - HEXES_CA
```
public static final char[] HEXES_CA
```
    The hex characters as a character array.
- Constructor Detail
  - Utilities
```
public Utilities()
```
- Method Detail
  - getStackTrace
```
public static String getStackTrace(Throwable e)
```
    After an exception, call this method to get the stack trace. This method is "fail-safe", i.e. if it's a StackOverflowError or the stack trace causes an OutOfMemoryError, just the exception string is returned.
    
    Parameters:
    
    e - The exception.
    
    Returns:
    
    The stack trace.
  - createString
```
public static final String createString(byte[] data)
```
    Helper function for non-initialized byte-to-string conversion using ISO 8859-1 character set.
  - createString
```
public static final String createString(byte[] data,
                                        int offset,
                                        int length)
```
    Helper function for non-initialized byte-to-string conversion using ISO 8859-1 character set.
  - getBytes
```
public static final byte[] getBytes(String data)
```
    Helper function for non-initialized string-to-byte conversion using ISO 8859-1 character set.
  - getUserPrivateDirectory
```
public static String getUserPrivateDirectory()
```
    Gets the directory used to store private information for the user. This is set to the user's home directory followed by the user's name followed by "." + product + major-version. Note that the directory will be created if it doesn't exist. The string ends with the directory separator "\" or "/".
    
    Returns:
    
    null for a security problem, otherwise the string.
  - getUserPrivateDirectory
```
public static String getUserPrivateDirectory(boolean doSystemOut)
```
    Gets the directory used to store private information for the user. This is set to the user's home directory followed by the user's name followed by "." + product + major-version. Note that the directory will be created if it doesn't exist. The string ends with the directory separator "\" or "/".
    
    Parameters:
    
    doSystemOut - If printing should be done or not.
    
    Returns:
    
    null for a security problem, otherwise the string.
  - setToolTipText
```
public static void setToolTipText(JComponent parent,
                                  String s)
```
    Sets the tool-tip text for the JComponent all children, but not the JComponent "parent" itself!
  - setToolTipText
```
public static void setToolTipText(JComponent parent,
                                  ArrayList<JComponent> listOrNull,
                                  String s)
```
    Sets the tool-tip text for the JComponent all children, except the ones and its children that may be in a non-null "listOrNull" array. Note: the tooltip is not set for the JComponent "parent"!
  - getHTMLString
```
public static String getHTMLString(String s)
```
    Converts a string so that it doesn't include HTML tags that may affect the display of the text.
  - createClassLoader
```
public static URLClassLoader createClassLoader(String spec,
                                               boolean doVerifyJarZip,
                                               ClassLoader parent)
                                        throws MalformedURLException
```
    Creates a class loader from a specification of JAR/ZIP files or directories in a string that is either comma or colon separated. If the entry doesn't exist, i.e. doesn't refer to an existing JAR/ZIP file or if it's not a directory, it will be ignored. Duplicate entries are skipped.
    The new URLClassLoader is created for the given URLs. The URLs will be searched in the order specified for classes and resources after first searching in the specified parent class loader.
    
    Parameters:
    
    spec - The URL's separated by comma or colon.
    
    doVerifyJarZip - Each entry referring to a JAR/ZIP file will be checked if it's a valid.
    
    parent - The parent class loader for delegation, null for none.
    IT IS NOT RECOMMENDED TO USE null for the parent class loader as this has been modified dramatically in Java 9, 10, 11 or better!
    
    Returns:
    
    null if there is a security issue. This will in this case be printed on System.err.
    
    Throws:
    
    MalformedURLException - If an URL is malformed.
  - createClassLoader
```
public static URLClassLoader createClassLoader(String spec,
                                               boolean doVerifyJarZip,
                                               ClassLoader parentClassLoader,
                                               StringBuilder parsedClassPath)
                                        throws MalformedURLException
```
    Creates a class loader from a specification of JAR/ZIP files or directories in a string that is either comma or colon separated. If the entry doesn't exist, i.e. doesn't refer to an existing JAR/ZIP file or if it's not a directory, it will be ignored. Duplicate entries are skipped.
    The new URLClassLoader is created for the given URLs. The URLs will be searched in the order specified for classes and resources after first searching in the specified parent class loader.
    
    Parameters:
    
    spec - The URL's separated by comma or colon.
    
    doVerifyJarZip - Each entry referring to a JAR/ZIP file will be checked if it's a valid.
    
    parentClassLoader - The parent class loader for delegation, null for none.
    IT IS NOT RECOMMENDED TO USE null for the parentClassLoader as this has been modified dramatically in Java 9, 10, 11 or better!
    
    parsedClassPath - If non-null, this StringBuilder instance will contain the parsed classpath separated with ";" and correct character case.
    
    Returns:
    
    null if there is a security issue. This will in this case be printed on System.err.
    
    Throws:
    
    MalformedURLException - If an URL is malformed.
  - disposeInternalFrame
```
public static void disposeInternalFrame(JInternalFrame f)
```
    Disposes of a JInternalFrame window inside a JDesktopPane.
  - getDefaultTransformerFactory
```
public static TransformerFactory getDefaultTransformerFactory()
```
    Creates the default transformer factory.
  - createDefaultTransformer
```
public static Transformer createDefaultTransformer()
                                            throws TransformerConfigurationException
```
    Creates a default transformer using UTF-8 encoding and indenting.
    
    Throws:
    
    TransformerConfigurationException - When the transformer configuration is in error.
  - getBytes
```
public static byte[] getBytes(Document document)
                       throws TransformerException
```
    Gets the byte data from an XML document.
    
    Parameters:
    
    document - the Document.
    
    Throws:
    
    TransformerException - When there is a error in the transformation.
  - createDocument
```
public static Document createDocument()
```
    Creates an empty name-space aware Document.
  - isJarOrZip
```
public static boolean isJarOrZip(String fn)
```
    Checks if this file is a JAR or ZIP file (by the extension).
  - startsWith
```
public static boolean startsWith(byte[] source,
                                 byte[] prefix,
                                 int sourceIndex)
```
    Tests if the source sub-byte array of a byte array beginning at the specified source index starts with the specified prefix.
    
    Parameters:
    
    source - The source byte array.
    
    prefix - The prefix byte array.
    
    sourceIndex - Where to begin looking in the source array.
    
    Returns:
    
    true if the source byte array starting at the specified sourceIndex starts with the prefix byte array; false otherwise. The result is false if sourceIndex is negative or greater than the length of this source array.
  - startsWith
```
public static boolean startsWith(byte[] source,
                                 byte[] prefix)
```
    Tests if the source byte array starts with the specified prefix byte array.
    
    Parameters:
    
    source - The source byte array.
    
    prefix - The prefix byte array.
    
    Returns:
    
    true if the source byte array starts with the prefix byte array; false otherwise.
  - endsWith
```
public static boolean endsWith(byte[] source,
                               byte[] suffix)
```
    Tests if the source byte array ends with the specified suffix byte array.
    
    Parameters:
    
    source - The source byte array.
    
    suffix - The suffix byte array.
    
    Returns:
    
    true if the source byte array ends with the suffix byte array; false otherwise.
  - hashCode
```
public static int hashCode(byte[] source)
```
    Returns a hash code for the byte array. The hash code is computed as
    (source[0]&0xFF)*31^(n-1) + (source[1]&0xFF)*31^(n-2) + ... + (source[n-1]&0xFF)
    using int arithmetic, where source[i] is the ith byte of the array, n is the length of the byte array, and ^ indicates exponentiation. (The hash value of the array length is zero.)
    Note: each byte uses the value 0-255 and not -127 to 128.
    Note 2: this method returns the same hash code as new String(source,"8859_1").hashCode().
    Parameters:
    
    source - the byte array.
    
    Returns:
    
    a hash code value for the byte array.
  - indexOf
```
public static int indexOf(byte[] source,
                          byte[] search)
```
    Returns the index within the source array of the first occurrence of the specified search byte array. The integer returned is the smallest value k such that:
    startsWith(source,search,k)
    is true.
    Parameters:
    
    source - the source byte array.
    
    search - the byte array to locate in the source array.
    
    Returns:
    
    the index where search first occurs in source; -1 if isn't present.
  - indexOf
```
public static int indexOf(byte[] source,
                          byte[] search,
                          int fromIndex)
```
    Returns the index within the source byte array of the first occurrence of the specified search byte array, starting at the specified index. The integer returned is the smallest value k for which:
    k >= Math.min(fromIndex,source.length) && this.startsWith(source,search,k)
    If no such value of k exists, then -1 is returned.
    Parameters:
    
    source - the source byte array.
    
    search - the byte array to locate in the source array.
    
    fromIndex - the index from which to start the search.
    
    Returns:
    
    the index within the source byte array of the first occurrence of the specified search byte array, starting at the specified index.
  - lastIndexOf
```
public static int lastIndexOf(byte[] source,
                              byte[] search)
```
    Returns the index within the source byte array of the rightmost occurrence of the specified search byte array. The rightmost empty byte array is considered to occur at the index value source.length. The returned index is the largest value k such that
    startsWith(source,search,k)
    is true.
    Parameters:
    
    source - the bytes being searched.
    
    search - the byte array to search for.
    
    Returns:
    
    if the search argument occurs one or more times as a sub-byte array within the source byte array, then the index of the first byte of the last such search sub-byte array is returned. If it does not occur as a sub-byte array, -1 is returned.
  - lastIndexOf
```
public static int lastIndexOf(byte[] source,
                              byte[] search,
                              int fromIndex)
```
    Returns the index within the source byte array of the last occurrence of the specified search byte array, searching backward starting at the specified index. The integer returned is the largest value k such that:
    k <= Math.min(fromIndex,source.length) && startsWith(source,search,k)
    If no such value of k exists, then -1 is returned.
    Parameters:
    
    source - the bytes being searched.
    
    search - the byte array to search for.
    
    fromIndex - the index to start the search from.
    
    Returns:
    
    the index within the source byte array of the last occurrence of the specified source sub-byte array.
  - toHex
```
public static String toHex(byte[] ab)
```
    Converts to hex.
    
    Parameters:
    
    ab - Array of bytes to convert to a hex string of twice the size.
    
    Returns:
    
    The hexadecimal representation of the byte array.
  - getByName
```
public static InetAddress getByName(String host)
                             throws UnknownHostException
```
    Determines the IP address of a host, given the host's name.
    The host name can either be a machine name, such as "java.sun.com", or a textual representation of its IP address. If a literal IP address is supplied, only the validity of the address format is checked.
    If the host is null then an InetAddress representing an address of the loopback interface is returned.
    
    Parameters:
    
    host - the specified host, or null.
    
    Returns:
    
    An IP address for the given host name.
    
    Throws:
    
    UnknownHostException - if no IP address for the host could be found, or if a scope_id was specified for a global IPv6 address.
  - getAllByName
```
public static InetAddress[] getAllByName(String host)
                                  throws UnknownHostException
```
    Given the name of a host, returns an array of its IP addresses, based on the configured name service on the system.
    The host name can either be a machine name, such as "java.sun.com", or a textual representation of its IP address. If a literal IP address is supplied, only the validity of the address format is checked.
    For host specified in literal IPv6 address, either the form defined in RFC 2732 or the literal IPv6 address format defined in RFC 2373 is accepted. A literal IPv6 address may also be qualified by appending a scoped zone identifier or scope_id.
    If the host is null then an InetAddress representing an address of the loopback interface is returned.
    
    Parameters:
    
    host - host - the name of the host, or null.
    
    Returns:
    
    An array of all the IP addresses for a given host name.
    
    Throws:
    
    UnknownHostException - if no IP address for the host could be found, or if a scope_id was specified for a global IPv6 address.
  - getIPv4Address
```
public static byte[] getIPv4Address(String name)
```
    Gets the IPv4 byte address.
    
    Returns:
    
    null if not number address.
  - isLocalhost
```
public static boolean isLocalhost(String name)
```
    Check if it's localhost.
  - isLocalAddress
```
public static boolean isLocalAddress(String host)
```
    Checks if it's a local (intranet) host address.
    
    Parameters:
    
    host - The host name.
    
    Returns:
    
    true if local intranet host address, false otherwise.
  - getHostName
```
public static String getHostName(InetAddress ina)
```
    Gets the host name backed up by a cache so that it is only retrieved once. Alternative to using InetAddress ina=... then ina.getHostName.
    
    Returns:
    
    the host name for this IP address.
  - getTS
```
public static String getTS()
```
    Gets a timestamp string in format "HH:MM:SS.mmm".
  - getBuild
```
public static String getBuild()
```
    Get the program build number from the program version string.
    
    Returns:
    
    Build number string, four digits.
  - getBuildNumber
```
public static int getBuildNumber()
```
    Gets the program build number.
    
    Returns:
    
    -1 for none, otherwise the build number.
  - getVersion
```
public static String getVersion()
```
    Get the version number from the program version string, e.g. "6.01".
    
    Returns:
    
    build string
  - parseArgs
```
public static ArrayList<String> parseArgs(String cmdline)
```
    Parses the arguments divided by spaces but kept together by quotes. Double-quotes adds a single quote.
  - equals
```
public static boolean equals(Object o1,
                             Object o2)
```
    Checks for equality of two objects, e.g. Strings, with null support. Do not use this method to check arrays.
  - formatDurationMillis
```
public static String formatDurationMillis(long duration)
```
    Formats a String from a duration in milliseconds as hhhhh:mm:ss.mmm.
    
    Parameters:
    
    duration - Duration in milliseconds.
    
    Returns:
    
    A String representation of the duration as hhhhh:mm:ss.mmm.
  - getEnglishSize
```
public static String getEnglishSize(long size)
```
    Gets a size as nn.m TB/GB/MB/KB or bytes.
    
    Parameters:
    
    size - The positive size value.
    
    Returns:
    
    A string formatted with the current user's decimal separator as M.NN [unit].
  - enableUnlimitedCryptography
```
public static String enableUnlimitedCryptography()
```
    Make sure to enable unlimited cryptography (try to enable it for Java 8 update 152 or better).
    Parameters:
    allowUnsafe - Flag to allow unsafe stuff, i.e. not to set the system properties:
    
    jdk.tls.ephemeralDHKeySize = "2048"
    jdk.tls.rejectClientInitiatedRenegotiation = "true"
    jdk.tls.server.enableSessionTicketExtension = "false" (only for Java 13 or better)
    sun.security.ssl.allowUnsafeRenegotiation = "false"
    jdk.tls.useExtendedMasterSecret = "false"
    jdk.tls.allowLegacyResumption = "false"
    jdk.tls.allowLegacyMasterSecret = "false"
    Returns:
    
    null for success, otherwise an error message.
  - enableUnlimitedCryptography
```
public static String enableUnlimitedCryptography(boolean allowLegacySSL)
```
    Make sure to enable unlimited cryptography (try to enable it for Java 8 update 152 or better).
    Parameters:
    allowLegacySSL - Flag to allow unsafe legacy stuff, i.e. not to set the system properties:
    
    jdk.tls.ephemeralDHKeySize = "2048"
    jdk.tls.rejectClientInitiatedRenegotiation = "true"
    jdk.tls.server.enableSessionTicketExtension = "false" (only for Java 13 or better)
    sun.security.ssl.allowUnsafeRenegotiation = "false"
    jdk.tls.useExtendedMasterSecret = "false"
    jdk.tls.allowLegacyResumption = "false"
    jdk.tls.allowLegacyMasterSecret = "false"
    Returns:
    
    null for success, otherwise an error message.

Class Utilities

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ISO_CODE_PAGE

LINE_SEPARATOR

isVerbose

PROGRAM_NAME

PROGRAM_NAME_UPPER

PROGRAM_NAME_CLIENT

PROGRAM_NAME_SERVER

PROGRAM_NAME_EDITOR

PROGRAM_DOMAIN

HEXES_S

HEXES_CA

Constructor Detail

Utilities

Method Detail

getStackTrace

createString

createString

getBytes

getUserPrivateDirectory

getUserPrivateDirectory

setToolTipText

setToolTipText

getHTMLString

createClassLoader

createClassLoader

disposeInternalFrame

getDefaultTransformerFactory

createDefaultTransformer

getBytes

createDocument

isJarOrZip

startsWith

startsWith

endsWith

hashCode

indexOf

indexOf

lastIndexOf

lastIndexOf

toHex

getByName

getAllByName

getIPv4Address

isLocalhost

isLocalAddress

getHostName

getTS

getBuild

getBuildNumber

getVersion

parseArgs

equals

formatDurationMillis

getEnglishSize

enableUnlimitedCryptography

enableUnlimitedCryptography