obixserver.module
Interface Module

All Superinterfaces:

Service

All Known Implementing Classes:

AbstractBaseModule, CoreModule, NoopModule, PushSimulatorModule, SimulatorModule

public interface Module
extends Service

All oBIX modules must implement this interface. The stop/shutdown sequence is sometimes required if complete cleanup can't be done in stop alone.

Author:

Peter Michalek

Method Summary

String	getBase() Return base for this module.
ObjBroker	getObjBroker() Returns ObjBroker.
String	getObjResource() Returns obj resource for auto-loading.
void	init(obix.Obj context) Initialize the module.
void	setBase(String base) Sets base for this module - this is the leaf of the href of the base Obj of the module.
void	setObjBroker(ObjBroker objBroker) Sets ObjBroker.
void	setObjResource(String resource) Sets resource for auto-loading of Objs into repository.
void	setProperty(String name, String value) Sets property for this module.
void	term() De-initialize/terminate the module.

Methods inherited from interface obixserver.core.Service

start, stop

Method Detail

setBase

void setBase(String base)

Sets base for this module - this is the leaf of the href of the base Obj of the module. All objects are created as children of this URL.

Parameters:

base -

getBase

String getBase()

Return base for this module.

setObjResource

void setObjResource(String resource)

Sets resource for auto-loading of Objs into repository. The resource is an XML file containing Obj tree for the module.

Parameters:

resource -

getObjResource

String getObjResource()

Returns obj resource for auto-loading.

init

void init(obix.Obj context)

Initialize the module. Resource will be allocated, etc.

Parameters:

context - TODO

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.

getObjBroker

ObjBroker getObjBroker()

Returns ObjBroker.

setObjBroker

void setObjBroker(ObjBroker objBroker)

Sets ObjBroker. Used only by the entity that loads the module (Obix server engine).

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 -