lucee.runtime.gateway

Interface Gateway

public interface Gateway

Field Summary

Fields

Modifier and Type	Field and Description
static int	FAILED
static int	RUNNING
static int	STARTING
static int	STOPPED
static int	STOPPING

Method Summary

Methods

Modifier and Type	Method and Description
void	doRestart() restart the gateway
void	doStart() starts the gateway
void	doStop() stop the gateway
java.lang.Object	getHelper() return helper object
java.lang.String	getId() returns the id of the gateway
int	getState() returns a string that is used by the event gateway administrator to display status
void	init(GatewayEngine engine, java.lang.String id, java.lang.String cfcPath, java.util.Map config) method to initialize the gateway
java.lang.String	sendMessage(java.util.Map data) sends a message based on given data

Field Detail

STARTING

static final int STARTING

See Also:

Constant Field Values

RUNNING

static final int RUNNING

See Also:

Constant Field Values

STOPPING

static final int STOPPING

See Also:

Constant Field Values

STOPPED

static final int STOPPED

See Also:

Constant Field Values

FAILED

static final int FAILED

See Also:

Constant Field Values

Method Detail

init

void init(GatewayEngine engine,
        java.lang.String id,
        java.lang.String cfcPath,
        java.util.Map config)
          throws java.io.IOException

method to initialize the gateway

Parameters:

engine - the gateway engine

id - the id of the gateway

cfcPath - the path to the listener component

config - the configuration as map

Throws:

java.io.IOException

getId

java.lang.String getId()

returns the id of the gateway

Returns:

the id of the gateway

sendMessage

java.lang.String sendMessage(java.util.Map data)
                             throws java.io.IOException

sends a message based on given data

Parameters:

data -

Returns:

answer from gateway

Throws:

java.io.IOException

getHelper

java.lang.Object getHelper()

return helper object

Returns:

helper object

doStart

void doStart()
             throws java.io.IOException

starts the gateway

Throws:

GatewayException

java.io.IOException

doStop

void doStop()
            throws java.io.IOException

stop the gateway

Throws:

GatewayException

java.io.IOException

doRestart

void doRestart()
               throws java.io.IOException

restart the gateway

Throws:

GatewayException

java.io.IOException

getState

int getState()

returns a string that is used by the event gateway administrator to display status

Returns:

status (STARTING, RSTOPPING, STOPPED, FAILED)