obixserver.module.external
Interface ExternalModule

All Superinterfaces:

Service

All Known Implementing Classes:

AbstractExternalModule, ExternalNoopModule

public interface ExternalModule
extends Service

All external oBIX modules must implement this interface.

Method Summary

String	getHome()
void	init(obix.Obj context) Initialize the module.
void	setBaseObj(obix.Obj obj)
void	setHome(String path) Sets path for root of the subtree of oBIX server that this external module will be updating.
void	setProperty(String name, String value) Sets property for this module.
void	setSession(obix.net.ObixSession session)
void	term() De-initialize/terminate the module.

Methods inherited from interface obixserver.core.Service

start, stop

Method Detail

setHome

void setHome(String path)

Sets path for root of the subtree of oBIX server that this external module will be updating.

Parameters:

path -

getHome

String getHome()

init

void init(obix.Obj context)

Initialize the module. Resource will be allocated, etc.

Parameters:

context -

term

void term()

De-initialize/terminate the module. Resource will be de-allocated, any second phase cleanup that couldn't be done in stop will be done.

setProperty

void setProperty(String name,
                 String value)

Sets property for this module. Property is a short-named replica of property read from configuration file.

Parameters:

name -

value -

setBaseObj

void setBaseObj(obix.Obj obj)

setSession

void setSession(obix.net.ObixSession session)