public abstract class Backend
extends java.lang.Object
Backend
s should be
registered with the BackendRegistry
.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 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.
|
abstract java.lang.String |
getConfigurationValue(java.lang.String key) |
abstract java.lang.String |
getDescription() |
abstract java.lang.String |
getName() |
boolean |
getObserveNewJvm()
Indicate whether this backend will attach to new java processes.
|
abstract java.lang.String |
getVendor() |
abstract java.lang.String |
getVersion() |
abstract boolean |
isActive() |
protected void |
setConfigurationValue(java.lang.String name,
java.lang.String value)
Set the named configuration to the given value.
|
void |
setInitialConfiguration(java.util.Map<java.lang.String,java.lang.String> configMap) |
void |
setObserveNewJvm(boolean newValue)
Set whether this backend will attach to new java processes.
|
void |
setStorage(Storage storage) |
void |
store(Chunk chunk) |
void |
update(Chunk chunk) |
public final void setInitialConfiguration(java.util.Map<java.lang.String,java.lang.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 setStorage(Storage storage)
protected abstract java.util.Iterator<Category> getCategoryIterator()
protected void setConfigurationValue(java.lang.String name, java.lang.String value)
name
- value
- java.lang.IllegalArgumentException
- if either the key does not refer to a valid configuration option
for this backend or the value is not valid for the keypublic abstract java.lang.String getName()
Backend
public abstract java.lang.String getDescription()
public abstract java.lang.String getVendor()
Backend
public abstract java.lang.String getVersion()
Backend
public java.util.Map<java.lang.String,java.lang.String> getConfigurationMap()
public abstract java.lang.String getConfigurationValue(java.lang.String key)
key
- The constant key that corresponds to the desired configuration valuejava.lang.IllegalArgumentException
- 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 final void store(Chunk chunk)
public final void update(Chunk chunk)