nl.teslanet.mule.connectors.coap.api.options

Class OptionUtils

java.lang.Object

nl.teslanet.mule.connectors.coap.api.options.OptionUtils

public class OptionUtils
extends Object

Utilities for handling CoAP options.

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	EMPTY_BYTES Empty byte array.
static String	EMPTY_STRING Empty byte array.

Method Summary

Modifier and Type	Method and Description
static boolean	isCritical(int optionNumber) Checks if option with this number is critical.
static boolean	isNoCacheKey(int optionNumber) Checks if option with this number is a NoCacheKey.
static boolean	isUnsafe(int optionNumber) Checks if option with this number is unsafe.
static byte[]	toBytes(int value) Convert an integer value to byte array.
static byte[]	toBytes(int value, int minLength, int maxLength) Convert an integer value to byte array.
static byte[]	toBytes(long value) Convert a long value to byte array.
static byte[]	toBytes(long value, int minLength, int maxLength) Convert a long value to byte array.
static byte[]	toBytes(String string) Converts a string representation of an option to byte array.
static byte[]	toBytes(String string, int minLength, int maxLength) Converts a string representation of an option to byte array.
static byte[]	toBytesFromHex(String hexString) Converts a hexadecimal representation of an option to byte array.
static byte[]	toBytesFromHex(String hexString, int minLength, int maxLength) Converts a hexadecimal representation of an option to byte array.
static String	toHexString(byte[] bytes) Converts an etag value to a String containing the hexadecimal representation.
static InputStream	toInputStream(byte[] bytes) Warps bytes into an InputStream.
static long	toLong(byte[] bytes) Converts bytes to long.
static String	toString(byte[] bytes) Converts an option value interpreted as UTF-8 string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_BYTES

public static final byte[] EMPTY_BYTES

Empty byte array.

EMPTY_STRING

public static final String EMPTY_STRING

Empty byte array.

See Also:

Constant Field Values

Method Detail

isCritical

public static boolean isCritical(int optionNumber)

Checks if option with this number is critical.

Returns:

true if is option critical

isNoCacheKey

public static boolean isNoCacheKey(int optionNumber)

Checks if option with this number is a NoCacheKey.

Returns:

true if is NoCacheKey

isUnsafe

public static boolean isUnsafe(int optionNumber)

Checks if option with this number is unsafe.

Returns:

true if is unsafe

toBytes

public static byte[] toBytes(int value)

Convert an integer value to byte array. The resulting bits conforming to the CoAP defined uint format for integer option values, where leading zero bytes should be omitted.

Parameters:

value - The integer value to convert.

Returns:

The converted value as bytes.

See Also:

IETF RFC 7252 - 3.2. Option Value Formats

toBytes

public static byte[] toBytes(int value,
                             int minLength,
                             int maxLength)
                      throws OptionValueException

Convert an integer value to byte array. The resulting bits conforming to the CoAP defined uint format for integer option values, where leading zero bytes should be omitted.

Parameters:

value - The integer value to convert.

minLength - The minimum allowed length of the resulting byte array.

maxLength - The maximum allowed length of the resulting byte array.

Returns:

The converted value as bytes.

Throws:

OptionValueException - When value cannot be converted to bytes.

See Also:

IETF RFC 7252 - 3.2. Option Value Formats

toBytes

public static byte[] toBytes(long value)

Convert a long value to byte array. The resulting bits conforming to the CoAP defined uint format for integer option values, where leading zero bytes should be omitted.

Parameters:

value - The long value to convert.

Returns:

The converted value as bytes.

See Also:

IETF RFC 7252 - 3.2. Option Value Formats

toBytes

public static byte[] toBytes(long value,
                             int minLength,
                             int maxLength)
                      throws OptionValueException

Convert a long value to byte array. The resulting bits conforming to the CoAP defined uint format for integer option values, where leading zero bytes should be omitted.

Parameters:

value - The long value to convert.

minLength - The minimum allowed length of the resulting byte array.

maxLength - The maximum allowed length of the resulting byte array.

Returns:

The converted value as bytes.

Throws:

OptionValueException - When value cannot be converted to bytes.

See Also:

IETF RFC 7252 - 3.2. Option Value Formats

toBytes

public static byte[] toBytes(String string)
                      throws OptionValueException

Converts a string representation of an option to byte array. The bytes are written using UTF-8 encoding.

Parameters:

string - The string representing the bytes value.

Returns:

The resulting byte array. When given String is empty the length of the byte array will be zero.

Throws:

OptionValueException - When String does not contain a convertible hexadecimal value or is exceeding maximum length.

toBytes

public static byte[] toBytes(String string,
                             int minLength,
                             int maxLength)
                      throws OptionValueException

Converts a string representation of an option to byte array. The bytes are written using UTF-8 encoding.

Parameters:

string - The string representing the bytes value.

minLength - The minimum allowed length of the resulting byte array.

maxLength - The maximum allowed length of the resulting byte array.

Returns:

The resulting byte array. When given String is empty the length of the byte array will be zero.

Throws:

OptionValueException - When String does not contain a convertible hexadecimal value or is exceeding maximum length.

toBytesFromHex

public static byte[] toBytesFromHex(String hexString)
                             throws OptionValueException

Converts a hexadecimal representation of an option to byte array.

Parameters:

hexString - The string representing the bytes value.

Returns:

The resulting byte array. When given String is empty the length of the byte array will be zero.

Throws:

OptionValueException - When String does not contain a convertible hexadecimal value or is exceeding maximum length.

toBytesFromHex

public static byte[] toBytesFromHex(String hexString,
                                    int minLength,
                                    int maxLength)
                             throws OptionValueException

Converts a hexadecimal representation of an option to byte array.

Parameters:

hexString - The string representing the bytes value.

minLength - The minimum allowed length of the resulting byte array.

maxLength - The maximum allowed length of the resulting byte array.

Returns:

The resulting byte array. When given String is empty the length of the byte array will be zero.

Throws:

OptionValueException - When String does not contain a convertible hexadecimal value or is exceeding maximum length.

toHexString

public static String toHexString(byte[] bytes)

Converts an etag value to a String containing the hexadecimal representation. Hexadecimal values a-f will be lower case.

Parameters:

bytes - The option value.

Returns:

The string containing the hexadecimal representation.

toInputStream

public static InputStream toInputStream(byte[] bytes)

Warps bytes into an InputStream.

Parameters:

bytes - The bytes to expose as inputstream.

Returns:

The inputStream.

toLong

public static long toLong(byte[] bytes)

Converts bytes to long. The size of the array must not exceed Long.BYTES.

Parameters:

bytes - The etag value.

Returns:

The string containing the hexadecimal representation.

toString

public static String toString(byte[] bytes)

Converts an option value interpreted as UTF-8 string.

Parameters:

bytes - The option value.

Returns:

The UTF-8 string interpretation.