org.opennms.netmgt.telemetry.protocols.collection

Class ScriptedCollectionSetBuilder

java.lang.Object

org.opennms.netmgt.telemetry.protocols.collection.ScriptedCollectionSetBuilder

public class ScriptedCollectionSetBuilder
extends Object

Uses an external script, executed via JSR-223, to generate a CollectionSet from some given object using the CollectionSetBuilder.

Author:

jwhite

Constructor Summary

Constructors

Constructor and Description
ScriptedCollectionSetBuilder(File script)
ScriptedCollectionSetBuilder(File script, org.osgi.framework.BundleContext bundleContext)
ScriptedCollectionSetBuilder(File script, ScriptEngineManager manager)

Method Summary

Modifier and Type	Method and Description
CollectionSet	build(CollectionAgent agent, Object message, Long timestamp) Builds a collection set from the given message.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptedCollectionSetBuilder

public ScriptedCollectionSetBuilder(File script)
                             throws IOException,
                                    ScriptException

Throws:

IOException

ScriptException

ScriptedCollectionSetBuilder

public ScriptedCollectionSetBuilder(File script,
                                    org.osgi.framework.BundleContext bundleContext)
                             throws IOException,
                                    ScriptException

Throws:

IOException

ScriptException

ScriptedCollectionSetBuilder

public ScriptedCollectionSetBuilder(File script,
                                    ScriptEngineManager manager)
                             throws IOException,
                                    ScriptException

Throws:

IOException

ScriptException

Method Detail

build

public CollectionSet build(CollectionAgent agent,
                           Object message,
                           Long timestamp)
                    throws ScriptException

Builds a collection set from the given message. WARNING: This method is not necessarily thread safe. This depends on the script, and the script engine that is being used.

Parameters:

agent - the agent associated with the collection set

message - the messaged passed to script containing the metrics

Returns:

a collection set

Throws:

ScriptException