public abstract class Backend extends Object
Backend
s should be
registered with the BackendRegistry
.Modifier and Type | Field and Description |
---|---|
protected DAOFactory |
df |
Constructor and Description |
---|
Backend() |
Modifier and Type | Method and Description |
---|---|
abstract boolean |
activate()
Activate the
Backend . |
abstract boolean |
attachToNewProcessByDefault()
A
Backend may be configured to automatically begin collecting from new Java
processes. |
abstract boolean |
deactivate()
Deactivate the
Backend . |
protected abstract Collection<Category> |
getCategories() |
Map<String,String> |
getConfigurationMap()
Get a map containing the current settings of this backend.
|
abstract String |
getConfigurationValue(String key) |
String |
getDescription() |
BackendID |
getID() |
String |
getName() |
boolean |
getObserveNewJvm()
Indicate whether this backend will attach to new java processes.
|
String |
getVendor() |
String |
getVersion() |
abstract boolean |
isActive() |
protected void |
setConfigurationValue(String name,
String value)
Set the named configuration to the given value.
|
protected void |
setConfigurationValueImpl(String name,
String value)
Set the named configuration to the given value.
|
void |
setDAOFactory(DAOFactory df) |
protected abstract void |
setDAOFactoryAction() |
protected void |
setInitialConfiguration(Map<String,String> configMap) |
void |
setObserveNewJvm(boolean newValue)
Set whether this backend will attach to new java processes.
|
protected DAOFactory df
protected final void setInitialConfiguration(Map<String,String> configMap) throws BackendLoadException
configMap
- a map containing the settings that this backend has been configured with.LaunchException
- if map contains values that this backend does not accept.BackendLoadException
public final void setDAOFactory(DAOFactory df)
protected abstract void setDAOFactoryAction()
protected abstract Collection<Category> getCategories()
protected void setConfigurationValue(String name, String value)
name
, version
and
description
are parsed here.
setConfigurationValueImpl(String, String)
method if they are not interested in parsing and setting those
properties directly.name
- value
- IllegalArgumentException
- if either the key does not refer to a valid configuration option
for this backend or the value is not valid for the keyprotected void setConfigurationValueImpl(String name, String value)
public String getDescription()
public Map<String,String> getConfigurationMap()
public abstract String getConfigurationValue(String key)
key
- The constant key that corresponds to the desired configuration valueIllegalArgumentException
- if the key does not refer to a valid configuration option for
this backendpublic abstract boolean activate()
Backend
. Based on the current configuration,
begin pushing data to the Storage
layer. If the Backend
is
already active, this method should have no effectpublic abstract boolean deactivate()
Backend
. The backend should release any
resources that were obtained as a direct result of a call to
activate()
. If the Backend
is not active, this
method should have no effectpublic abstract boolean isActive()
public abstract boolean attachToNewProcessByDefault()
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.public boolean getObserveNewJvm()
public void setObserveNewJvm(boolean newValue)
newValue
- public BackendID getID()
Copyright © 2013. All Rights Reserved.