obixserver.core.engine
Class ObixServerEngine

java.lang.Object
  obixserver.core.engine.ObixServerEngine

All Implemented Interfaces:

Service

public class ObixServerEngine
extends Object
implements Service

oBIX Server Engine/Manager. Bootstraps the system and loads modules based on the configuration.

Field Summary

private boolean	ignoreInitErrors
private static Logger	logger
private Map	moduleMap A map of modules registered with the obix server system.
private ObjBroker	objBroker Object broker
private ObjCache	objCache Obix object manager.
private String	recursePattern Pattern used to allow rendering of a deeper subtree than one level.
private MessageRenderer	renderer Renders objs and obj trees into REST representation.

Constructor Summary

ObixServerEngine()

Method Summary

String	encodeObj(String serverName, obix.Obj obj)
String	encodeObjTree(String serverName, obix.Obj obj) Encodes up to 3 levels of the object tree, starting with the given obj.
private void	ensureRootUri(String serverName, obix.Obj obj) Ensure that root URI has a fully qualified href.
ObjBroker	getObjBroker()
String	getRecursePattern()
void	init()
String	invokeREST(String serverName, String uri, String input, String method) Invokes processing of REST request.
private String	objToString(String serverName, obix.Obj obj) Converts obj to XML required by REST service output.
private String	objTreeToString(String serverName, obix.Obj obj) Converts obj to XML - encode the whole tree.
void	setRecursePattern(String recursePattern)
void	start() Starts the service.
void	stop() Stops the service.
void	term()

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logger logger

objCache

private ObjCache objCache

Obix object manager.

objBroker

private ObjBroker objBroker

Object broker

renderer

private MessageRenderer renderer

Renders objs and obj trees into REST representation.

recursePattern

private String recursePattern

Pattern used to allow rendering of a deeper subtree than one level.

moduleMap

private Map moduleMap

A map of modules registered with the obix server system. name -> class instance

ignoreInitErrors

private boolean ignoreInitErrors

Constructor Detail

ObixServerEngine

public ObixServerEngine()

Method Detail

init

public void init()

start

public void start()

Description copied from interface: Service

Starts the service.

Specified by:

start in interface Service

stop

public void stop()

Description copied from interface: Service

Stops the service.

Specified by:

stop in interface Service

term

public void term()

getObjBroker

public ObjBroker getObjBroker()

invokeREST

public String invokeREST(String serverName,
                         String uri,
                         String input,
                         String method)
                  throws obix.net.ErrException

Invokes processing of REST request.

Parameters:

serverName -

uri -

input -

method -

Returns:

response string that represents REST response

Throws:

obix.net.ErrException

objToString

private String objToString(String serverName,
                           obix.Obj obj)

Converts obj to XML required by REST service output.

Parameters:

obj -

Returns:

XML sring representation of obj

objTreeToString

private String objTreeToString(String serverName,
                               obix.Obj obj)

Converts obj to XML - encode the whole tree.

Parameters:

obj -

Returns:

string representing the Obj tree in the configured encoding

ensureRootUri

private void ensureRootUri(String serverName,
                           obix.Obj obj)

Ensure that root URI has a fully qualified href.

Parameters:

serverName -

obj -

encodeObj

public String encodeObj(String serverName,
                        obix.Obj obj)

encodeObjTree

public String encodeObjTree(String serverName,
                            obix.Obj obj)

Encodes up to 3 levels of the object tree, starting with the given obj.

Parameters:

obj -

Returns:

encoded obj tree

getRecursePattern

public String getRecursePattern()

setRecursePattern

public void setRecursePattern(String recursePattern)