com.googlecode.jmxtrans.model.output

Class BaseOutputWriter

java.lang.Object

com.googlecode.jmxtrans.model.output.BaseOutputWriter

All Implemented Interfaces:

OutputWriter

Direct Known Subclasses:

StdOutWriter

@NotThreadSafe
public abstract class BaseOutputWriter
extends Object
implements OutputWriter

Implements the common code for output filters. Note that the use of a non threadsafe @link{Map} makes this class non threadsafe.

Author:

jon

Field Summary

Fields

Modifier and Type	Field and Description
static String	BINARY_PATH
static String	BOOLEAN_AS_NUMBER
static String	DEBUG
static String	HOST
static String	OUTPUT_FILE
static String	PORT
static String	TEMPLATE_FILE
static String	TYPE_NAMES

Constructor Summary

Constructors

Constructor and Description
BaseOutputWriter(com.google.common.collect.ImmutableList<String> typeNames, boolean booleanAsNumber, Boolean debugEnabled, Map<String,Object> settings)

Method Summary

Methods

Modifier and Type	Method and Description
void	doWrite(Server server, Query query, com.google.common.collect.ImmutableList<Result> results)
protected <T> T	firstNonNull(T first, T second, T third)
protected String	getConcatedTypeNameValues(String typeNameStr) Given a typeName string, get the first match from the typeNames setting.
Map<String,Object>	getSettings() Deprecated. Don't use the settings Map, please extract necessary bits at construction time.
List<String>	getTypeNames()
protected abstract void	internalWrite(Server server, Query query, com.google.common.collect.ImmutableList<Result> results)
boolean	isDebugEnabled()
void	setSettings(Map<String,Object> settings) Deprecated. Initialize settings in constructor only please.
void	start() A do nothing method.
void	stop() A do nothing method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.googlecode.jmxtrans.model.OutputWriter

validateSetup

Field Detail

HOST

public static final String HOST

See Also:

Constant Field Values

PORT

public static final String PORT

See Also:

Constant Field Values

OUTPUT_FILE

public static final String OUTPUT_FILE

See Also:

Constant Field Values

TEMPLATE_FILE

public static final String TEMPLATE_FILE

See Also:

Constant Field Values

BINARY_PATH

public static final String BINARY_PATH

See Also:

Constant Field Values

DEBUG

public static final String DEBUG

See Also:

Constant Field Values

TYPE_NAMES

public static final String TYPE_NAMES

See Also:

Constant Field Values

BOOLEAN_AS_NUMBER

public static final String BOOLEAN_AS_NUMBER

See Also:

Constant Field Values

Constructor Detail

BaseOutputWriter

public BaseOutputWriter(com.google.common.collect.ImmutableList<String> typeNames,
                boolean booleanAsNumber,
                Boolean debugEnabled,
                Map<String,Object> settings)

Method Detail

firstNonNull

protected <T> T firstNonNull(@Nullable
                 T first,
                 @Nullable
                 T second,
                 @Nullable
                 T third)

getSettings

@Deprecated
public Map<String,Object> getSettings()

Deprecated. Don't use the settings Map, please extract necessary bits at construction time.

Description copied from interface: OutputWriter

Settings allow you to configure your Writers with whatever they might need.

Specified by:

getSettings in interface OutputWriter

setSettings

@Deprecated
public void setSettings(Map<String,Object> settings)

Deprecated. Initialize settings in constructor only please.

Description copied from interface: OutputWriter

Settings allow you to configure your Writers with whatever they might need.

Specified by:

setSettings in interface OutputWriter

isDebugEnabled

public boolean isDebugEnabled()

getTypeNames

public List<String> getTypeNames()

getConcatedTypeNameValues

protected String getConcatedTypeNameValues(String typeNameStr)

Given a typeName string, get the first match from the typeNames setting. In other words, suppose you have:

typeName=name=PS Eden Space,type=MemoryPool

If you addTypeName("name"), then it'll retrieve 'PS Eden Space' from the string

start

public void start()
           throws LifecycleException

A do nothing method.

Specified by:

start in interface OutputWriter

Throws:

LifecycleException

stop

public void stop()
          throws LifecycleException

A do nothing method.

Specified by:

stop in interface OutputWriter

Throws:

LifecycleException

doWrite

public final void doWrite(Server server,
           Query query,
           com.google.common.collect.ImmutableList<Result> results)
                   throws Exception

Specified by:

doWrite in interface OutputWriter

Throws:

Exception

internalWrite

protected abstract void internalWrite(Server server,
                 Query query,
                 com.google.common.collect.ImmutableList<Result> results)
                               throws Exception

Throws:

Exception