com.hyfinity.java

Class JavaEngine

java.lang.Object

com.hyfinity.java.JavaEngine

All Implemented Interfaces:

Engine

public class JavaEngine
extends java.lang.Object
implements Engine

Engine implementation for our new (2017) Java API. This provides a nicer interface for developers to write their own server side functionality

Version:

1.0

Author:

Hyfinity Ltd. Copyright (c) 2017

Constructor Summary

Constructors

Constructor and Description
JavaEngine() Constructor.

Method Summary

Modifier and Type	Method and Description
void	execute(RequestIdentification requestID, XDocument msg, XDocument response, java.lang.String action) Make the engine do its job.
void	freeEngine() Free up any engine resources.
void	init(XDocument logicsheet, XAgentCallback agent) Initialise the engine.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaEngine

public JavaEngine()

Constructor.

Method Detail

init

public void init(XDocument logicsheet,
                 XAgentCallback agent)

Initialise the engine.

Specified by:

init in interface Engine

Parameters:

logicsheet - XML Logicsheet for the engine. For a JavaEngine, this should be a custom config structure specifying the java package and class name of the Java Controller to instantiate.

agent - Callback interface to access xplatform services.

Throws:

XPlatformException - If there is an error instantiating the Java Controller

execute

public void execute(RequestIdentification requestID,
                    XDocument msg,
                    XDocument response,
                    java.lang.String action)

Make the engine do its job.

Specified by:

execute in interface Engine

Parameters:

requestID - A RequestIdentification object containing the ID details for this request.

msg - Incoming message.

response - Outgoing message.

action - The action that should be called on the engine.

freeEngine

public void freeEngine()

Free up any engine resources.

Specified by:

freeEngine in interface Engine