Util (KSI SDK 4.19.220 API)

java.lang.Object
- com.guardtime.ksi.util.Util

```
public final class Util
extends Object
```
A collection of miscellaneous, commonly used utility functions.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_BUFFER_SIZE
The default buffer size for the data read/copy operations in this class.

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BUFFER_SIZE` The default buffer size for the data read/copy operations in this class.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static byte[]`	`addCrc32(byte[] b)` Computes the CRC32 checksum for the given data.
`static byte[]`	`addCrc32(byte[] b, int off, int len)` Computes the CRC32 checksum for `len` bytes of the given data, starting from `off`.
`static byte[]`	`calculateCrc32(byte[] b, int off, int length)` Computes the CRC32 checksum for `length` bytes of the given data, starting from `off`.
`static byte[]`	`calculateHMAC(byte[] message, byte[] keyBytes, String algorithm)` Calculates the RFC 2104 compatible HMAC for the given message, key, and algorithm.
`static void`	`closeQuietly(InputStream input)` Closes an `InputStream` unconditionally.
`static void`	`closeQuietly(OutputStream output)` Closes an `OutputStream` unconditionally.
`static boolean`	`containsInt(int[] array, int key)` Checks if an element is present in an int array.
`static int`	`copyData(InputStream in, OutputStream out)` Copies all available data from `in` to `out`.
`static int`	`copyData(InputStream in, OutputStream out, int limit)` Copies up to `limit` bytes of data from `in` to `out`.
`static int`	`copyData(InputStream in, OutputStream out, int limit, int bufSize)` Copies up to `limit` bytes of data from `in` to `out`.
`static byte[]`	`copyOf(byte[] b)` Creates a copy of the given byte array.
`static byte[]`	`copyOf(byte[] b, int off, int len)` Creates a copy of a section of the given byte array.
`static String`	`decodeString(byte[] buf, int ofs, int len)` Decodes UTF-8 string from the given buffer.
`static long`	`decodeUnsignedLong(byte[] buf, int ofs, int len)` Decodes an unsigned integer from the given buffer.
`static byte[]`	`encodeUnsignedLong(long value)` Encodes the given value in a minimal number of bytes, in network byte order (most significant bits first).
`static boolean`	`equals(Object o1, Object o2)` Checks if two objects are equal.
`static boolean`	`equalsIgnoreOrder(Collection<?> c1, Collection<?> c2)` Checks if two collections are equal ignoring the order of components.
`static int`	`gcd(int a, int b)` Computes the greatest common divisor (GCD) of two integers.
`static String`	`getDefaultTrustStore()`
`static byte[]`	`join(byte[] a, byte[] b)` Joins two byte arrays into one.
`static int`	`lcm(int a, int b)` Computes the least common multiple (LCM) of two integers.
`static KeyStore`	`loadKeyStore(File file, String password)` Loads and returns the `KeyStore` from the file system.
`static Long`	`nextLong()` Returns the next pseudorandom, uniformly distributed long value from the Math.random() sequence.
`static void`	`notNull(Object o, String name)` Checks if the input object is null or not.
`static byte[]`	`toByteArray(InputStream in)` Copies all available data from `in` to byte array.
`static byte[]`	`toByteArray(InputStream in, int bufferSize)` Copies all available data from `in` to byte array.
`static byte[]`	`toByteArray(int value)` Converts `value` to four-byte array.
`static byte[]`	`toByteArray(long value)` Converts `value` to eight-byte array.
`static byte[]`	`toByteArray(short value)` Converts `value` to two-byte array.
`static byte[]`	`toByteArray(String value)` Encodes the given string in UTF-8.
`static int`	`toInt(byte[] b)` Converts the first four bytes of `b` to a 32-bit signed integer.
`static int`	`toInt(byte[] b, int offset)` Converts four bytes of `b`, starting from `offset`, to a 32-bit signed integer.
`static long`	`toLong(byte[] b)` Converts the first eight bytes of `b` to a 64-bit signed integer.
`static long`	`toLong(byte[] b, int offset)` Converts eight bytes of `b`, starting from `offset`, to a 64-bit signed integer.
`static short`	`toShort(byte[] b)` Converts the first two bytes of `b` to a 16-bit signed integer.
`static short`	`toShort(byte[] b, int offset)` Converts two bytes of `b`, starting from `offset`, to a 16-bit signed integer.
`static URL`	`toUrl(String url)` Creates an URL object from the String representation.

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

- Field Detail
  - DEFAULT_BUFFER_SIZE
```
public static final int DEFAULT_BUFFER_SIZE
```
    The default buffer size for the data read/copy operations in this class.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - addCrc32
```
public static byte[] addCrc32(byte[] b)
                       throws NullPointerException,
                              ArrayIndexOutOfBoundsException
```
    Computes the CRC32 checksum for the given data.
    The checksum is appended to the original data and the result returned in a newly allocated array.
    
    Parameters:
    
    b - the data to compute the checksum for.
    
    Returns:
    
    an array containing the original data with the CRC appended to it.
    
    Throws:
    
    NullPointerException - if b is null.
    
    ArrayIndexOutOfBoundsException - if the half-range [off..off+len) is not in [0..b.length).
  - addCrc32
```
public static byte[] addCrc32(byte[] b,
                              int off,
                              int len)
                       throws NullPointerException,
                              ArrayIndexOutOfBoundsException
```
    Computes the CRC32 checksum for len bytes of the given data, starting from off.
    The checksum is appended to the original data and the result returned in a newly allocated array.
    
    Parameters:
    
    b - the data to compute the checksum for.
    
    off - the buffer containing the data to compute the checksum for.
    
    len - number of bytes to include in the checksum.
    
    Returns:
    
    An array containing specified data bytes with CRC appended to it.
    
    Throws:
    
    NullPointerException - if b is null.
    
    ArrayIndexOutOfBoundsException - if the half-range [off..off+len) is not in [0..b.length).
  - calculateCrc32
```
public static byte[] calculateCrc32(byte[] b,
                                    int off,
                                    int length)
```
    Computes the CRC32 checksum for length bytes of the given data, starting from off.
    
    Parameters:
    
    b - the the data to compute the checksum for.
    
    off - the buffer containing the data to compute the checksum for.
    
    length - number of bytes to include in the checksum.
    
    Returns:
    
    An array containing calculated CRC32 value.
  - decodeString
```
public static String decodeString(byte[] buf,
                                  int ofs,
                                  int len)
                           throws CharacterCodingException
```
    Decodes UTF-8 string from the given buffer.
    
    Parameters:
    
    buf - the buffer.
    
    ofs - offset of the UTF-8 data in the buffer.
    
    len - length of the UTF-8 data to decode.
    
    Returns:
    
    The decoded string.
    
    Throws:
    
    CharacterCodingException - when the specified data is not in valid UTF-8 format.
  - toByteArray
```
public static byte[] toByteArray(String value)
```
    Encodes the given string in UTF-8.
    
    Parameters:
    
    value - the string to encode.
    
    Returns:
    
    A newly allocated array containing the encoding result.
  - toByteArray
```
public static byte[] toByteArray(InputStream in)
                          throws IOException
```
    Copies all available data from in to byte array.
    
    Parameters:
    
    in - input stream to copy data from.
    
    Returns:
    
    An array of bytes read from input stream.
    
    Throws:
    
    IOException
  - toByteArray
```
public static byte[] toByteArray(InputStream in,
                                 int bufferSize)
                          throws IOException
```
    Copies all available data from in to byte array.
    
    Parameters:
    
    in - input stream to copy data from.
    
    bufferSize - buffer size to use.
    
    Returns:
    
    An array of bytes read from input stream.
    
    Throws:
    
    IOException
  - copyOf
```
public static byte[] copyOf(byte[] b)
```
    Creates a copy of the given byte array.
    
    Parameters:
    
    b - the array to copy.
    
    Returns:
    
    The copy of b, or null if b is null.
  - copyOf
```
public static byte[] copyOf(byte[] b,
                            int off,
                            int len)
                     throws NullPointerException,
                            ArrayIndexOutOfBoundsException
```
    Creates a copy of a section of the given byte array.
    
    Parameters:
    
    b - the array to copy.
    
    off - the start offset of the data within b.
    
    len - the number of bytes to copy.
    
    Returns:
    
    The copy of the requested section of b.
    
    Throws:
    
    NullPointerException - if b is null.
    
    ArrayIndexOutOfBoundsException - if the half-range [off..off+len) is not in [0..b.length).
  - join
```
public static byte[] join(byte[] a,
                          byte[] b)
```
    Joins two byte arrays into one.
    
    Parameters:
    
    a - first byte array to join, not null.
    
    b - second byte array to join, not null.
    
    Returns:
    
    Joined byte array.
  - lcm
```
public static int lcm(int a,
                      int b)
               throws ArithmeticException
```
    Computes the least common multiple (LCM) of two integers.
    Least common multiple is the smallest positive integer that can be divided by both numbers without a remainder.
    
    Parameters:
    
    a - the first integer.
    
    b - the second integer.
    
    Returns:
    
    The least common multiple of a and b, or null, if either a or b is null.
    
    Throws:
    
    ArithmeticException - when the result is too big to fit into an int.
  - gcd
```
public static int gcd(int a,
                      int b)
```
    Computes the greatest common divisor (GCD) of two integers.
    Greatest common divisor is the largest integer that divides both numbers without remainder.
    
    Parameters:
    
    a - the first integer.
    
    b - the second integer.
    
    Returns:
    
    The greatest common divisor of a and b, or null, if both a and b are null.
  - toByteArray
```
public static byte[] toByteArray(short value)
```
    Converts value to two-byte array.
    Bytes are returned in network byte order (ordered from the most to the least significant byte).
    
    Parameters:
    
    value - the value to convert.
    
    Returns:
    
    The converted bytes as an array.
  - toByteArray
```
public static byte[] toByteArray(int value)
```
    Converts value to four-byte array.
    Bytes are returned in network byte order (ordered from the most to the least significant byte).
    
    Parameters:
    
    value - the value to convert.
    
    Returns:
    
    The converted bytes as an array.
  - toByteArray
```
public static byte[] toByteArray(long value)
```
    Converts value to eight-byte array.
    Bytes are returned in network byte order (ordered from the most to the least significant byte).
    
    Parameters:
    
    value - the value to convert.
    
    Returns:
    
    The converted bytes as an array.
  - toShort
```
public static short toShort(byte[] b)
```
    Converts the first two bytes of b to a 16-bit signed integer.
    Assumes network byte order (ordered from the most to the least significant byte).
    
    Parameters:
    
    b - the buffer to read from.
    
    Returns:
    
    The converted value.
  - toShort
```
public static short toShort(byte[] b,
                            int offset)
```
    Converts two bytes of b, starting from offset, to a 16-bit signed integer.
    Assumes network byte order (ordered from the most to the least significant byte).
    
    Parameters:
    
    b - the buffer to read from.
    
    offset - start offset in the buffer.
    
    Returns:
    
    The converted value.
  - toInt
```
public static int toInt(byte[] b)
```
    Converts the first four bytes of b to a 32-bit signed integer.
    Assumes network byte order (ordered from the most to the least significant byte).
    
    Parameters:
    
    b - the buffer to read from.
    
    Returns:
    
    The converted value.
  - toInt
```
public static int toInt(byte[] b,
                        int offset)
```
    Converts four bytes of b, starting from offset, to a 32-bit signed integer.
    Assumes network byte order (ordered from the most to the least significant byte).
    
    Parameters:
    
    b - the buffer to read from.
    
    offset - start offset in the buffer.
    
    Returns:
    
    The converted value.
  - toLong
```
public static long toLong(byte[] b)
```
    Converts the first eight bytes of b to a 64-bit signed integer.
    Assumes network byte order (ordered from the most to the least significant byte).
    
    Parameters:
    
    b - the buffer to read from.
    
    Returns:
    
    The converted value.
  - toLong
```
public static long toLong(byte[] b,
                          int offset)
```
    Converts eight bytes of b, starting from offset, to a 64-bit signed integer.
    Assumes network byte order (ordered from the most to the least significant byte).
    
    Parameters:
    
    b - the buffer to read from.
    
    offset - start offset in the buffer.
    
    Returns:
    
    The converted value.
  - decodeUnsignedLong
```
public static long decodeUnsignedLong(byte[] buf,
                                      int ofs,
                                      int len)
                               throws IllegalArgumentException
```
    Decodes an unsigned integer from the given buffer.
    
    Parameters:
    
    buf - the buffer.
    
    ofs - offset of the data in the buffer.
    
    len - length of the data to decode.
    
    Returns:
    
    The decoded value.
    
    Throws:
    
    IllegalArgumentException - when result does not fit into 63-bit unsigned integer.
  - encodeUnsignedLong
```
public static byte[] encodeUnsignedLong(long value)
```
    Encodes the given value in a minimal number of bytes, in network byte order (most significant bits first).
    
    Parameters:
    
    value - the value to encode (the encoding is unsigned, so only non-negative values are supported).
    
    Returns:
    
    A newly allocated array containing the encoding result.
  - calculateHMAC
```
public static byte[] calculateHMAC(byte[] message,
                                   byte[] keyBytes,
                                   String algorithm)
                            throws NoSuchAlgorithmException,
                                   InvalidKeyException
```
    Calculates the RFC 2104 compatible HMAC for the given message, key, and algorithm.
    
    Parameters:
    
    message - message for which the MAC is to be calculated.
    
    keyBytes - key for calculation.
    
    algorithm - algorithm to be used (MD5, SHA1, SHA256).
    
    Returns:
    
    HMAC as byte array.
    
    Throws:
    
    NoSuchAlgorithmException - if invalid algorithm is provided.
    
    InvalidKeyException - if invalid key is provided.
    
    IllegalArgumentException - if HMAC key is null.
  - copyData
```
public static int copyData(InputStream in,
                           OutputStream out)
                    throws IOException
```
    Copies all available data from in to out.
    Allocates a temporary memory buffer of DEFAULT_BUFFER_SIZE bytes for this.
    
    Parameters:
    
    in - input stream to copy data from.
    
    out - output stream to copy data to.
    
    Returns:
    
    The number of bytes actually copied.
    
    Throws:
    
    IOException - if one is thrown by either in or out.
  - copyData
```
public static int copyData(InputStream in,
                           OutputStream out,
                           int limit,
                           int bufSize)
                    throws IOException
```
    Copies up to limit bytes of data from in to out.
    May copy less than limit bytes if in does not have that much data available.
    
    Allocates a temporary memory buffer of bufSize bytes for this.
    
    Parameters:
    
    in - input stream to copy data from.
    
    out - output stream to copy data to.
    
    limit - maximum number of bytes to copy (-1 to copy all bytes).
    
    bufSize - size of the buffer to allocate (larger buffer may speed up the process).
    
    Returns:
    
    The number of bytes actually copied.
    
    Throws:
    
    IOException - if one is thrown by either in or out.
  - copyData
```
public static int copyData(InputStream in,
                           OutputStream out,
                           int limit)
                    throws IOException
```
    Copies up to limit bytes of data from in to out.
    May copy less than limit bytes if in does not have that much data available.
    Allocates a temporary memory buffer of DEFAULT_BUFFER_SIZE bytes for this.
    
    Parameters:
    
    in - input stream to copy data from.
    
    out - output stream to copy data to.
    
    limit - maximum number of bytes to copy.
    
    Returns:
    
    The number of bytes actually copied.
    
    Throws:
    
    IOException - if one is thrown by either in or out.
  - closeQuietly
```
public static void closeQuietly(InputStream input)
```
    Closes an InputStream unconditionally.
    Equivalent to InputStream.close(), except any exceptions will be ignored. This is typically used in finally blocks.
    
    Parameters:
    
    input - InputStream to close.
  - closeQuietly
```
public static void closeQuietly(OutputStream output)
```
    Closes an OutputStream unconditionally.
    Equivalent to OutputStream.close(), except any exceptions will be ignored. This is typically used in finally blocks.
    
    Parameters:
    
    output - OutputStream to close.
  - nextLong
```
public static Long nextLong()
```
    Returns the next pseudorandom, uniformly distributed long value from the Math.random() sequence.
    NB! All values are greater than or equal to zero.
    
    Returns:
    
    The random long.
  - notNull
```
public static void notNull(Object o,
                           String name)
```
    Checks if the input object is null or not.
    
    Parameters:
    
    o - input object.
    
    name - input object name.
  - equals
```
public static boolean equals(Object o1,
                             Object o2)
```
    Checks if two objects are equal. It's safe to pass null objects.
    
    Parameters:
    
    o1 - first input object.
    
    o2 - second input object.
    
    Returns:
    
    True, if both inputs are null or equal to each other.
  - equalsIgnoreOrder
```
public static boolean equalsIgnoreOrder(Collection<?> c1,
                                        Collection<?> c2)
```
    Checks if two collections are equal ignoring the order of components. It's safe to pass collections that might be null.
    
    Parameters:
    
    c1 - first collection.
    
    c2 - second collection.
    
    Returns:
    
    True, if both lists are null or if they have exactly the same components.
  - containsInt
```
public static boolean containsInt(int[] array,
                                  int key)
```
    Checks if an element is present in an int array.
    
    Parameters:
    
    array - an array of int values.
    
    key - an int value.
    
    Returns:
    
    True, if element is present in array.
  - toUrl
```
public static URL toUrl(String url)
```
    Creates an URL object from the String representation.
    
    Parameters:
    
    url - the String to parse as an URL.
    
    Returns:
    
    Uniform Resource Locator object.
  - getDefaultTrustStore
```
public static String getDefaultTrustStore()
```
    Returns:
    
    The default location of Java Runtime Environment certificate store.
  - loadKeyStore
```
public static KeyStore loadKeyStore(File file,
                                    String password)
                             throws KSIException
```
    Loads and returns the KeyStore from the file system.
    
    Parameters:
    
    file - file to load from file system.
    
    password - password to access the keystore.
    
    Returns:
    
    KeyStore
    
    Throws:
    
    KSIException

Class Util

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BUFFER_SIZE

Method Detail

addCrc32

addCrc32

calculateCrc32

decodeString

toByteArray

toByteArray

toByteArray

copyOf

copyOf

join

lcm

gcd

toByteArray

toByteArray

toByteArray

toShort

toShort

toInt

toInt

toLong

toLong

decodeUnsignedLong

encodeUnsignedLong

calculateHMAC

copyData

copyData

copyData

closeQuietly

closeQuietly

nextLong

notNull

equals

equalsIgnoreOrder

containsInt

toUrl

getDefaultTrustStore

loadKeyStore