oracle.edge.common
Interface EdgeExtension

All Known Subinterfaces:

Device, EventDevice, Filter

All Known Implementing Classes:

AbstractDevice, AbstractEventDevice, AbstractFilter

public interface EdgeExtension

This is the interface for the extensible object inside EdgeServer, the potential implementation of the extension can be Devices, Filters, and Dispatchers, for example.

Field Summary

static int	DEVICE_DRIVER_TYPE The type tag for device driver.
static int	DISPATCHER_TYPE The type tag for dispatcher.
static int	FILTER_TYPE The type tag for filter.

Method Summary

void	destroy() Clean up the edge extension object, Called by the edge server to indicate to an EdgeExtension that the extension is being taken out of service.
java.lang.String	getDescription() Return the description for the extension instance object.
java.lang.String	getName() Return the name of the extension instance object.
java.lang.String	getVersion() Return the version of the extension instance, this can be used for logging/debugging et al.
void	init(EdgeExtensionContext ctxt) Initialize the edge extension object given the context for the extension object.
void	start() Start the edge extension object, the concrete implementation should choose to implement this method as necessary.
void	stop() Stop the edge extension object, the concrete implementation should choose to implement this method as necessary.

Field Detail

DEVICE_DRIVER_TYPE

public static final int DEVICE_DRIVER_TYPE

The type tag for device driver.

See Also:

Constant Field Values

DISPATCHER_TYPE

public static final int DISPATCHER_TYPE

The type tag for dispatcher.

See Also:

Constant Field Values

FILTER_TYPE

public static final int FILTER_TYPE

The type tag for filter.

See Also:

Constant Field Values

Method Detail

destroy

public void destroy()
             throws EdgeExtensionException

Clean up the edge extension object, Called by the edge server to indicate to an EdgeExtension that the extension is being taken out of service. This method gives the extension object an opportunity to clean up any resources that are being held (memory, file/socket et al) and make sure that any data/events are not lost.

Throws:

EdgeExtensionException - In case of errors occurred while cleaning up.

getDescription

public java.lang.String getDescription()

Return the description for the extension instance object. The description is obtained as part of the configuration process for the extension instance object.

Returns:

the description for the extension instance object.

getName

public java.lang.String getName()

Return the name of the extension instance object. The name is usually obtained as part of the configuration.

Returns:

the name of the extension instance object.

getVersion

public java.lang.String getVersion()

Return the version of the extension instance, this can be used for logging/debugging et al.

Returns:

the version of the extension instance, this can be used for logging/debugging et al.

init

public void init(EdgeExtensionContext ctxt)
          throws EdgeExtensionException

Initialize the edge extension object given the context for the extension object. The implementation should cache this reference if necessary and query the context for other related information, because certain information inside the context can change while the edge server is running.

Parameters:

ctxt - The edge extension context object.

Throws:

EdgeExtensionException

start

public void start()
           throws EdgeExtensionException

Start the edge extension object, the concrete implementation should choose to implement this method as necessary.

Throws:

EdgeExtensionException - In case the edge extension can not be started successfully.

stop

public void stop()
          throws EdgeExtensionException

Stop the edge extension object, the concrete implementation should choose to implement this method as necessary.

Throws:

EdgeExtensionException - In case the edge extension can not be stopped successfully.