com.redhat.thermostat.backend.sample

Class SampleBackend

java.lang.Object

com.redhat.thermostat.backend.Backend

com.redhat.thermostat.backend.sample.SampleBackend

public class SampleBackend
extends Backend

Just an example backend implementation. This is really just to test the loading and configuration mechanisms

Constructor Summary

Constructors

Constructor and Description
SampleBackend()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	activate() Activate the Backend.
boolean	attachToNewProcessByDefault() A Backend may be configured to automatically begin collecting from new Java processes.
boolean	deactivate() Deactivate the Backend.
protected java.util.Iterator<Category>	getCategoryIterator()
java.util.Map<java.lang.String,java.lang.String>	getConfigurationMap() Get a map containing the current settings of this backend.
java.lang.String	getConfigurationValue(java.lang.String key)
java.lang.String	getDescription()
java.lang.String	getName()
java.lang.String	getVendor()
java.lang.String	getVersion()
boolean	isActive()
protected void	setConfigurationValue(java.lang.String name, java.lang.String value) Set the named configuration to the given value.

Methods inherited from class com.redhat.thermostat.backend.Backend

getObserveNewJvm, setInitialConfiguration, setObserveNewJvm, setStorage, store, update

Methods inherited from class java.lang.Object

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

Constructor Detail

SampleBackend

public SampleBackend()

Method Detail

setConfigurationValue

protected void setConfigurationValue(java.lang.String name,
                         java.lang.String value)

Description copied from class: Backend

Set the named configuration to the given value.

Overrides:

setConfigurationValue in class Backend

getName

public java.lang.String getName()

Specified by:

getName in class Backend

Returns:

the name of the Backend

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in class Backend

getVendor

public java.lang.String getVendor()

Specified by:

getVendor in class Backend

Returns:

the vendor of the Backend

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in class Backend

Returns:

the version of the Backend

getConfigurationMap

public java.util.Map<java.lang.String,java.lang.String> getConfigurationMap()

Description copied from class: Backend

Get a map containing the current settings of this backend. Implementors of this abstract class which have some settings that are be configurable by the client must override this method to provide an appropriate map.

Overrides:

getConfigurationMap in class Backend

Returns:

a map containing the settings of this backend

getConfigurationValue

public java.lang.String getConfigurationValue(java.lang.String key)

Specified by:

getConfigurationValue in class Backend

Parameters:

key - The constant key that corresponds to the desired configuration value

Returns:

The current value of the configuration value corresponding to the key given.

activate

public boolean activate()

Description copied from class: Backend

Activate the Backend. Based on the current configuration, begin pushing data to the Storage layer. If the Backend is already active, this method should have no effect

Specified by:

activate in class Backend

Returns:

true on success, false if there was an error

deactivate

public boolean deactivate()

Description copied from class: Backend

Deactivate the Backend. The backend should release any resources that were obtained as a direct result of a call to Backend.activate(). If the Backend is not active, this method should have no effect

Specified by:

deactivate in class Backend

Returns:

true on success

isActive

public boolean isActive()

Specified by:

isActive in class Backend

Returns:

a boolean indicating whether the backend is currently active on this host

getCategoryIterator

protected java.util.Iterator<Category> getCategoryIterator()

Specified by:

getCategoryIterator in class Backend

attachToNewProcessByDefault

public boolean attachToNewProcessByDefault()

Description copied from class: Backend

A Backend may be configured to automatically begin collecting from new Java processes. This method determines whether this will be the case when the backend is initially started.

Specified by:

attachToNewProcessByDefault in class Backend

Returns:

true if the initial backend behaviour is to attach to new java processes, false otherwise.