com.gemstone.gemfire.internal.shared

Class ClientSharedUtils

java.lang.Object

com.gemstone.gemfire.internal.shared.ClientSharedUtils

public abstract class ClientSharedUtils
extends java.lang.Object

Some shared methods now also used by GemFireXD clients so should not have any dependency on other GemFire packages.

Since:

7.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientSharedUtils.ThreadContextObjectInputStream allow using Thread context ClassLoader to load classes

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.ThreadLocal	ALLOW_THREADCONTEXT_CLASSLOADER
static java.util.TimeZone	currentTimeZone The cached timezone of this VM.
static long	currentTimeZoneOffset The cached timezone offset not including daylight savings.
static java.lang.String	currentTZShortName short display name of current timezone in current locale
static java.lang.String	currentTZShortNameDST short display name of current timezone+daylight in current locale
static char[]	HEX_DIGITS
static char[]	HEX_DIGITS_UCASE
static java.lang.String	lineSeparator the system line separator
static java.lang.String	LOGGER_NAME The name of java.util.logging.Logger for GemFireXD.
static long	MAG_MASK
static long	PARK_NANOS_FOR_READ_WRITE The default wait to use when waiting to read/write a channel (when there is no selector to signal)
static long	PARK_NANOS_MAX Maximum nanos to park thread to wait for reading/writing data in non-blocking mode (if selector is present then it will explicitly signal)
static int	RETRIES_BEFORE_PARK Retries before waiting for PARK_NANOS_FOR_READ_WRITE (when there is no selector to signal)
static java.lang.String	USE_LINK_LOCAL_ADDRESSES_PROPERTY Optional system property to enable GemFire usage of link-local addresses
static java.lang.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

Modifier and Type	Method and Description
static void	clear()
static java.util.logging.Level	convertToJavaLogLevel(org.apache.log4j.Level log4jLevel)
static org.apache.log4j.Level	convertToLog4LogLevel(java.util.logging.Level level)
static org.apache.log4j.Level	convertToLog4LogLevel(java.lang.String level)
static void	dumpThreadStack(java.lang.management.ThreadInfo tInfo, java.lang.StringBuilder msg, java.lang.String lineSeparator)
static java.nio.ByteBuffer	ensureCapacity(java.nio.ByteBuffer buffer, int newLength, boolean useDirectBuffer, java.lang.String owner) Allocate new ByteBuffer if capacity of given ByteBuffer has exceeded.
static boolean	equalBuffers(byte[] bytes, java.nio.ByteBuffer buffer)
static void	formatDate(long time, int tzOffset, java.lang.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, java.lang.StringBuilder sb)
static byte[]	fromHexString(java.lang.String s, int offset, int length) Convert a hexidecimal string generated by toHexString() back into a byte array.
static java.lang.reflect.Field	getAnyField(java.lang.Class<?> c, java.lang.String name)
static java.lang.reflect.Method	getAnyMethod(java.lang.Class<?> c, java.lang.String name, java.lang.Class<?> returnType, java.lang.Class<?>... parameterTypes)
static int[]	getBigIntInternalMagnitude(java.math.BigInteger val) Returns the internal int[] magnitude from given BigInteger, if possble, else returns null.
static int	getBigIntMagnitudeSizeInBytes(int[] magnitude)
static java.net.InetAddress	getCachedLocalHost()
static java.net.InetAddress	getLocalHost() All GemFire code should use this method instead of InetAddress.getLocalHost().
static java.util.Properties	getLog4jConfProperties(java.lang.String snappyHome)
static java.lang.String	getLog4jLogFile(org.apache.log4j.Logger rootLogger) Return currently configured log4j log-file or null if file logging is not set.
static java.util.logging.Logger	getLogger()
static java.util.Set<java.net.InetAddress>	getMyAddresses(boolean includeLocal) returns a set of the non-loopback InetAddresses for this machine
static java.nio.file.Path	getProductJarsDirectory(java.lang.Class<?> c)
static void	getStackTrace(java.lang.Throwable t, java.lang.StringBuilder sb, java.lang.String lineSep) Append the backtrace of given exception to provided StringBuilder.
static java.lang.String	getStatementToken(java.lang.String sql, int idx) Moved from Derby's Statement.getStatementToken to shared between client and server code.
static int	getUTFLength(java.lang.String str, int strLen)
static java.lang.Object[]	getZeroLenObjectArray()
static void	initLog4j(java.lang.String logFile, org.apache.log4j.Level level)
static void	initLog4j(java.lang.String logFile, java.util.Properties userProps, org.apache.log4j.Level level)
static void	initLogger(java.lang.String loggerName, java.lang.String logFile, boolean initLog4j, boolean skipIfInitialized, java.util.logging.Level level, java.util.logging.Handler handler)
static boolean	isLoggerInitialized()
static boolean	isSocketToSameHost(java.nio.channels.Channel channel)
static boolean	isSocketToSameHost(java.net.SocketAddress localSockAddress, java.net.SocketAddress remoteSockAddress)
static boolean	isThriftDefault()
static boolean	isUsingThrift(boolean defaultValue)
static java.lang.RuntimeException	newRuntimeException(java.lang.String message, java.lang.Throwable cause)
static java.lang.String	newWrappedString(char[] chars, int offset, int size)
static int	numBytesWithoutZeros(long value) Get the number of bytes occupied in the given unsigned integer value.
static void	objectString(java.lang.Object obj, java.lang.StringBuilder sb) Get proper string for an object including arrays.
static void	objectStringNonRecursive(java.lang.Object obj, java.lang.StringBuilder sb) Get proper string for an an object including arrays with upto one dimension of arrays.
static long	parkThreadForAsyncOperationIfRequired(StreamChannel channel, long parkedNanos, int numTries)
static boolean	parseBoolean(java.lang.String s)
static long	parseMemorySize(java.lang.String v, long defaultValue, int defaultShiftMultiplier)
static boolean	preferIPv6Addresses() All classes should use this instead of relying on the JRE system property
static java.lang.String	readChars(java.io.InputStream in, boolean noecho)
static java.lang.String	reverseDNS(java.net.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(java.net.Socket sock, java.io.InputStream sockStream, int keepIdle, int keepInterval, int keepCount) Enable TCP KeepAlive settings for the socket.
static void	setKeepAliveOptionsServer(java.net.Socket socket, java.io.InputStream socketStream) Set the keep-alive options on the socket from server-side properties.
static void	setLogger(java.util.logging.Logger log)
static void	setThriftDefault(boolean defaultValue)
static byte[]	toBytes(java.nio.ByteBuffer buffer)
static byte[]	toBytes(java.nio.ByteBuffer buffer, int bufferSize, int length)
static byte[]	toBytesCopy(java.nio.ByteBuffer buffer, int bufferSize, int length)
static char[]	toHexChars(byte[] data, int offset, int length) Convert a byte array to a char[] with a hexidecimal format.
static java.lang.String	toHexString(byte[] data, int offset, int length) Convert a byte array to a String with a hexidecimal format.
static java.lang.String	toHexString(java.nio.ByteBuffer buffer) Convert a ByteBuffer to a String with a hexidecimal format.
static void	toHexString(java.nio.ByteBuffer buffer, java.lang.StringBuilder sb) Convert a ByteBuffer to a string appending to given StringBuilder with a hexidecimal format.
static java.lang.String	toHexStringUpperCase(byte[] data, int offset, int length) Convert a byte array to a String with upper case hexidecimal format.
static java.lang.String	toString(java.nio.ByteBuffer buffer)
static boolean	wrapsFullArray(java.nio.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 java.lang.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 java.lang.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 java.lang.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

lineSeparator

public static final java.lang.String lineSeparator

the system line separator

PARK_NANOS_FOR_READ_WRITE

public static final long PARK_NANOS_FOR_READ_WRITE

The default wait to use when waiting to read/write a channel (when there is no selector to signal)

See Also:

Constant Field Values

RETRIES_BEFORE_PARK

public static final int RETRIES_BEFORE_PARK

Retries before waiting for PARK_NANOS_FOR_READ_WRITE (when there is no selector to signal)

See Also:

Constant Field Values

PARK_NANOS_MAX

public static final long PARK_NANOS_MAX

Maximum nanos to park thread to wait for reading/writing data in non-blocking mode (if selector is present then it will explicitly signal)

See Also:

Constant Field Values

HEX_DIGITS

public static char[] HEX_DIGITS

HEX_DIGITS_UCASE

public static char[] HEX_DIGITS_UCASE

currentTimeZone

public static final java.util.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 java.lang.String currentTZShortName

short display name of current timezone in current locale

currentTZShortNameDST

public static final java.lang.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

ALLOW_THREADCONTEXT_CLASSLOADER

public static final java.lang.ThreadLocal ALLOW_THREADCONTEXT_CLASSLOADER

Method Detail

isUsingThrift

public static boolean isUsingThrift(boolean defaultValue)

isThriftDefault

public static boolean isThriftDefault()

setThriftDefault

public static void setThriftDefault(boolean defaultValue)

parseMemorySize

public static long parseMemorySize(java.lang.String v,
                                   long defaultValue,
                                   int defaultShiftMultiplier)

parseBoolean

public static boolean parseBoolean(java.lang.String s)

newWrappedString

public static java.lang.String newWrappedString(char[] chars,
                                                int offset,
                                                int size)

readChars

public static java.lang.String readChars(java.io.InputStream in,
                                         boolean noecho)

getLocalHost

public static java.net.InetAddress getLocalHost()
                                         throws java.net.UnknownHostException

All GemFire code should use this method instead of InetAddress.getLocalHost(). See bug #40623

Throws:

java.net.UnknownHostException

getCachedLocalHost

public static java.net.InetAddress getCachedLocalHost()

preferIPv6Addresses

public static boolean preferIPv6Addresses()

All classes should use this instead of relying on the JRE system property

getAnyMethod

public static java.lang.reflect.Method getAnyMethod(java.lang.Class<?> c,
                                                    java.lang.String name,
                                                    java.lang.Class<?> returnType,
                                                    java.lang.Class<?>... parameterTypes)
                                             throws java.lang.NoSuchMethodException,
                                                    java.lang.SecurityException

Throws:

java.lang.NoSuchMethodException

java.lang.SecurityException

getAnyField

public static java.lang.reflect.Field getAnyField(java.lang.Class<?> c,
                                                  java.lang.String name)
                                           throws java.lang.NoSuchFieldException,
                                                  java.lang.SecurityException

Throws:

java.lang.NoSuchFieldException

java.lang.SecurityException

reverseDNS

public static java.lang.String reverseDNS(java.net.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 java.util.Set<java.net.InetAddress> getMyAddresses(boolean includeLocal)
                                                          throws java.net.SocketException

returns a set of the non-loopback InetAddresses for this machine

Throws:

java.net.SocketException

setKeepAliveOptionsServer

public static void setKeepAliveOptionsServer(java.net.Socket socket,
                                             java.io.InputStream socketStream)
                                      throws java.net.SocketException

Set the keep-alive options on the socket from server-side properties.

Throws:

java.net.SocketException

See Also:

setKeepAliveOptions(java.net.Socket, java.io.InputStream, int, int, int)

setKeepAliveOptions

public static void setKeepAliveOptions(java.net.Socket sock,
                                       java.io.InputStream sockStream,
                                       int keepIdle,
                                       int keepInterval,
                                       int keepCount)
                                throws java.net.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:

java.net.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(java.lang.Throwable t,
                                 java.lang.StringBuilder sb,
                                 java.lang.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

dumpThreadStack

public static void dumpThreadStack(java.lang.management.ThreadInfo tInfo,
                                   java.lang.StringBuilder msg,
                                   java.lang.String lineSeparator)

getZeroLenObjectArray

public static java.lang.Object[] getZeroLenObjectArray()

formatDate

public static void formatDate(long currentTimeInMillis,
                              java.lang.StringBuilder sb)

formatDate

public static void formatDate(long time,
                              int tzOffset,
                              java.lang.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 java.lang.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 java.lang.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 java.lang.String toHexString(java.nio.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(java.nio.ByteBuffer byteBuffer)

toString

public static java.lang.String toString(java.nio.ByteBuffer buffer)

toHexString

public static void toHexString(java.nio.ByteBuffer buffer,
                               java.lang.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(java.lang.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:

java.lang.IllegalArgumentException - if the given string is not a hex-encoded one

setCommonRuntimeException

public static void setCommonRuntimeException(CommonRunTimeException e)

newRuntimeException

public static java.lang.RuntimeException newRuntimeException(java.lang.String message,
                                                             java.lang.Throwable cause)

getProductJarsDirectory

public static java.nio.file.Path getProductJarsDirectory(java.lang.Class<?> c)
                                                  throws java.io.IOException

Throws:

java.io.IOException

convertToJavaLogLevel

public static java.util.logging.Level convertToJavaLogLevel(org.apache.log4j.Level log4jLevel)

convertToLog4LogLevel

public static org.apache.log4j.Level convertToLog4LogLevel(java.lang.String level)
                                                    throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

convertToLog4LogLevel

public static org.apache.log4j.Level convertToLog4LogLevel(java.util.logging.Level level)

initLog4j

public static void initLog4j(java.lang.String logFile,
                             org.apache.log4j.Level level)
                      throws java.io.IOException

Throws:

java.io.IOException

getLog4jLogFile

public static java.lang.String getLog4jLogFile(org.apache.log4j.Logger rootLogger)

Return currently configured log4j log-file or null if file logging is not set.

getLog4jConfProperties

public static java.util.Properties getLog4jConfProperties(java.lang.String snappyHome)
                                                   throws java.io.IOException

Throws:

java.io.IOException

initLog4j

public static void initLog4j(java.lang.String logFile,
                             java.util.Properties userProps,
                             org.apache.log4j.Level level)
                      throws java.io.IOException

Throws:

java.io.IOException

initLogger

public static void initLogger(java.lang.String loggerName,
                              java.lang.String logFile,
                              boolean initLog4j,
                              boolean skipIfInitialized,
                              java.util.logging.Level level,
                              java.util.logging.Handler handler)

setLogger

public static void setLogger(java.util.logging.Logger log)

isLoggerInitialized

public static boolean isLoggerInitialized()

getLogger

public static java.util.logging.Logger getLogger()

getBigIntInternalMagnitude

public static int[] getBigIntInternalMagnitude(java.math.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(java.lang.Object obj,
                                            java.lang.StringBuilder sb)

Get proper string for an an object including arrays with upto one dimension of arrays.

objectString

public static void objectString(java.lang.Object obj,
                                java.lang.StringBuilder sb)

Get proper string for an object including arrays.

toBytes

public static byte[] toBytes(java.nio.ByteBuffer buffer)

toBytes

public static byte[] toBytes(java.nio.ByteBuffer buffer,
                             int bufferSize,
                             int length)

toBytesCopy

public static byte[] toBytesCopy(java.nio.ByteBuffer buffer,
                                 int bufferSize,
                                 int length)

getStatementToken

public static java.lang.String getStatementToken(java.lang.String sql,
                                                 int idx)

Moved from Derby's Statement.getStatementToken to shared between client and server code.

Step past any initial non-significant characters to find first significant SQL token so we can classify statement.

Returns:

first significant SQL token

equalBuffers

public static boolean equalBuffers(byte[] bytes,
                                   java.nio.ByteBuffer buffer)

ensureCapacity

public static java.nio.ByteBuffer ensureCapacity(java.nio.ByteBuffer buffer,
                                                 int newLength,
                                                 boolean useDirectBuffer,
                                                 java.lang.String owner)

Allocate new ByteBuffer if capacity of given ByteBuffer has exceeded. The passed ByteBuffer may no longer be usable after this call.

getUTFLength

public static int getUTFLength(java.lang.String str,
                               int strLen)

isSocketToSameHost

public static boolean isSocketToSameHost(java.nio.channels.Channel channel)

isSocketToSameHost

public static boolean isSocketToSameHost(java.net.SocketAddress localSockAddress,
                                         java.net.SocketAddress remoteSockAddress)

parkThreadForAsyncOperationIfRequired

public static long parkThreadForAsyncOperationIfRequired(StreamChannel channel,
                                                         long parkedNanos,
                                                         int numTries)
                                                  throws java.net.SocketTimeoutException

Throws:

java.net.SocketTimeoutException