Kanzi Connect 3.9.10
ExternalServiceBase Class Reference

Base class for Java implemented external services. More...

Inheritance diagram for ExternalServiceBase:
InputServiceConcept

Public Member Functions

 ExternalServiceBase (String name)
 Constructor.
 
ExternalServiceSession getRunningSession ()
 Running session accessor.
 

Protected Member Functions

void reportBooleanResult (MessagePackage message, boolean result)
 Reports a boolean response to provided message using the currently running session.
 
void reportFloatResult (MessagePackage message, float result)
 Reports a float response to provided message using the running session.
 
void reportIntResult (MessagePackage message, int result)
 Reports a integer response to provided message using the currently running session.
 
void reportStringResult (MessagePackage message, String result)
 Reports a string response to provided message using the currently running session.
 
void reportVoidResult (MessagePackage message)
 Reports a void response to provided message using the currently running session.
 
void setRunningSession (ExternalServiceSession session)
 Store current running session.
 

Static Protected Member Functions

static void reportBooleanResult (MessagePackage message, ExternalServiceSession session, boolean result)
 Reports a boolean response to provided message.
 
static void reportFloatResult (MessagePackage message, ExternalServiceSession session, float result)
 Reports a string response to provided message using the provided session.
 
static void reportIntResult (MessagePackage message, ExternalServiceSession session, int result)
 Reports a integer response to provided message using the provided session.
 
static void reportStringResult (MessagePackage message, ExternalServiceSession session, String result)
 Reports a string response to provided message using the provided session.
 
static void reportVoidResult (MessagePackage message, ExternalServiceSession session)
 Reports a void response to provided message using the provided session.
 

Detailed Description

Base class for Java implemented external services.

Constructor & Destructor Documentation

◆ ExternalServiceBase()

ExternalServiceBase ( String name)

Constructor.

Parameters
nameservice name

Member Function Documentation

◆ getRunningSession()

ExternalServiceSession getRunningSession ( )

Running session accessor.

Returns
currently active session

◆ reportBooleanResult() [1/2]

void reportBooleanResult ( MessagePackage message,
boolean result )
protected

Reports a boolean response to provided message using the currently running session.

Parameters
messagemessage to respond
resultvalue to respond.

◆ reportBooleanResult() [2/2]

static void reportBooleanResult ( MessagePackage message,
ExternalServiceSession session,
boolean result )
staticprotected

Reports a boolean response to provided message.

Parameters
messagemessage to respond
sessionsession to respond
resultvalue to respond

◆ reportFloatResult() [1/2]

static void reportFloatResult ( MessagePackage message,
ExternalServiceSession session,
float result )
staticprotected

Reports a string response to provided message using the provided session.

Parameters
messagemessage to respond
sessionsession to respond
resultvalue to respond

◆ reportFloatResult() [2/2]

void reportFloatResult ( MessagePackage message,
float result )
protected

Reports a float response to provided message using the running session.

Parameters
messagemessage to respond
resultvalue to respond

◆ reportIntResult() [1/2]

static void reportIntResult ( MessagePackage message,
ExternalServiceSession session,
int result )
staticprotected

Reports a integer response to provided message using the provided session.

Parameters
messagemessage to respond
sessionsession to respond
resultvalue to respond

◆ reportIntResult() [2/2]

void reportIntResult ( MessagePackage message,
int result )
protected

Reports a integer response to provided message using the currently running session.

Parameters
messagemessage to respond
resultvalue to respond

◆ reportStringResult() [1/2]

static void reportStringResult ( MessagePackage message,
ExternalServiceSession session,
String result )
staticprotected

Reports a string response to provided message using the provided session.

Parameters
messagemessage to respond
sessionsession to respond
resultvalue to respond

◆ reportStringResult() [2/2]

void reportStringResult ( MessagePackage message,
String result )
protected

Reports a string response to provided message using the currently running session.

Parameters
messagemessage to respond
resultvalue to respond

◆ reportVoidResult() [1/2]

void reportVoidResult ( MessagePackage message)
protected

Reports a void response to provided message using the currently running session.

Parameters
messagemessage to respond

◆ reportVoidResult() [2/2]

static void reportVoidResult ( MessagePackage message,
ExternalServiceSession session )
staticprotected

Reports a void response to provided message using the provided session.

Parameters
messagemessage to respond
sessionsession to respond

◆ setRunningSession()

void setRunningSession ( ExternalServiceSession session)
protected

Store current running session.

Parameters
sessionthe session to store