AbstractOutputWriter (embedded-jmxtrans 1.1.3 API)

java.lang.Object
- org.jmxtrans.embedded.output.AbstractOutputWriter

All Implemented Interfaces:

OutputWriter

Direct Known Subclasses:

ConsoleWriter, CopperEggWriter, CsvWriter, GraphiteHttpWriter, GraphitePickleWriter, GraphiteWriter, LibratoWriter, NoOpWriter, Slf4jWriter, StackdriverWriter, StatsDWriter
```
public abstract class AbstractOutputWriter
extends Object
implements OutputWriter
```
Convenience abstract class to implement an OutputWriter.

Author:

Cyrille Le Clerc, Patrick Brühlmann

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.slf4j.Logger`	`logger`
`static String`	`SETTING_HOST`
`static String`	`SETTING_NAME_PREFIX`
`static String`	`SETTING_PORT`
`static String`	`SETTING_PROTOCOL`
`static String`	`SETTING_PROXY_HOST`
`static String`	`SETTING_PROXY_PORT`
`static String`	`SETTING_SOCKET_FACTORY`
`static String`	`SETTING_TLS_INSECURE`
`static String`	`SETTING_TLS_KEY_STORE`
`static String`	`SETTING_TLS_KEY_STORE_PASSWORD`
`static String`	`SETTING_TLS_TRUST_STORE`
`static String`	`SETTING_TLS_TRUST_STORE_PASSWORD`
`static String`	`SETTING_TOKEN`
`static String`	`SETTING_URL`
`static String`	`SETTING_USE_TLS`
`static String`	`SETTING_USERNAME`

Constructor Summary

Constructors
Constructor and Description

AbstractOutputWriter()

Constructors
Constructor and Description
`AbstractOutputWriter()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`protected boolean`	`getBooleanSetting(String name, boolean defaultValue)` Convert value of this setting to a Java boolean (via `Boolean.parseBoolean(String)`).
`protected int`	`getIntSetting(String name)` Convert value of this setting to a Java int.
`protected int`	`getIntSetting(String name, int defaultValue)` Convert value of this setting to a Java int.
`protected long`	`getLongSetting(String name, long defaultValue)` Convert value of this setting to a Java long.
`Map<String,Object>`	`getSettings()` Configuration settings of the OutputWriter.
`ResultNameStrategy`	`getStrategy()`
`protected String`	`getStringSetting(String name)` Convert value of this setting to a Java int.
`protected String`	`getStringSetting(String name, String defaultValue)` Return the value of the given property.
`int`	`hashCode()`
`boolean`	`isEnabled()`
`void`	`setEnabled(boolean enabled)`
`void`	`setSettings(Map<String,Object> settings)` Sets the configuration setting of the OutputWriter.
`void`	`setStrategy(ResultNameStrategy strategy)`
`void`	`start()` No-op implementation
`void`	`stop()` No-op implementation
`String`	`toString()`
`abstract void`	`write(Iterable<QueryResult> results)` Write all the given QueryResult to the target system.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SETTING_URL
```
public static final String SETTING_URL
```
    See Also:
    
    Constant Field Values
  - SETTING_USERNAME
```
public static final String SETTING_USERNAME
```
    See Also:
    
    Constant Field Values
  - SETTING_TOKEN
```
public static final String SETTING_TOKEN
```
    See Also:
    
    Constant Field Values
  - SETTING_PORT
```
public static final String SETTING_PORT
```
    See Also:
    
    Constant Field Values
  - SETTING_HOST
```
public static final String SETTING_HOST
```
    See Also:
    
    Constant Field Values
  - SETTING_SOCKET_FACTORY
```
public static final String SETTING_SOCKET_FACTORY
```
    See Also:
    
    Constant Field Values
  - SETTING_USE_TLS
```
public static final String SETTING_USE_TLS
```
    See Also:
    
    Constant Field Values
  - SETTING_TLS_INSECURE
```
public static final String SETTING_TLS_INSECURE
```
    See Also:
    
    Constant Field Values
  - SETTING_TLS_TRUST_STORE
```
public static final String SETTING_TLS_TRUST_STORE
```
    See Also:
    
    Constant Field Values
  - SETTING_TLS_TRUST_STORE_PASSWORD
```
public static final String SETTING_TLS_TRUST_STORE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - SETTING_TLS_KEY_STORE
```
public static final String SETTING_TLS_KEY_STORE
```
    See Also:
    
    Constant Field Values
  - SETTING_TLS_KEY_STORE_PASSWORD
```
public static final String SETTING_TLS_KEY_STORE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - SETTING_PROXY_PORT
```
public static final String SETTING_PROXY_PORT
```
    See Also:
    
    Constant Field Values
  - SETTING_PROXY_HOST
```
public static final String SETTING_PROXY_HOST
```
    See Also:
    
    Constant Field Values
  - SETTING_NAME_PREFIX
```
public static final String SETTING_NAME_PREFIX
```
    See Also:
    
    Constant Field Values
  - SETTING_PROTOCOL
```
public static final String SETTING_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - logger
```
protected final org.slf4j.Logger logger
```
- Constructor Detail
  - AbstractOutputWriter
```
public AbstractOutputWriter()
```
- Method Detail
  - start
```
public void start()
```
    No-op implementation
    
    Specified by:
    
    start in interface OutputWriter
  - stop
```
public void stop()
          throws Exception
```
    No-op implementation
    
    Specified by:
    
    stop in interface OutputWriter
    
    Throws:
    
    Exception
  - getIntSetting
```
protected int getIntSetting(String name)
                     throws IllegalArgumentException
```
    Convert value of this setting to a Java int. If the setting is not found or is not an int, an exception is thrown.
    
    Parameters:
    
    name - name of the setting / property
    
    Returns:
    
    int value of the setting / property
    
    Throws:
    
    IllegalArgumentException - if setting is not found or is not an integer.
  - getIntSetting
```
protected int getIntSetting(String name,
                            int defaultValue)
                     throws IllegalArgumentException
```
    Convert value of this setting to a Java int. If the property is not found, the defaultValue is returned. If the property is not an int, an exception is thrown.
    
    Parameters:
    
    name - name of the property
    
    defaultValue - default value if the property is not defined.
    
    Returns:
    
    int value of the property or defaultValue if the property is not defined.
    
    Throws:
    
    IllegalArgumentException - if setting is not is not an integer.
  - getLongSetting
```
protected long getLongSetting(String name,
                              long defaultValue)
                       throws IllegalArgumentException
```
    Convert value of this setting to a Java long. If the property is not found, the defaultValue is returned. If the property is not a long, an exception is thrown.
    
    Parameters:
    
    name - name of the property
    
    defaultValue - default value if the property is not defined.
    
    Returns:
    
    int value of the property or defaultValue if the property is not defined.
    
    Throws:
    
    IllegalArgumentException - if setting is not is not a long.
  - getBooleanSetting
```
protected boolean getBooleanSetting(String name,
                                    boolean defaultValue)
```
    Convert value of this setting to a Java boolean (via Boolean.parseBoolean(String)). If the property is not found, the defaultValue is returned.
    
    Parameters:
    
    name - name of the property
    
    defaultValue - default value if the property is not defined.
    
    Returns:
    
    int value of the property or defaultValue if the property is not defined.
  - getStringSetting
```
protected String getStringSetting(String name)
                           throws IllegalArgumentException
```
    Convert value of this setting to a Java int. If the setting is not found, an exception is thrown.
    
    Parameters:
    
    name - name of the property
    
    Returns:
    
    value of the property
    
    Throws:
    
    IllegalArgumentException - if setting is not found.
  - getStringSetting
```
protected String getStringSetting(String name,
                                  String defaultValue)
```
    Return the value of the given property. If the property is not found, the defaultValue is returned.
    
    Parameters:
    
    name - name of the property
    
    defaultValue - default value if the property is not defined.
    
    Returns:
    
    value of the property or defaultValue if the property is not defined.
  - write
```
public abstract void write(Iterable<QueryResult> results)
```
    Description copied from interface: OutputWriter
    
    Write all the given QueryResult to the target system.
    
    Specified by:
    
    write in interface OutputWriter
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getSettings
```
public Map<String,Object> getSettings()
```
    Description copied from interface: OutputWriter
    
    Configuration settings of the OutputWriter.
    
    Specified by:
    
    getSettings in interface OutputWriter
  - setSettings
```
public void setSettings(Map<String,Object> settings)
```
    Description copied from interface: OutputWriter
    
    Sets the configuration setting of the OutputWriter.
    
    Specified by:
    
    setSettings in interface OutputWriter
  - getStrategy
```
public ResultNameStrategy getStrategy()
```
  - setStrategy
```
public void setStrategy(ResultNameStrategy strategy)
```
  - isEnabled
```
public boolean isEnabled()
```
    Specified by:
    
    isEnabled in interface OutputWriter
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Specified by:
    
    setEnabled in interface OutputWriter
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class AbstractOutputWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SETTING_URL

SETTING_USERNAME

SETTING_TOKEN

SETTING_PORT

SETTING_HOST

SETTING_SOCKET_FACTORY

SETTING_USE_TLS

SETTING_TLS_INSECURE

SETTING_TLS_TRUST_STORE

SETTING_TLS_TRUST_STORE_PASSWORD

SETTING_TLS_KEY_STORE

SETTING_TLS_KEY_STORE_PASSWORD

SETTING_PROXY_PORT

SETTING_PROXY_HOST

SETTING_NAME_PREFIX

SETTING_PROTOCOL

logger

Constructor Detail

AbstractOutputWriter

Method Detail

start

stop

getIntSetting

getIntSetting

getLongSetting

getBooleanSetting

getStringSetting

getStringSetting

write

toString

getSettings

setSettings

getStrategy

setStrategy

isEnabled

setEnabled

equals

hashCode