org.hawkular.agent.monitor.util

Class Util

java.lang.Object

org.hawkular.agent.monitor.util.Util

public class Util
extends Object

Just some basic utilities.

Author:

John Mazzitelli

Constructor Summary

Constructors

Constructor and Description
Util()

Method Summary

Modifier and Type	Method and Description
static String	base64Encode(String plainTextString) Encodes a string using Base64 encoding.
static long	copyStream(InputStream input, OutputStream output, boolean closeStreams) Copies one stream to another, optionally closing the streams.
static void	ensureEndsWithSlash(StringBuilder str) Given a string builder, this ensures its last character is a forward-slash.
static <T> T	fromJson(Reader in, com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
static <T> T	fromJson(String json, Class<T> clazz)
static StringBuilder	getContextUrlString(String baseUrl, String context) Given a base URL (like 'http://localhost:8080') this will append the given context string to it and will return the URL with a forward-slash as its last character.
static MonitorServiceConfiguration	getMonitorServiceConfiguration(org.jboss.as.controller.OperationContext context) Used by extension classes that need to get the subsystem's configuration.
static String	getSystemId() Tries to determine the system ID for the machine where this JVM is located.
static String	read(File file) Read the content of the given file using ENCODING_UTF_8 and return it as a String.
static void	registerOnlyRestartAttributes(org.jboss.as.controller.registry.ManagementResourceRegistration resourceRegistration, Collection<org.jboss.as.controller.AttributeDefinition> allAttributes) This will register only those given attributes that require a restart.
static String	slurpStream(InputStream input, String encoding) Given an input stream, its data will be slurped in memory and returned as a String.
static String	toJson(Object obj)
static String	urlEncode(String str) Encodes the given string so it can be placed inside a URL.
static String	urlEncodeQuery(String str) Encodes the given string so it can be placed inside a URL.
static void	write(String string, File file) Stores string to file using ENCODING_UTF_8.

Methods inherited from class java.lang.Object

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

Constructor Detail

Util

public Util()

Method Detail

toJson

public static String toJson(Object obj)

fromJson

public static <T> T fromJson(String json,
                             Class<T> clazz)

fromJson

public static <T> T fromJson(Reader in,
                             com.fasterxml.jackson.core.type.TypeReference<T> typeReference)

urlEncode

public static String urlEncode(String str)

Encodes the given string so it can be placed inside a URL. This should not be the query part of the URL, for that use urlEncodeQuery(String).

Parameters:

str - non-query string to encode

Returns:

encoded string that can be placed inside a URL

urlEncodeQuery

public static String urlEncodeQuery(String str)

Encodes the given string so it can be placed inside a URL. This should oly be used for the query part of the URL, for other parts, like path, use urlEncode(String).

Parameters:

str - non-query string to encode

Returns:

encoded string that can be placed inside a URL

getContextUrlString

public static StringBuilder getContextUrlString(String baseUrl,
                                                String context)
                                         throws MalformedURLException

Given a base URL (like 'http://localhost:8080') this will append the given context string to it and will return the URL with a forward-slash as its last character. This returns a StringBuilder so the caller can continue building its desired URL by appending to it additional context paths, query strings, and the like.

Parameters:

baseUrl - base URL to append the given context to

context - the context to add to the given base URL

Returns:

the base URL with the context appended to it

Throws:

MalformedURLException - if URL cannot be built

ensureEndsWithSlash

public static void ensureEndsWithSlash(StringBuilder str)

Given a string builder, this ensures its last character is a forward-slash.

Parameters:

str - string builder to have a forward-slash character as its last when this method returns

copyStream

public static long copyStream(InputStream input,
                              OutputStream output,
                              boolean closeStreams)
                       throws RuntimeException

Copies one stream to another, optionally closing the streams.

Parameters:

input - the data to copy

output - where to copy the data

closeStreams - if true input and output will be closed when the method returns

Returns:

the number of bytes copied

Throws:

RuntimeException - if the copy failed

slurpStream

public static String slurpStream(InputStream input,
                                 String encoding)
                          throws IOException

Given an input stream, its data will be slurped in memory and returned as a String. The input stream will be closed when this method returns. WARNING: do not slurp large streams to avoid out-of-memory errors.

Parameters:

input - the input stream to slup

the - encoding to use when reading from input

Returns:

the input stream data as a String

Throws:

IOException - in IO problems

read

public static String read(File file)
                   throws IOException

Read the content of the given file using ENCODING_UTF_8 and return it as a String.

Parameters:

file - the File to read from

Returns:

the content of the given file

Throws:

IOException - in IO problems

write

public static void write(String string,
                         File file)
                  throws IOException

Stores string to file using ENCODING_UTF_8.

Parameters:

string - the String to store

file - the file to store to

Throws:

IOException - on IO errors

base64Encode

public static String base64Encode(String plainTextString)

Encodes a string using Base64 encoding.

Parameters:

plainTextString - the string to encode

Returns:

the given string as a Base64 encoded string.

registerOnlyRestartAttributes

public static void registerOnlyRestartAttributes(org.jboss.as.controller.registry.ManagementResourceRegistration resourceRegistration,
                                                 Collection<org.jboss.as.controller.AttributeDefinition> allAttributes)

This will register only those given attributes that require a restart. Other attributes are left unregistered. It is the caller's responsibility to register those other attributes. Typically those other attributes support changing the service at runtime immediately when the attribute is changed (rather than requiring to restart the server to pick up the change).

Parameters:

resourceRegistration - there the restart attributes will be registered

allAttributes - a collection of attributes where some, all, or none will require a restart upon change.

getMonitorServiceConfiguration

public static MonitorServiceConfiguration getMonitorServiceConfiguration(org.jboss.as.controller.OperationContext context)
                                                                  throws org.jboss.as.controller.OperationFailedException

Used by extension classes that need to get the subsystem's configuration.

Parameters:

context - context used to obtain the config

Returns:

the subsystem config

Throws:

org.jboss.as.controller.OperationFailedException

getSystemId

public static String getSystemId()

Tries to determine the system ID for the machine where this JVM is located.

Returns:

system ID or null if cannot determine