ClientSharedUtils (GemFire XD Java API Documentation)

java.lang.Object
- com.gemstone.gemfire.internal.shared.ClientSharedUtils

```
public abstract class ClientSharedUtils
extends Object
```
Some shared methods now also used by GemFireXD clients so should not have any dependency on other GemFire packages.

Since:

7.5

Field Summary

Fields
Modifier and Type	Field and Description
`static TimeZone`	`currentTimeZone` The cached timezone of this VM.
`static long`	`currentTimeZoneOffset` The cached timezone offset not including daylight savings.
`static String`	`currentTZShortName` short display name of current timezone in current locale
`static String`	`currentTZShortNameDST` short display name of current timezone+daylight in current locale
`static char[]`	`HEX_DIGITS`
`static char[]`	`HEX_DIGITS_UCASE`
`static String`	`lineSeparator` the system line separator
`static String`	`LOGGER_NAME` The name of java.util.logging.Logger for GemFireXD.
`static long`	`MAG_MASK`
`static String`	`USE_LINK_LOCAL_ADDRESSES_PROPERTY` Optional system property to enable GemFire usage of link-local addresses
`static boolean`	`USE_THRIFT_AS_DEFAULT` True if using Thrift as default network server and client, false if using DRDA (default).
`static String`	`USE_THRIFT_AS_DEFAULT_PROP` System property (with "gemfirexd." prefix) to specify that Thrift is to be used as the default for default `jdbc:gemfirexd://` URL

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`clear()`
`static boolean`	`equalBuffers(byte[] bytes, ByteBuffer buffer)`
`static boolean`	`equalBuffers(ByteBuffer connToken, ByteBuffer otherId)`
`static void`	`formatDate(long time, int tzOffset, StringBuilder sb)` Adapted from Derby's CheapDateFormatter to make use of given calendar and make it more efficient using StringBuilder.
`static void`	`formatDate(long currentTimeInMillis, StringBuilder sb)`
`static byte[]`	`fromHexString(String s, int offset, int length)` Convert a hexidecimal string generated by toHexString() back into a byte array.
`static int[]`	`getBigIntInternalMagnitude(BigInteger val)` Returns the internal int[] magnitude from given BigInteger, if possble, else returns null.
`static int`	`getBigIntMagnitudeSizeInBytes(int[] magnitude)`
`static InetAddress`	`getCachedLocalHost()`
`static JdkHelper`	`getJdkHelper()`
`static InetAddress`	`getLocalHost()` All GemFire code should use this method instead of InetAddress.getLocalHost().
`static Logger`	`getLogger()`
`static Set<InetAddress>`	`getMyAddresses(boolean includeLocal)` returns a set of the non-loopback InetAddresses for this machine
`static void`	`getStackTrace(Throwable t, StringBuilder sb, String lineSep)` Append the backtrace of given exception to provided `StringBuilder`.
`static Object[]`	`getZeroLenObjectArray()`
`static void`	`initLog4J(String logFile, Level level)`
`static void`	`initLogger(String loggerName, String logFile, boolean initLog4j, Level level, Handler handler)`
`static RuntimeException`	`newRuntimeException(String message, Throwable cause)`
`static int`	`numBytesWithoutZeros(long value)` Get the number of bytes occupied in the given unsigned integer value.
`static void`	`objectString(Object obj, StringBuilder sb)` Get proper string for an object including arrays.
`static void`	`objectStringNonRecursive(Object obj, StringBuilder sb)` Get proper string for an an object including arrays with upto one dimension of arrays.
`static boolean`	`preferIPv6Addresses()` All classes should use this instead of relying on the JRE system property
`static String`	`reverseDNS(InetAddress addr)` This method uses JNDI to look up an address in DNS and return its name.
`static void`	`setCommonRuntimeException(CommonRunTimeException e)`
`static void`	`setKeepAliveOptions(Socket sock, InputStream sockStream, int keepIdle, int keepInterval, int keepCount)` Enable TCP KeepAlive settings for the socket.
`static void`	`setLogger(Logger log)`
`static char[]`	`toHexChars(byte[] data, int offset, int length)` Convert a byte array to a char[] with a hexidecimal format.
`static String`	`toHexString(byte[] data, int offset, int length)` Convert a byte array to a String with a hexidecimal format.
`static String`	`toHexString(ByteBuffer buffer)` Convert a ByteBuffer to a String with a hexidecimal format.
`static void`	`toHexString(ByteBuffer buffer, StringBuilder sb)` Convert a ByteBuffer to a string appending to given `StringBuilder` with a hexidecimal format.
`static String`	`toHexStringUpperCase(byte[] data, int offset, int length)` Convert a byte array to a String with upper case hexidecimal format.
`static boolean`	`wrapsFullArray(ByteBuffer byteBuffer)`

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

- Field Detail
  - LOGGER_NAME
```
public static final String LOGGER_NAME
```
    The name of java.util.logging.Logger for GemFireXD.
    
    See Also:
    Constant Field Values
  - USE_LINK_LOCAL_ADDRESSES_PROPERTY
```
public static final String USE_LINK_LOCAL_ADDRESSES_PROPERTY
```
    Optional system property to enable GemFire usage of link-local addresses
    
    See Also:
    Constant Field Values
  - USE_THRIFT_AS_DEFAULT_PROP
```
public static final String USE_THRIFT_AS_DEFAULT_PROP
```
    System property (with "gemfirexd." prefix) to specify that Thrift is to be used as the default for default jdbc:gemfirexd:// URL
    
    See Also:
    Constant Field Values
  - USE_THRIFT_AS_DEFAULT
```
public static final boolean USE_THRIFT_AS_DEFAULT
```
    True if using Thrift as default network server and client, false if using DRDA (default).
  - lineSeparator
```
public static final String lineSeparator
```
    the system line separator
  - HEX_DIGITS
```
public static char[] HEX_DIGITS
```
  - HEX_DIGITS_UCASE
```
public static char[] HEX_DIGITS_UCASE
```
  - currentTimeZone
```
public static final TimeZone currentTimeZone
```
    The cached timezone of this VM.
  - currentTimeZoneOffset
```
public static final long currentTimeZoneOffset
```
    The cached timezone offset not including daylight savings.
  - currentTZShortName
```
public static final String currentTZShortName
```
    short display name of current timezone in current locale
  - currentTZShortNameDST
```
public static final String currentTZShortNameDST
```
    short display name of current timezone+daylight in current locale
  - MAG_MASK
```
public static final long MAG_MASK
```
    See Also:
    Constant Field Values
- Method Detail
  - getJdkHelper
```
public static final JdkHelper getJdkHelper()
```
  - getLocalHost
```
public static InetAddress getLocalHost()
                                throws UnknownHostException
```
    All GemFire code should use this method instead of InetAddress.getLocalHost(). See bug #40623
    
    Throws:
    
    UnknownHostException
  - getCachedLocalHost
```
public static InetAddress getCachedLocalHost()
```
  - preferIPv6Addresses
```
public static boolean preferIPv6Addresses()
```
    All classes should use this instead of relying on the JRE system property
  - reverseDNS
```
public static String reverseDNS(InetAddress addr)
```
    This method uses JNDI to look up an address in DNS and return its name.
    
    Parameters:
    addr - the address to be looked up
    
    Returns:
    the host name associated with the address or null if lookup isn't possible or there is no host name for this address
  - getMyAddresses
```
public static Set<InetAddress> getMyAddresses(boolean includeLocal)
                                       throws SocketException
```
    returns a set of the non-loopback InetAddresses for this machine
    
    Throws:
    
    SocketException
  - setKeepAliveOptions
```
public static void setKeepAliveOptions(Socket sock,
                       InputStream sockStream,
                       int keepIdle,
                       int keepInterval,
                       int keepCount)
                                throws SocketException
```
    Enable TCP KeepAlive settings for the socket. This will use the native OS API to set per-socket configuration, if available, else will log warning (only once) if one or more settings cannot be enabled.
    
    Parameters:
    sock - the underlying Java Socket to set the keep-alive
    sockStream - the InputStream of the socket (can be null); if non-null then it is used to determine the underlying socket kernel handle else if null then reflection on the socket itself is used
    keepIdle - keep-alive time between two transmissions on socket in idle condition (in seconds)
    keepInterval - keep-alive duration between successive transmissions on socket if no reply to packet sent after idle timeout (in seconds)
    keepCount - number of retransmissions to be sent before declaring the other end to be dead
    
    Throws:
    
    SocketException - if the base keep-alive cannot be enabled on the socket
    See Also:
    TCP Keepalive HOWTO, TCP Tunable Parameters, WSAIoctl function, SIO_KEEPALIVE_VALS control code
  - getStackTrace
```
public static void getStackTrace(Throwable t,
                 StringBuilder sb,
                 String lineSep)
```
    Append the backtrace of given exception to provided StringBuilder.
    
    Parameters:
    t - the exception whose backtrace is required
    sb - the StringBuilder to which the stack trace is to be appended
    lineSep - the line separator to use, or null to use the default from system "line.separator" property
  - getZeroLenObjectArray
```
public static Object[] getZeroLenObjectArray()
```
  - formatDate
```
public static void formatDate(long currentTimeInMillis,
              StringBuilder sb)
```
  - formatDate
```
public static void formatDate(long time,
              int tzOffset,
              StringBuilder sb)
```
    Adapted from Derby's CheapDateFormatter to make use of given calendar and make it more efficient using StringBuilder. Also moved to this class to enable sharing between server and client code. This method formats the current date into a String. The input is a long representing the number of milliseconds since Jan. 1, 1970. The output is a String in the form yyyy/mm/dd hh:mm:ss.ddd GMT. The purpose of this class is to format date strings without paying the price of instantiating ResourceBundles and Locales, which the java.util.Date class does whenever you format a date string. As a result, the output of this class is not localized, it does not take the local time zone into account, and it is possible that it will not be as accurate as the standard Date class. It is OK to use this method when, for example, formatting timestamps to write to db2j.LOG, but not for manipulating dates in language processing.
    
    Parameters:
    time - The current time in milliseconds since Jan. 1, 1970
    tzOffset - The offset of TimeZone including DST.
    sb - Append the date formatted as yyyy/mm/dd hh:mm:ss.ddd to the StringBuilder.
  - toHexString
```
public static String toHexString(byte[] data,
                 int offset,
                 int length)
```
    Convert a byte array to a String with a hexidecimal format. The String may be converted back to a byte array using fromHexString.
    For each byte (b) two characaters are generated, the first character represents the high nibble (4 bits) in hexidecimal (b & 0xf0), the second character represents the low nibble (b & 0x0f).
    The byte at data[offset] is represented by the first two characters in the returned String.
    
    Parameters:
    data - byte array
    offset - starting byte (zero based) to convert.
    length - number of bytes to convert.
    
    Returns:
    the String (with hexidecimal format) form of the byte array
  - toHexStringUpperCase
```
public static String toHexStringUpperCase(byte[] data,
                          int offset,
                          int length)
```
    Convert a byte array to a String with upper case hexidecimal format. The String may be converted back to a byte array using fromHexString.
    For each byte (b) two characaters are generated, the first character represents the high nibble (4 bits) in hexidecimal (b & 0xf0), the second character represents the low nibble (b & 0x0f).
    The byte at data[offset] is represented by the first two characters in the returned String.
    
    Parameters:
    data - byte array
    offset - starting byte (zero based) to convert.
    length - number of bytes to convert.
    
    Returns:
    the String (with hexidecimal format) form of the byte array
  - toHexChars
```
public static char[] toHexChars(byte[] data,
                int offset,
                int length)
```
    Convert a byte array to a char[] with a hexidecimal format. The char[] may be converted back to a byte array using fromHexString.
    For each byte (b) two characaters are generated, the first character represents the high nibble (4 bits) in hexidecimal (b & 0xf0), the second character represents the low nibble (b & 0x0f).
    The byte at data[offset] is represented by the first two characters in the returned char[].
    
    Parameters:
    data - byte array
    offset - starting byte (zero based) to convert.
    length - number of bytes to convert.
    
    Returns:
    the char[] (with hexidecimal format) form of the byte array
  - toHexString
```
public static String toHexString(ByteBuffer buffer)
```
    Convert a ByteBuffer to a String with a hexidecimal format. The String may be converted back to a byte array using fromHexString.
    For each byte (b) two characaters are generated, the first character represents the high nibble (4 bits) in hexidecimal (b & 0xf0), the second character represents the low nibble (b & 0x0f).
    The byte at data[offset] is represented by the first two characters in the returned String.
    
    Parameters:
    buffer - the ByteBuffer to convert
    
    Returns:
    the String (with hexidecimal format) form of the byte array
  - wrapsFullArray
```
public static boolean wrapsFullArray(ByteBuffer byteBuffer)
```
  - toHexString
```
public static void toHexString(ByteBuffer buffer,
               StringBuilder sb)
```
    Convert a ByteBuffer to a string appending to given StringBuilder with a hexidecimal format. The string may be converted back to a byte array using fromHexString.
    For each byte (b) two characaters are generated, the first character represents the high nibble (4 bits) in hexidecimal (b & 0xf0), the second character represents the low nibble (b & 0x0f).
    The byte at data[offset] is represented by the first two characters in the returned string.
    
    Parameters:
    buffer - the ByteBuffer to convert
    sb - the StringBuilder to which conversion result is appended
  - fromHexString
```
public static byte[] fromHexString(String s,
                   int offset,
                   int length)
```
    Convert a hexidecimal string generated by toHexString() back into a byte array.
    
    Parameters:
    s - String to convert
    offset - starting character (zero based) to convert
    length - number of characters to convert
    
    Returns:
    the converted byte array
    
    Throws:
    
    IllegalArgumentException - if the given string is not a hex-encoded one
  - setCommonRuntimeException
```
public static void setCommonRuntimeException(CommonRunTimeException e)
```
  - newRuntimeException
```
public static RuntimeException newRuntimeException(String message,
                                   Throwable cause)
```
  - initLog4J
```
public static void initLog4J(String logFile,
             Level level)
                      throws IOException
```
    Throws:
    
    IOException
  - initLogger
```
public static void initLogger(String loggerName,
              String logFile,
              boolean initLog4j,
              Level level,
              Handler handler)
```
  - setLogger
```
public static void setLogger(Logger log)
```
  - getLogger
```
public static Logger getLogger()
```
  - getBigIntInternalMagnitude
```
public static int[] getBigIntInternalMagnitude(BigInteger val)
```
    Returns the internal int[] magnitude from given BigInteger, if possble, else returns null.
  - getBigIntMagnitudeSizeInBytes
```
public static int getBigIntMagnitudeSizeInBytes(int[] magnitude)
```
  - numBytesWithoutZeros
```
public static final int numBytesWithoutZeros(long value)
```
    Get the number of bytes occupied in the given unsigned integer value.
  - clear
```
public static void clear()
```
  - objectStringNonRecursive
```
public static void objectStringNonRecursive(Object obj,
                            StringBuilder sb)
```
    Get proper string for an an object including arrays with upto one dimension of arrays.
  - objectString
```
public static void objectString(Object obj,
                StringBuilder sb)
```
    Get proper string for an object including arrays.
  - equalBuffers
```
public static boolean equalBuffers(ByteBuffer connToken,
                   ByteBuffer otherId)
```
  - equalBuffers
```
public static boolean equalBuffers(byte[] bytes,
                   ByteBuffer buffer)
```

Class ClientSharedUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER_NAME

USE_LINK_LOCAL_ADDRESSES_PROPERTY

USE_THRIFT_AS_DEFAULT_PROP

USE_THRIFT_AS_DEFAULT

lineSeparator

HEX_DIGITS

HEX_DIGITS_UCASE

currentTimeZone

currentTimeZoneOffset

currentTZShortName

currentTZShortNameDST

MAG_MASK

Method Detail

getJdkHelper

getLocalHost

getCachedLocalHost

preferIPv6Addresses

reverseDNS

getMyAddresses

setKeepAliveOptions

getStackTrace

getZeroLenObjectArray

formatDate

formatDate

toHexString

toHexStringUpperCase

toHexChars

toHexString

wrapsFullArray

toHexString

fromHexString

setCommonRuntimeException

newRuntimeException

initLog4J

initLogger

setLogger

getLogger

getBigIntInternalMagnitude

getBigIntMagnitudeSizeInBytes

numBytesWithoutZeros

clear

objectStringNonRecursive

objectString

equalBuffers

equalBuffers