com.googlecode.jmxtrans.model

Interface OutputWriter

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

BaseOutputWriter, OutputWriterAdapter, ResultTransformerOutputWriter, StdOutWriter.W

public interface OutputWriter
extends java.lang.AutoCloseable

Interface which defines a writer for taking jmx data and writing it out in whatever format you want. Note that this class uses a feature of Jackson to serialize anything that implements this as a "@class". That way, when Jackson deserializes implementations of this interface, it is done with new objects that implement this interface.

Author:

jon

Method Summary

Modifier and Type	Method and Description
void	close()
void	doWrite(Server server, Query query, java.lang.Iterable<Result> results)
java.util.Map<java.lang.String,java.lang.Object>	getSettings() Deprecated. Don't use the settings Map, please extract necessary bits at construction time.
void	start()
void	validateSetup(Server server, Query query) This is run when the object is instantiated.

Method Detail

start

void start()
    throws LifecycleException

Throws:

LifecycleException

close

void close()
    throws LifecycleException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

LifecycleException

doWrite

void doWrite(Server server,
             Query query,
             java.lang.Iterable<Result> results)
      throws java.lang.Exception

Throws:

java.lang.Exception

getSettings

@Deprecated
java.util.Map<java.lang.String,java.lang.Object> getSettings()

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

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

validateSetup

void validateSetup(Server server,
                   Query query)
            throws ValidationException

This is run when the object is instantiated. You want to get the settings and validate them.

Throws:

ValidationException