* Example usage: *
* int _10KB = 10 * KB; **/ public static final int KB = 1024; /** * Number of bytes in a Mebibyte. *
* Example usage: *
* int _10MB = 10 * MB; **/ public static final int MB = KB * KB; /** Private constructor to prevent instantiation. */ private StaticUtils() { // No implementation required. } /** * Construct a byte array containing the UTF-8 encoding of the * provided string. This is significantly faster * than calling {@link String#getBytes(String)} for ASCII strings. * * @param s * The string to convert to a UTF-8 byte array. * @return Returns a byte array containing the UTF-8 encoding of the * provided string. */ public static byte[] getBytes(String s) { return com.forgerock.opendj.util.StaticUtils.getBytes(s); } /** * Returns the provided byte array decoded as a UTF-8 string without throwing * an UnsupportedEncodingException. This method is equivalent to: * *
* try
* {
* return new String(bytes, "UTF-8");
* }
* catch (UnsupportedEncodingException e)
* {
* // Should never happen: UTF-8 is always supported.
* throw new RuntimeException(e);
* }
*
*
* @param bytes
* The byte array to be decoded as a UTF-8 string.
* @return The decoded string.
*/
public static String decodeUTF8(final byte[] bytes)
{
Reject.ifNull(bytes);
if (bytes.length == 0)
{
return "".intern();
}
final StringBuilder builder = new StringBuilder(bytes.length);
final int sz = bytes.length;
for (int i = 0; i < sz; i++)
{
final byte b = bytes[i];
if ((b & 0x7f) != b)
{
try
{
builder.append(new String(bytes, i, (sz - i), "UTF-8"));
}
catch (UnsupportedEncodingException e)
{
// Should never happen: UTF-8 is always supported.
throw new RuntimeException(e);
}
break;
}
builder.append((char) b);
}
return builder.toString();
}
/**
* Retrieves a string representation of the provided byte in hexadecimal.
*
* @param b The byte for which to retrieve the hexadecimal string
* representation.
* @return The string representation of the provided byte in hexadecimal.
*/
public static String byteToHex(final byte b)
{
return com.forgerock.opendj.util.StaticUtils.byteToHex(b);
}
/**
* Retrieves a string representation of the provided byte in hexadecimal.
*
* @param b The byte for which to retrieve the hexadecimal string
* representation.
* @return The string representation of the provided byte in hexadecimal
* using lowercase characters.
*/
public static String byteToLowerHex(final byte b)
{
return com.forgerock.opendj.util.StaticUtils.byteToLowerHex(b);
}
/**
* Retrieves a string representation of the contents of the provided byte
* array using hexadecimal characters with no space between each byte.
*
* @param b The byte array containing the data.
*
* @return A string representation of the contents of the provided byte
* array using hexadecimal characters.
*/
public static String bytesToHexNoSpace(byte[] b)
{
if (b == null || b.length == 0)
{
return "";
}
int arrayLength = b.length;
StringBuilder buffer = new StringBuilder(arrayLength * 2);
for (int i=0; i < arrayLength; i++)
{
buffer.append(byteToHex(b[i]));
}
return buffer.toString();
}
/**
* Retrieves a string representation of the contents of the provided byte
* array using hexadecimal characters and a space between each byte.
*
* @param b The byte array containing the data.
* @return A string representation of the contents of the provided byte
* array using hexadecimal characters.
*/
public static String bytesToHex(byte[] b)
{
if (b == null || b.length == 0)
{
return "";
}
int arrayLength = b.length;
StringBuilder buffer = new StringBuilder((arrayLength - 1) * 3 + 2);
buffer.append(byteToHex(b[0]));
for (int i=1; i < arrayLength; i++)
{
buffer.append(" ");
buffer.append(byteToHex(b[i]));
}
return buffer.toString();
}
/**
* Retrieves a string representation of the contents of the provided byte
* sequence using hexadecimal characters and a space between each byte.
*
* @param b The byte sequence containing the data.
* @return A string representation of the contents of the provided byte
* sequence using hexadecimal characters.
*/
public static String bytesToHex(ByteSequence b)
{
if (b == null || b.length() == 0)
{
return "";
}
int arrayLength = b.length();
StringBuilder buffer = new StringBuilder((arrayLength - 1) * 3 + 2);
buffer.append(byteToHex(b.byteAt(0)));
for (int i=1; i < arrayLength; i++)
{
buffer.append(" ");
buffer.append(byteToHex(b.byteAt(i)));
}
return buffer.toString();
}
/**
* Retrieves a string representation of the contents of the provided byte
* array using hexadecimal characters and a colon between each byte.
*
* @param b The byte array containing the data.
*
* @return A string representation of the contents of the provided byte
* array using hexadecimal characters.
*/
public static String bytesToColonDelimitedHex(byte[] b)
{
if (b == null || b.length == 0)
{
return "";
}
int arrayLength = b.length;
StringBuilder buffer = new StringBuilder((arrayLength - 1) * 3 + 2);
buffer.append(byteToHex(b[0]));
for (int i=1; i < arrayLength; i++)
{
buffer.append(":");
buffer.append(byteToHex(b[i]));
}
return buffer.toString();
}
/**
* Retrieves a string representation of the contents of the provided byte
* buffer using hexadecimal characters and a space between each byte.
*
* @param b The byte buffer containing the data.
*
* @return A string representation of the contents of the provided byte
* buffer using hexadecimal characters.
*/
public static String bytesToHex(ByteBuffer b)
{
if (b == null)
{
return "";
}
int position = b.position();
int limit = b.limit();
int length = limit - position;
if (length == 0)
{
return "";
}
StringBuilder buffer = new StringBuilder((length - 1) * 3 + 2);
buffer.append(byteToHex(b.get()));
for (int i=1; i < length; i++)
{
buffer.append(" ");
buffer.append(byteToHex(b.get()));
}
b.position(position);
b.limit(limit);
return buffer.toString();
}
/**
* Appends a string representation of the provided byte array to the given
* buffer using the specified indent. The data will be formatted with sixteen
* hex bytes in a row followed by the ASCII representation, then wrapping to a
* new line as necessary.
*
* @param buffer The buffer to which the information is to be appended.
* @param b The byte array containing the data to write.
* @param indent The number of spaces to indent the output.
*/
public static void byteArrayToHexPlusAscii(StringBuilder buffer, byte[] b,
int indent)
{
StringBuilder indentBuf = new StringBuilder(indent);
for (int i=0 ; i < indent; i++)
{
indentBuf.append(' ');
}
int length = b.length;
int pos = 0;
while (length - pos >= 16)
{
StringBuilder asciiBuf = new StringBuilder(17);
buffer.append(indentBuf);
buffer.append(byteToHex(b[pos]));
asciiBuf.append(byteToASCII(b[pos]));
pos++;
for (int i=1; i < 16; i++, pos++)
{
buffer.append(' ');
buffer.append(byteToHex(b[pos]));
asciiBuf.append(byteToASCII(b[pos]));
if (i == 7)
{
buffer.append(" ");
asciiBuf.append(' ');
}
}
buffer.append(" ");
buffer.append(asciiBuf);
buffer.append(EOL);
}
int remaining = length - pos;
if (remaining > 0)
{
StringBuilder asciiBuf = new StringBuilder(remaining+1);
buffer.append(indentBuf);
buffer.append(byteToHex(b[pos]));
asciiBuf.append(byteToASCII(b[pos]));
pos++;
for (int i=1; i < 16; i++)
{
buffer.append(' ');
if (i < remaining)
{
buffer.append(byteToHex(b[pos]));
asciiBuf.append(byteToASCII(b[pos]));
pos++;
}
else
{
buffer.append(" ");
}
if (i == 7)
{
buffer.append(" ");
if (i < remaining)
{
asciiBuf.append(' ');
}
}
}
buffer.append(" ");
buffer.append(asciiBuf);
buffer.append(EOL);
}
}
private static char byteToASCII(byte b)
{
return com.forgerock.opendj.util.StaticUtils.byteToASCII(b);
}
/**
* Compare two byte arrays for order. Returns a negative integer,
* zero, or a positive integer as the first argument is less than,
* equal to, or greater than the second.
*
* @param a
* The first byte array to be compared.
* @param a2
* The second byte array to be compared.
* @return Returns a negative integer, zero, or a positive integer
* if the first byte array is less than, equal to, or greater
* than the second.
*/
public static int compare(byte[] a, byte[] a2) {
if (a == a2) {
return 0;
}
if (a == null) {
return -1;
}
if (a2 == null) {
return 1;
}
int minLength = Math.min(a.length, a2.length);
for (int i = 0; i < minLength; i++) {
int firstByte = 0xFF & a[i];
int secondByte = 0xFF & a2[i];
if (firstByte != secondByte) {
if (firstByte < secondByte) {
return -1;
} else if (firstByte > secondByte) {
return 1;
}
}
}
return a.length - a2.length;
}
/**
* Retrieves the best human-readable message for the provided exception. For
* exceptions defined in the OpenDJ project, it will attempt to use the
* message (combining it with the message ID if available). For some
* exceptions that use encapsulation (e.g., InvocationTargetException), it
* will be unwrapped and the cause will be treated. For all others, the
*
*
* @param t The {@code Throwable} object for which to retrieve the message.
*
* @return The human-readable message generated for the provided exception.
*/
public static LocalizableMessage getExceptionMessage(Throwable t)
{
if (t instanceof IdentifiedException)
{
IdentifiedException ie = (IdentifiedException) t;
StringBuilder message = new StringBuilder();
message.append(ie.getMessage());
message.append(" (id=");
LocalizableMessage ieMsg = ie.getMessageObject();
if (ieMsg != null) {
message.append(ieMsg.resourceName()).append("-").append(ieMsg.ordinal());
} else {
message.append("-1");
}
message.append(")");
return LocalizableMessage.raw(message.toString());
}
else
{
return com.forgerock.opendj.util.StaticUtils.getExceptionMessage(t);
}
}
/**
* Retrieves a stack trace from the provided exception as a single-line
* string.
*
* @param t The exception for which to retrieve the stack trace.
*
* @return A stack trace from the provided exception as a single-line string.
*/
public static String stackTraceToSingleLineString(Throwable t)
{
return com.forgerock.opendj.util.StaticUtils.stackTraceToSingleLineString(t, DynamicConstants.DEBUG_BUILD);
}
/**
* Retrieves a string representation of the stack trace for the provided
* exception.
*
* @param t The exception for which to retrieve the stack trace.
*
* @return A string representation of the stack trace for the provided
* exception.
*/
public static String stackTraceToString(Throwable t)
{
StringBuilder buffer = new StringBuilder();
stackTraceToString(buffer, t);
return buffer.toString();
}
/**
* Check if the stack trace of provided exception contains a given cause.
*
* @param throwable
* exception that may contain the cause
* @param searchedCause
* class of the cause to look for. Any subclass will match.
* @return true if and only if the given cause is found as a cause of any
* level in the provided exception.
*/
public static boolean stackTraceContainsCause(
Throwable throwable, Class searchedCause)
{
Throwable t = throwable;
while ((t = t.getCause()) != null)
{
if (searchedCause.isAssignableFrom(t.getClass()))
{
return true;
}
}
return false;
}
/**
* Appends a string representation of the stack trace for the provided
* exception to the given buffer.
*
* @param buffer The buffer to which the information is to be appended.
* @param t The exception for which to retrieve the stack trace.
*/
private static void stackTraceToString(StringBuilder buffer, Throwable t)
{
if (t == null)
{
return;
}
buffer.append(t);
for (StackTraceElement e : t.getStackTrace())
{
buffer.append(EOL);
buffer.append(" ");
buffer.append(e.getClassName());
buffer.append(".");
buffer.append(e.getMethodName());
buffer.append("(");
buffer.append(e.getFileName());
buffer.append(":");
buffer.append(e.getLineNumber());
buffer.append(")");
}
while (t.getCause() != null)
{
t = t.getCause();
buffer.append(EOL);
buffer.append("Caused by ");
buffer.append(t);
for (StackTraceElement e : t.getStackTrace())
{
buffer.append(EOL);
buffer.append(" ");
buffer.append(e.getClassName());
buffer.append(".");
buffer.append(e.getMethodName());
buffer.append("(");
buffer.append(e.getFileName());
buffer.append(":");
buffer.append(e.getLineNumber());
buffer.append(")");
}
}
buffer.append(EOL);
}
/**
* Retrieves a backtrace for the current thread consisting only of filenames
* and line numbers that may be useful in debugging the origin of problems
* that should not have happened. Note that this may be an expensive
* operation to perform, so it should only be used for error conditions or
* debugging.
*
* @return A backtrace for the current thread.
*/
public static String getBacktrace()
{
StringBuilder buffer = new StringBuilder();
StackTraceElement[] elements = Thread.currentThread().getStackTrace();
if (elements.length > 1)
{
buffer.append(elements[1].getFileName());
buffer.append(":");
buffer.append(elements[1].getLineNumber());
for (int i=2; i < elements.length; i++)
{
buffer.append(" ");
buffer.append(elements[i].getFileName());
buffer.append(":");
buffer.append(elements[i].getLineNumber());
}
}
return buffer.toString();
}
/**
* Retrieves a backtrace for the provided exception consisting of only
* filenames and line numbers that may be useful in debugging the origin of
* problems. This is less expensive than the call to
* {@code getBacktrace} without any arguments if an exception has already
* been thrown.
*
* @param t The exception for which to obtain the backtrace.
*
* @return A backtrace from the provided exception.
*/
public static String getBacktrace(Throwable t)
{
StringBuilder buffer = new StringBuilder();
StackTraceElement[] elements = t.getStackTrace();
if (elements.length > 0)
{
buffer.append(elements[0].getFileName());
buffer.append(":");
buffer.append(elements[0].getLineNumber());
for (int i=1; i < elements.length; i++)
{
buffer.append(" ");
buffer.append(elements[i].getFileName());
buffer.append(":");
buffer.append(elements[i].getLineNumber());
}
}
return buffer.toString();
}
/**
* Indicates whether the provided character is a numeric digit.
*
* @param c The character for which to make the determination.
*
* @return {@code true} if the provided character represents a numeric
* digit, or {@code false} if not.
*/
public static boolean isDigit(final char c) {
return com.forgerock.opendj.util.StaticUtils.isDigit(c);
}
/**
* Indicates whether the provided character is an ASCII alphabetic character.
*
* @param c The character for which to make the determination.
*
* @return {@code true} if the provided value is an uppercase or
* lowercase ASCII alphabetic character, or {@code false} if it
* is not.
*/
public static boolean isAlpha(final char c) {
return com.forgerock.opendj.util.StaticUtils.isAlpha(c);
}
/**
* Indicates whether the provided character is a hexadecimal digit.
*
* @param c The character for which to make the determination.
*
* @return {@code true} if the provided character represents a
* hexadecimal digit, or {@code false} if not.
*/
public static boolean isHexDigit(final char c) {
return com.forgerock.opendj.util.StaticUtils.isHexDigit(c);
}
/**
* Indicates whether the provided byte represents a hexadecimal digit.
*
* @param b The byte for which to make the determination.
*
* @return {@code true} if the provided byte represents a hexadecimal
* digit, or {@code false} if not.
*/
public static boolean isHexDigit(byte b)
{
switch (b)
{
case '0':
case '1':
case '2':
case '3':
case '4':
case '5':
case '6':
case '7':
case '8':
case '9':
case 'A':
case 'B':
case 'C':
case 'D':
case 'E':
case 'F':
case 'a':
case 'b':
case 'c':
case 'd':
case 'e':
case 'f':
return true;
default:
return false;
}
}
/**
* Converts the provided hexadecimal string to a byte array.
*
* @param hexString The hexadecimal string to convert to a byte array.
*
* @return The byte array containing the binary representation of the
* provided hex string.
*
* @throws ParseException If the provided string contains invalid
* hexadecimal digits or does not contain an even
* number of digits.
*/
public static byte[] hexStringToByteArray(String hexString)
throws ParseException
{
int length;
if (hexString == null || ((length = hexString.length()) == 0))
{
return new byte[0];
}
if ((length % 2) == 1)
{
LocalizableMessage message = ERR_HEX_DECODE_INVALID_LENGTH.get(hexString);
throw new ParseException(message.toString(), 0);
}
int pos = 0;
int arrayLength = length / 2;
byte[] returnArray = new byte[arrayLength];
for (int i=0; i < arrayLength; i++)
{
switch (hexString.charAt(pos++))
{
case '0':
returnArray[i] = 0x00;
break;
case '1':
returnArray[i] = 0x10;
break;
case '2':
returnArray[i] = 0x20;
break;
case '3':
returnArray[i] = 0x30;
break;
case '4':
returnArray[i] = 0x40;
break;
case '5':
returnArray[i] = 0x50;
break;
case '6':
returnArray[i] = 0x60;
break;
case '7':
returnArray[i] = 0x70;
break;
case '8':
returnArray[i] = (byte) 0x80;
break;
case '9':
returnArray[i] = (byte) 0x90;
break;
case 'A':
case 'a':
returnArray[i] = (byte) 0xA0;
break;
case 'B':
case 'b':
returnArray[i] = (byte) 0xB0;
break;
case 'C':
case 'c':
returnArray[i] = (byte) 0xC0;
break;
case 'D':
case 'd':
returnArray[i] = (byte) 0xD0;
break;
case 'E':
case 'e':
returnArray[i] = (byte) 0xE0;
break;
case 'F':
case 'f':
returnArray[i] = (byte) 0xF0;
break;
default:
LocalizableMessage message = ERR_HEX_DECODE_INVALID_CHARACTER.get(
hexString, hexString.charAt(pos-1));
throw new ParseException(message.toString(), 0);
}
switch (hexString.charAt(pos++))
{
case '0':
// No action required.
break;
case '1':
returnArray[i] |= 0x01;
break;
case '2':
returnArray[i] |= 0x02;
break;
case '3':
returnArray[i] |= 0x03;
break;
case '4':
returnArray[i] |= 0x04;
break;
case '5':
returnArray[i] |= 0x05;
break;
case '6':
returnArray[i] |= 0x06;
break;
case '7':
returnArray[i] |= 0x07;
break;
case '8':
returnArray[i] |= 0x08;
break;
case '9':
returnArray[i] |= 0x09;
break;
case 'A':
case 'a':
returnArray[i] |= 0x0A;
break;
case 'B':
case 'b':
returnArray[i] |= 0x0B;
break;
case 'C':
case 'c':
returnArray[i] |= 0x0C;
break;
case 'D':
case 'd':
returnArray[i] |= 0x0D;
break;
case 'E':
case 'e':
returnArray[i] |= 0x0E;
break;
case 'F':
case 'f':
returnArray[i] |= 0x0F;
break;
default:
LocalizableMessage message = ERR_HEX_DECODE_INVALID_CHARACTER.get(
hexString, hexString.charAt(pos-1));
throw new ParseException(message.toString(), 0);
}
}
return returnArray;
}
/**
* Indicates whether the provided value needs to be base64-encoded if it is
* represented in LDIF form.
*
* @param valueBytes The binary representation of the attribute value for
* which to make the determination.
*
* @return {@code true} if the value needs to be base64-encoded if it is
* represented in LDIF form, or {@code false} if not.
*/
public static boolean needsBase64Encoding(ByteSequence valueBytes)
{
int length;
if (valueBytes == null || ((length = valueBytes.length()) == 0))
{
return false;
}
// If the value starts with a space, colon, or less than, then it needs to
// be base64-encoded.
switch (valueBytes.byteAt(0))
{
case 0x20: // Space
case 0x3A: // Colon
case 0x3C: // Less-than
return true;
}
// If the value ends with a space, then it needs to be base64-encoded.
if (length > 1 && valueBytes.byteAt(length - 1) == 0x20)
{
return true;
}
// If the value contains a null, newline, or return character, then it needs
// to be base64-encoded.
byte b;
for (int i = 0; i < valueBytes.length(); i++)
{
b = valueBytes.byteAt(i);
if (b < 0 || 127 < b)
{
return true;
}
switch (b)
{
case 0x00: // Null
case 0x0A: // New line
case 0x0D: // Carriage return
return true;
}
}
// If we've made it here, then there's no reason to base64-encode.
return false;
}
/**
* Indicates whether the provided value needs to be base64-encoded if it is
* represented in LDIF form.
*
* @param valueString The string representation of the attribute value for
* which to make the determination.
*
* @return {@code true} if the value needs to be base64-encoded if it is
* represented in LDIF form, or {@code false} if not.
*/
public static boolean needsBase64Encoding(String valueString)
{
int length;
if (valueString == null || ((length = valueString.length()) == 0))
{
return false;
}
// If the value starts with a space, colon, or less than, then it needs to
// be base64-encoded.
switch (valueString.charAt(0))
{
case ' ':
case ':':
case '<':
return true;
}
// If the value ends with a space, then it needs to be base64-encoded.
if (length > 1 && valueString.charAt(length - 1) == ' ')
{
return true;
}
// If the value contains a null, newline, or return character, then it needs
// to be base64-encoded.
for (int i=0; i < length; i++)
{
char c = valueString.charAt(i);
if (c <= 0 || c == 0x0A || c == 0x0D || c > 127)
{
return true;
}
}
// If we've made it here, then there's no reason to base64-encode.
return false;
}
/**
* Indicates whether the use of the exec method will be allowed on this
* system. It will be allowed by default, but that capability will be removed
* if the org.opends.server.DisableExec system property is set and has any
* value other than "false", "off", "no", or "0".
*
* @return {@code true} if the use of the exec method should be allowed,
* or {@code false} if it should not be allowed.
*/
private static boolean mayUseExec()
{
return !DirectoryServer.getEnvironmentConfig().disableExec();
}
/**
* Indicates whether the provided string contains a name or OID for a schema
* element like an attribute type or objectclass.
*
* @param element The string containing the substring for which to
* make the determination.
* @param startPos The position of the first character that is to be
* checked.
* @param endPos The position of the first character after the start
* position that is not to be checked.
* @param invalidReason The buffer to which the invalid reason is to be
* appended if a problem is found.
*
* @return {@code true} if the provided string contains a valid name or
* OID for a schema element, or {@code false} if it does not.
*/
public static boolean isValidSchemaElement(String element, int startPos,
int endPos,
LocalizableMessageBuilder invalidReason)
{
if (element == null || startPos >= endPos)
{
invalidReason.append(ERR_SCHEMANAME_EMPTY_VALUE.get());
return false;
}
char c = element.charAt(startPos);
if (isAlpha(c))
{
// This can only be a name and not an OID. The only remaining characters
// must be letters, digits, dashes, and possibly the underscore.
for (int i=startPos+1; i < endPos; i++)
{
c = element.charAt(i);
if (!isAlpha(c)
&& !isDigit(c)
&& c != '-'
&& (c != '_' || !DirectoryServer.allowAttributeNameExceptions()))
{
// This is an illegal character for an attribute name.
invalidReason.append(ERR_SCHEMANAME_ILLEGAL_CHAR.get(element, c, i));
return false;
}
}
}
else if (isDigit(c))
{
// This should indicate an OID, but it may also be a name if name
// exceptions are enabled. Since we don't know for sure, we'll just
// hold off until we know for sure.
boolean isKnown = !DirectoryServer.allowAttributeNameExceptions();
boolean isNumeric = true;
boolean lastWasDot = false;
for (int i=startPos+1; i < endPos; i++)
{
c = element.charAt(i);
if (c == '.')
{
if (isKnown)
{
if (isNumeric)
{
// This is probably legal unless the last character was also a
// period.
if (lastWasDot)
{
invalidReason.append(ERR_SCHEMANAME_CONSECUTIVE_PERIODS.get(
element, i));
return false;
}
lastWasDot = true;
}
else
{
// This is an illegal character.
invalidReason.append(ERR_SCHEMANAME_ILLEGAL_CHAR.get(
element, c, i));
return false;
}
}
else
{
// Now we know that this must be a numeric OID and not an attribute
// name with exceptions allowed.
lastWasDot = true;
isKnown = true;
isNumeric = true;
}
}
else
{
lastWasDot = false;
if (isAlpha(c) || c == '-' || c == '_')
{
if (isKnown)
{
if (isNumeric)
{
// This is an illegal character for a numeric OID.
invalidReason.append(ERR_SCHEMANAME_ILLEGAL_CHAR.get(
element, c, i));
return false;
}
}
else
{
// Now we know that this must be an attribute name with exceptions
// allowed and not a numeric OID.
isKnown = true;
isNumeric = false;
}
}
else if (! isDigit(c))
{
// This is an illegal character.
invalidReason.append(ERR_SCHEMANAME_ILLEGAL_CHAR.get(
element, c, i));
return false;
}
}
}
}
else
{
// This is an illegal character.
invalidReason.append(ERR_SCHEMANAME_ILLEGAL_CHAR.get(
element, c, startPos));
return false;
}
// If we've gotten here, then the value is fine.
return true;
}
/**
* Indicates whether the provided TCP address is already in use.
*
* @param address IP address of the TCP address for which to make
* the determination.
* @param port TCP port number of the TCP address for which to
* make the determination.
* @param allowReuse Whether TCP address reuse is allowed when
* making the determination.
*
* @return {@code true} if the provided TCP address is already in
* use, or {@code false} otherwise.
*/
public static boolean isAddressInUse(
InetAddress address, int port,
boolean allowReuse)
{
try {
// HACK:
// With dual stacks we can have a situation when INADDR_ANY/PORT
// is bound in TCP4 space but available in TCP6 space and since
// JavaServerSocket implementation will always use TCP46 on dual
// stacks the bind below will always succeed in such cases thus
// shadowing anything that is already bound to INADDR_ANY/PORT.
// While technically correct, with IPv4 and IPv6 being separate
// address spaces, it presents a problem to end users because a
// common case scenario is to have a single service serving both
// address spaces ie listening to the same port in both spaces
// on wildcard addresses 0 and ::. ServerSocket implementation
// does not provide any means of working with each address space
// separately such as doing TCP4 or TCP6 only binds thus we have
// to do a dummy connect to INADDR_ANY/PORT to check if it is
// bound to something already. This is only needed for wildcard
// addresses as specific IPv4 or IPv6 addresses will always be
// handled in their respective address space.
if (address.isAnyLocalAddress()) {
try (Socket clientSocket = new Socket()) {
// This might fail on some stacks but this is the best we
// can do. No need for explicit timeout since it is local
// address and we have to know for sure unless it fails.
clientSocket.connect(new InetSocketAddress(address, port));
if (clientSocket.isConnected()) {
return true;
}
} catch (IOException ignore) {
// ignore.
}
}
try (ServerSocket serverSocket = new ServerSocket()) {
serverSocket.setReuseAddress(allowReuse);
serverSocket.bind(new InetSocketAddress(address, port));
return false;
}
} catch (IOException ignore) {
// no-op
}
return true;
}
/**
* Returns a lower-case string representation of a given string, verifying for null input string.
*
* @param s the mixed case string
* @return a lower-case string
* @see com.forgerock.opendj.util.StaticUtils#toLowerCase(String)
*/
public static String toLowerCase(String s)
{
return (s == null ? null : com.forgerock.opendj.util.StaticUtils.toLowerCase(s));
}
/**
* Appends a lower-case string representation of a given ByteSequence to a StringBuilder,
* verifying for null input.
*
* @param b The byte array for which to obtain the lowercase string
* representation.
* @param buffer The buffer to which the lowercase form of the string should
* be appended.
* @param trim Indicates whether leading and trailing spaces should be
* omitted from the string representation.
* @see com.forgerock.opendj.util.StaticUtils#toLowerCase(ByteSequence, StringBuilder)}
*/
public static void toLowerCase(ByteSequence b, StringBuilder buffer, boolean trim)
{
if (b == null)
{
return;
}
if (trim)
{
int begin = 0;
int end = b.length() - 1;
while (begin <= end)
{
if (b.byteAt(begin) == ' ')
{
begin++;
}
else if (b.byteAt(end) == ' ')
{
end--;
}
else
{
break;
}
}
if (begin > 0 || end < b.length() - 1)
{
b = b.subSequence(begin, end + 1);
}
}
com.forgerock.opendj.util.StaticUtils.toLowerCase(b, buffer);
}
/**
* Retrieves an uppercase representation of the given string. This
* implementation presumes that the provided string will contain only ASCII
* characters and is optimized for that case. However, if a non-ASCII
* character is encountered it will fall back on a more expensive algorithm
* that will work properly for non-ASCII characters.
*
* @param s The string for which to obtain the uppercase representation.
*
* @return The uppercase representation of the given string.
*/
public static String toUpperCase(String s)
{
if (s == null)
{
return null;
}
StringBuilder buffer = new StringBuilder(s.length());
toUpperCase(s, buffer);
return buffer.toString();
}
/**
* Appends an uppercase representation of the given string to the provided
* buffer. This implementation presumes that the provided string will contain
* only ASCII characters and is optimized for that case. However, if a
* non-ASCII character is encountered it will fall back on a more expensive
* algorithm that will work properly for non-ASCII characters.
*
* @param s The string for which to obtain the uppercase
* representation.
* @param buffer The buffer to which the uppercase form of the string should
* be appended.
*/
private static void toUpperCase(String s, StringBuilder buffer)
{
if (s == null)
{
return;
}
int length = s.length();
for (int i=0; i < length; i++)
{
char c = s.charAt(i);
if ((c & 0x7F) != c)
{
buffer.append(s.substring(i).toUpperCase());
return;
}
switch (c)
{
case 'a':
buffer.append('A');
break;
case 'b':
buffer.append('B');
break;
case 'c':
buffer.append('C');
break;
case 'd':
buffer.append('D');
break;
case 'e':
buffer.append('E');
break;
case 'f':
buffer.append('F');
break;
case 'g':
buffer.append('G');
break;
case 'h':
buffer.append('H');
break;
case 'i':
buffer.append('I');
break;
case 'j':
buffer.append('J');
break;
case 'k':
buffer.append('K');
break;
case 'l':
buffer.append('L');
break;
case 'm':
buffer.append('M');
break;
case 'n':
buffer.append('N');
break;
case 'o':
buffer.append('O');
break;
case 'p':
buffer.append('P');
break;
case 'q':
buffer.append('Q');
break;
case 'r':
buffer.append('R');
break;
case 's':
buffer.append('S');
break;
case 't':
buffer.append('T');
break;
case 'u':
buffer.append('U');
break;
case 'v':
buffer.append('V');
break;
case 'w':
buffer.append('W');
break;
case 'x':
buffer.append('X');
break;
case 'y':
buffer.append('Y');
break;
case 'z':
buffer.append('Z');
break;
default:
buffer.append(c);
}
}
}
/**
* Appends an uppercase string representation of the contents of the given
* byte array to the provided buffer, optionally trimming leading and trailing
* spaces. This implementation presumes that the provided string will contain
* only ASCII characters and is optimized for that case. However, if a
* non-ASCII character is encountered it will fall back on a more expensive
* algorithm that will work properly for non-ASCII characters.
*
* @param b The byte array for which to obtain the uppercase string
* representation.
* @param buffer The buffer to which the uppercase form of the string should
* be appended.
* @param trim Indicates whether leading and trailing spaces should be
* omitted from the string representation.
*/
public static void toUpperCase(byte[] b, StringBuilder buffer, boolean trim)
{
if (b == null)
{
return;
}
int length = b.length;
for (int i=0; i < length; i++)
{
if ((b[i] & 0x7F) != b[i])
{
try
{
buffer.append(new String(b, i, (length-i), "UTF-8").toUpperCase());
}
catch (Exception e)
{
logger.traceException(e);
buffer.append(new String(b, i, (length - i)).toUpperCase());
}
break;
}
int bufferLength = buffer.length();
switch (b[i])
{
case ' ':
// If we don't care about trimming, then we can always append the
// space. Otherwise, only do so if there are other characters in the value.
if (trim && bufferLength == 0)
{
break;
}
buffer.append(' ');
break;
case 'a':
buffer.append('A');
break;
case 'b':
buffer.append('B');
break;
case 'c':
buffer.append('C');
break;
case 'd':
buffer.append('D');
break;
case 'e':
buffer.append('E');
break;
case 'f':
buffer.append('F');
break;
case 'g':
buffer.append('G');
break;
case 'h':
buffer.append('H');
break;
case 'i':
buffer.append('I');
break;
case 'j':
buffer.append('J');
break;
case 'k':
buffer.append('K');
break;
case 'l':
buffer.append('L');
break;
case 'm':
buffer.append('M');
break;
case 'n':
buffer.append('N');
break;
case 'o':
buffer.append('O');
break;
case 'p':
buffer.append('P');
break;
case 'q':
buffer.append('Q');
break;
case 'r':
buffer.append('R');
break;
case 's':
buffer.append('S');
break;
case 't':
buffer.append('T');
break;
case 'u':
buffer.append('U');
break;
case 'v':
buffer.append('V');
break;
case 'w':
buffer.append('W');
break;
case 'x':
buffer.append('X');
break;
case 'y':
buffer.append('Y');
break;
case 'z':
buffer.append('Z');
break;
default:
buffer.append((char) b[i]);
}
}
if (trim)
{
// Strip off any trailing spaces.
for (int i=buffer.length()-1; i > 0; i--)
{
if (buffer.charAt(i) == ' ')
{
buffer.delete(i, i+1);
}
else
{
break;
}
}
}
}
/**
* Append a string to a string builder, escaping any double quotes
* according to the StringValue production in RFC 3641.
* * In RFC 3641 the StringValue production looks like this: * *
* StringValue = dquote *SafeUTF8Character dquote * dquote = %x22 ; " (double quote) * SafeUTF8Character = %x00-21 / %x23-7F / ; ASCII minus dquote * dquote dquote / ; escaped double quote * %xC0-DF %x80-BF / ; 2 byte UTF-8 character * %xE0-EF 2(%x80-BF) / ; 3 byte UTF-8 character * %xF0-F7 3(%x80-BF) ; 4 byte UTF-8 character ** *
* That is, strings are surrounded by double-quotes and any internal
* double-quotes are doubled up.
*
* @param builder
* The string builder.
* @param string
* The string to escape and append.
* @return Returns the string builder.
*/
public static StringBuilder toRFC3641StringValue(StringBuilder builder,
String string)
{
// Initial double-quote.
builder.append('"');
for (char c : string.toCharArray())
{
if (c == '"')
{
// Internal double-quotes are escaped using a double-quote.
builder.append('"');
}
builder.append(c);
}
// Trailing double-quote.
builder.append('"');
return builder;
}
/**
* Retrieves an array list containing the contents of the provided array.
*
* @param stringArray The string array to convert to an array list.
*
* @return An array list containing the contents of the provided array.
*/
public static ArrayList
* Does not handle directories.
*
* @param files
* The files to delete.
* @return {@code true} if deletion is successful for all files, false otherwise
*/
public static boolean deleteFiles(Iterable
* For example, consider a method with this signature:
*
*
* Classical use with for or while loop:
*
*
*
*
*
* Any other single RDN attribute types, or any case in which there are
* multiple RDN attributes, will use the untypedObject objectclass. If the
* RDN includes one or more attributes that are not allowed in the
* untypedObject objectclass, then the extensibleObject class will also be
* added. Note that this method cannot be used to generate an entry
* with an empty or null DN.
*
* @param dn The DN to use for the entry.
*
* @return The entry created with the provided DN.
*/
public static Entry createEntry(DN dn)
{
// If the provided DN was null or empty, then return null because we don't
// support it.
if (dn == null || dn.isRootDN())
{
return null;
}
// Get the information about the RDN attributes.
RDN rdn = dn.rdn();
// If there is only one RDN attribute, then see which objectclass we should use.
ObjectClass structuralClass = DirectoryServer.getSchema().getObjectClass(getObjectClassName(rdn));
// Get the top and untypedObject classes to include in the entry.
LinkedHashMappublic Iterator<String> myIteratorMethod();
*
* for (Iterator<String> it = myIteratorMethod(); it.hasNext();)
* {
* String s = it.next();
* // use it
* }
*
* Iterator<String> it = myIteratorMethod();
* while(it.hasNext();)
* {
* String s = it.next();
* // use it
* }
*
*
* Improved use with foreach:
*
*
* for (String s : StaticUtils.toIterable(myIteratorMethod()))
* {
* }
*
*
*