Tyrus 2.2.0 · org.glassfish.tyrus.core.Utils · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public abstract static class	Utils.Stringifier< type for which is conversion defined. T> Define to `String` conversion for various types.

Modifier and Type	Field and Description
private static final List<String>	FILTERED_HEADERS
private static final Logger	LOGGER

Access	Constructor and Description
public	Utils()

Method Summary

Modifier and Type	Method and Description
public static ByteBuffer	Returns: concatenation. appendBuffers(ByteBuffer first buffer. buffer, ByteBuffer second buffer. buffer1, int incoming buffer size. Concatenation length cannot be bigger than this value. incomingBufferSize, int buffer step size. BUFFER_STEP_SIZE) Concatenates two buffers into one.
private static void	appendHeader(StringBuilder message, String key, String value)
private static void	appendHeaders(StringBuilder message, Map<String, List<String>> headers)
public static < object type. T> void	checkNotNull(T object to check. reference, String name of parameter to be formatted into localized message of thrown `IllegalArgumentException`. parameterName) Check for null.
public static < item type. T> String	Returns: single `String` containing all items from provided list. getHeaderFromList(List<T> to be serialized. list) Creates single `String` value from provided List by calling `Object#toString()` on each item and separating existing ones with `", "`.
public static < type to be converted. T> String	Returns: serialized list. getHeaderFromList(List<T> list of values. list, Utils.Stringifier<T> strignifier used for conversion. When `null`, `Object#toString()` method will be used. stringifier) Convert list of values to singe `String` usable as HTTP header value.
public static < type of value to be retrieved. T> T	Returns: typed value or `null` if property is not set or value is not assignable. getProperty(Map<String, Object> property map. properties, String key of value to be retrieved. key, Class<T> type of value to be retrieved. type) Get typed property from generic property map.
public static < type of value to be retrieved. T> T	Returns: typed value or `null` if property is not set or value is not assignable. getProperty(final Map<String, Object> property map. properties, final String key of value to be retrieved. key, final Class<T> type of value to be retrieved. type, final T value returned when record does not exist in supplied map. defaultValue) Get typed property from generic property map.
public static byte[]	Returns: array of bytes containing the bytes from the position to the limit of the `ByteBuffer`. getRemainingArray(ByteBuffer where the bytes are taken from. buffer) Creates the array of bytes containing the bytes from the position to the limit of the `ByteBuffer`.
public static < type to be converted. T> List<String>	Returns: converted list. getStringList(List<T> list to be converted. list, Utils.Stringifier<T> strignifier used for conversion. When `null`, `Object#toString()` method will be used. stringifier) Get list of strings from List<T>.
public static int	Returns: port number which should be used for creating connections/etc. getWsPort(URI provided uri. uri) Get port from provided `URI`.
public static int	Returns: port number which should be used for creating connections/etc. getWsPort(URI provided uri. uri, String scheme to be used when checking for `"ws"` and `"wss"`. scheme) Get port from provided `URI`.
public static List<String>	Returns: split list of values. parseHeaderValue(String string containing header values. headerValue) Parse header value - splits multiple values (quoted, unquoted) separated by comma.
public static Date	Returns: A `Date` parsed from the string. parseHttpDate(String String value to be parsed. stringValue) Parse HTTP date.
public static String	Returns: stringified upgrade request. stringifyUpgradeRequest(UpgradeRequest upgrade request to be formatted. upgradeRequest) Converts upgrade request to a HTTP-formatted string.
public static String	Returns: stringified upgrade request. stringifyUpgradeResponse(UpgradeResponse upgrade request to be formatted. upgradeResponse) Converts upgrade response to a HTTP-formatted string.
public static byte[]	Returns: converted value. toArray(long to be converted. value) Convert `long` to `byte[]`.
public static long	Returns: converted value. toLong(byte[] to be converted. bytes, int start index. start, int end index. end) Convert `byte[]` to `long`.
public static List<String>	toString(byte[] bytes)
public static List<String>	toString(byte[] bytes, int start, int end)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

FILTERED_HEADERS	back to summary
private static final List<String> FILTERED_HEADERS

LOGGER	back to summary
private static final Logger LOGGER

Utils	back to summary
public Utils()

Method Detail

appendBuffers	back to summary
public static ByteBuffer appendBuffers(ByteBuffer buffer, ByteBuffer buffer1, int incomingBufferSize, int BUFFER_STEP_SIZE) Concatenates two buffers into one. If buffer given as first argument has enough space for putting the other one, it will be done and the original buffer will be returned. Otherwise new buffer will be created. Parameters buffer:ByteBuffer first buffer. buffer1:ByteBuffer second buffer. incomingBufferSize:int incoming buffer size. Concatenation length cannot be bigger than this value. BUFFER_STEP_SIZE:int buffer step size. Returns:ByteBuffer concatenation. Exceptions IllegalArgumentException: when the concatenation length is bigger than provided incoming buffer size.

appendBuffers

back to summary

public static ByteBuffer appendBuffers(ByteBuffer buffer, ByteBuffer buffer1, int incomingBufferSize, int BUFFER_STEP_SIZE)

Concatenates two buffers into one. If buffer given as first argument has enough space for putting the other one, it will be done and the original buffer will be returned. Otherwise new buffer will be created.

Parameters

buffer:ByteBuffer: first buffer.
buffer1:ByteBuffer: second buffer.
incomingBufferSize:int: incoming buffer size. Concatenation length cannot be bigger than this value.
BUFFER_STEP_SIZE:int: buffer step size.

Returns:ByteBuffer

concatenation.

Exceptions

IllegalArgumentException:: when the concatenation length is bigger than provided incoming buffer size.

appendHeader	back to summary
private static void appendHeader(StringBuilder message, String key, String value)

appendHeaders	back to summary
private static void appendHeaders(StringBuilder message, Map<String, List<String>> headers)

checkNotNull back to summary

checkNotNull	back to summary
public static <T> void checkNotNull(T reference, String parameterName) Check for null. Throws `IllegalArgumentException` if provided value is null. Parameters <T> object type. reference:T object to check. parameterName:String name of parameter to be formatted into localized message of thrown `IllegalArgumentException`.

public static <T> void checkNotNull(T reference, String parameterName)

Check for null. Throws IllegalArgumentException if provided value is null.

Parameters

<T>: object type.
reference:T: object to check.
parameterName:String: name of parameter to be formatted into localized message of thrown IllegalArgumentException.

getHeaderFromList back to summary

getHeaderFromList	back to summary
public static <T> String getHeaderFromList(List<T> list) Creates single `String` value from provided List by calling `Object#toString()` on each item and separating existing ones with `", "`. Parameters <T> item type. list:List<T> to be serialized. Returns:String single `String` containing all items from provided list.

public static <T> String getHeaderFromList(List<T> list)

Creates single String value from provided List by calling Object#toString() on each item and separating existing ones with ", ".

Parameters

<T>: item type.
list:List<T>: to be serialized.

Returns:String

single String containing all items from provided list.

getHeaderFromList back to summary

getHeaderFromList	back to summary
public static <T> String getHeaderFromList(List<T> list, Utils.Stringifier<T> stringifier) Convert list of values to singe `String` usable as HTTP header value. Parameters <T> type to be converted. list:List<T> list of values. stringifier:Utils.Stringifier<T> strignifier used for conversion. When `null`, `Object#toString()` method will be used. Returns:String serialized list.

public static <T> String getHeaderFromList(List<T> list, Utils.Stringifier<T> stringifier)

Convert list of values to singe String usable as HTTP header value.

Parameters

<T>: type to be converted.
list:List<T>: list of values.
stringifier:Utils.Stringifier<T>: strignifier used for conversion. When null, Object#toString() method will be used.

Returns:String

serialized list.

getProperty back to summary

getProperty	back to summary
public static <T> T getProperty(Map<String, Object> properties, String key, Class<T> type) Get typed property from generic property map. Parameters <T> type of value to be retrieved. properties:Map<String, Object> property map. key:String key of value to be retrieved. type:Class<T> type of value to be retrieved. Returns:T typed value or `null` if property is not set or value is not assignable.

public static <T> T getProperty(Map<String, Object> properties, String key, Class<T> type)

Get typed property from generic property map.

Parameters

<T>: type of value to be retrieved.
properties:Map<String, Object>: property map.
key:String: key of value to be retrieved.
type:Class<T>: type of value to be retrieved.

Returns:T

typed value or null if property is not set or value is not assignable.

getProperty back to summary

getProperty	back to summary
public static <T> T getProperty(final Map<String, Object> properties, final String key, final Class<T> type, final T defaultValue) Get typed property from generic property map. Parameters <T> type of value to be retrieved. properties:Map<String, Object> property map. key:String key of value to be retrieved. type:Class<T> type of value to be retrieved. defaultValue:T value returned when record does not exist in supplied map. Returns:T typed value or `null` if property is not set or value is not assignable. Annotations @SuppressWarnings:unchecked

public static <T> T getProperty(final Map<String, Object> properties, final String key, final Class<T> type, final T defaultValue)

Get typed property from generic property map.

Parameters

<T>: type of value to be retrieved.
properties:Map<String, Object>: property map.
key:String: key of value to be retrieved.
type:Class<T>: type of value to be retrieved.
defaultValue:T: value returned when record does not exist in supplied map.

Returns:T

typed value or null if property is not set or value is not assignable.

Annotations

@SuppressWarnings:unchecked

getRemainingArray back to summary

getRemainingArray	back to summary
public static byte[] getRemainingArray(ByteBuffer buffer) Creates the array of bytes containing the bytes from the position to the limit of the `ByteBuffer`. Parameters buffer:ByteBuffer where the bytes are taken from. Returns:byte[] array of bytes containing the bytes from the position to the limit of the `ByteBuffer`.

public static byte[] getRemainingArray(ByteBuffer buffer)

Creates the array of bytes containing the bytes from the position to the limit of the ByteBuffer.

Parameters

buffer:ByteBuffer: where the bytes are taken from.

Returns:byte[]

array of bytes containing the bytes from the position to the limit of the ByteBuffer.

getStringList back to summary

getStringList	back to summary
public static <T> List<String> getStringList(List<T> list, Utils.Stringifier<T> stringifier) Get list of strings from List<T>. Parameters <T> type to be converted. list:List<T> list to be converted. stringifier:Utils.Stringifier<T> strignifier used for conversion. When `null`, `Object#toString()` method will be used. Returns:List<String> converted list.

public static <T> List<String> getStringList(List<T> list, Utils.Stringifier<T> stringifier)

Get list of strings from List<T>.

Parameters

<T>: type to be converted.
list:List<T>: list to be converted.
stringifier:Utils.Stringifier<T>: strignifier used for conversion. When null, Object#toString() method will be used.

Returns:List<String>

converted list.

getWsPort back to summary

getWsPort	back to summary
public static int getWsPort(URI uri) Get port from provided `URI`. Expected schemes are `"ws"` and `"wss"` and this method will return `80` or `443` when the port is not explicitly set in the provided `URI`. Parameters uri:URI provided uri. Returns:int port number which should be used for creating connections/etc.

public static int getWsPort(URI uri)

Get port from provided URI.

Expected schemes are "ws" and "wss" and this method will return 80 or 443 when the port is not explicitly set in the provided URI.

Parameters

uri:URI: provided uri.

Returns:int

port number which should be used for creating connections/etc.

getWsPort back to summary

getWsPort	back to summary
public static int getWsPort(URI uri, String scheme) Get port from provided `URI`. Expected schemes are `"ws"` and `"wss"` and this method will return `80` or `443` when the port is not explicitly set in the provided `URI`. Parameters uri:URI provided uri. scheme:String scheme to be used when checking for `"ws"` and `"wss"`. Returns:int port number which should be used for creating connections/etc.

public static int getWsPort(URI uri, String scheme)

Get port from provided URI.

Expected schemes are "ws" and "wss" and this method will return 80 or 443 when the port is not explicitly set in the provided URI.

Parameters

uri:URI: provided uri.
scheme:String: scheme to be used when checking for "ws" and "wss".

Returns:int

port number which should be used for creating connections/etc.

parseHeaderValue	back to summary
public static List<String> parseHeaderValue(String headerValue) Parse header value - splits multiple values (quoted, unquoted) separated by comma. Parameters headerValue:String string containing header values. Returns:List<String> split list of values.

parseHeaderValue

back to summary

public static List<String> parseHeaderValue(String headerValue)

Parse header value - splits multiple values (quoted, unquoted) separated by comma.

Parameters

headerValue:String: string containing header values.

Returns:List<String>

split list of values.

parseHttpDate back to summary

parseHttpDate	back to summary
public static Date parseHttpDate(String stringValue) throws ParseException Parse HTTP date. HTTP applications have historically allowed three different formats for the representation of date/time stamps: `Sun, 06 Nov 1994 08:49:37 GMT` (RFC 822, updated by RFC 1123) `Sunday, 06-Nov-94 08:49:37 GMT` (RFC 850, obsoleted by RFC 1036) `Sun Nov 6 08:49:37 1994` (ANSI C's asctime() format) Parameters stringValue:String String value to be parsed. Returns:Date A `Date` parsed from the string. Exceptions ParseException: if the specified string cannot be parsed in neither of all three HTTP date formats.

public static Date parseHttpDate(String stringValue) throws ParseException

Parse HTTP date.

HTTP applications have historically allowed three different formats for the representation of date/time stamps:

Sun, 06 Nov 1994 08:49:37 GMT (RFC 822, updated by RFC 1123)
Sunday, 06-Nov-94 08:49:37 GMT (RFC 850, obsoleted by RFC 1036)
Sun Nov 6 08:49:37 1994 (ANSI C's asctime() format)

Parameters

stringValue:String: String value to be parsed.

Returns:Date

A Date parsed from the string.

Exceptions

ParseException:: if the specified string cannot be parsed in neither of all three HTTP date formats.

stringifyUpgradeRequest	back to summary
public static String stringifyUpgradeRequest(UpgradeRequest upgradeRequest) Converts upgrade request to a HTTP-formatted string. Parameters upgradeRequest:UpgradeRequest upgrade request to be formatted. Returns:String stringified upgrade request.

stringifyUpgradeRequest

back to summary

public static String stringifyUpgradeRequest(UpgradeRequest upgradeRequest)

Converts upgrade request to a HTTP-formatted string.

Parameters

upgradeRequest:UpgradeRequest: upgrade request to be formatted.

Returns:String

stringified upgrade request.

stringifyUpgradeResponse	back to summary
public static String stringifyUpgradeResponse(UpgradeResponse upgradeResponse) Converts upgrade response to a HTTP-formatted string. Parameters upgradeResponse:UpgradeResponse upgrade request to be formatted. Returns:String stringified upgrade request.

stringifyUpgradeResponse

back to summary

public static String stringifyUpgradeResponse(UpgradeResponse upgradeResponse)

Converts upgrade response to a HTTP-formatted string.

Parameters

upgradeResponse:UpgradeResponse: upgrade request to be formatted.

Returns:String

stringified upgrade request.

toArray back to summary

toArray	back to summary
public static byte[] toArray(long value) Convert `long` to `byte[]`. Parameters value:long to be converted. Returns:byte[] converted value.

public static byte[] toArray(long value)

Convert long to byte[].

Parameters

value:long: to be converted.

Returns:byte[]

converted value.

toLong back to summary

toLong	back to summary
public static long toLong(byte[] bytes, int start, int end) Convert `byte[]` to `long`. Parameters bytes:byte[] to be converted. start:int start index. end:int end index. Returns:long converted value.

public static long toLong(byte[] bytes, int start, int end)

Convert byte[] to long.

Parameters

bytes:byte[]: to be converted.
start:int: start index.
end:int: end index.

Returns:long

converted value.

toString	back to summary
public static List<String> toString(byte[] bytes)

toString	back to summary
public static List<String> toString(byte[] bytes, int start, int end)

public Class Utils

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class Utils.Stringifier<T>

Constructor Summary

Method Summary

Constructor Detail

Method Detail