railo.runtime.gateway
Interface Gateway


public interface Gateway


Field Summary
static int FAILED
           
static int RUNNING
           
static int STARTING
           
static int STOPPED
           
static int STOPPING
           
 
Method Summary
 void doRestart()
          restart the gateway
 void doStart()
          starts the gateway
 void doStop()
          stop the gateway
 Object getHelper()
          return helper object
 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, String id, String cfcPath, Map config)
          method to initialize the gateway
 String sendMessage(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,
          String id,
          String cfcPath,
          Map config)
          throws 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:
IOException

getId

String getId()
returns the id of the gateway

Returns:
the id of the gateway

sendMessage

String sendMessage(Map data)
                   throws IOException
sends a message based on given data

Parameters:
data -
Returns:
answer from gateway
Throws:
IOException

getHelper

Object getHelper()
return helper object

Returns:
helper object

doStart

void doStart()
             throws IOException
starts the gateway

Throws:
GatewayException
IOException

doStop

void doStop()
            throws IOException
stop the gateway

Throws:
GatewayException
IOException

doRestart

void doRestart()
               throws IOException
restart the gateway

Throws:
GatewayException
IOException

getState

int getState()
returns a string that is used by the event gateway administrator to display status

Returns:
status (STARTING, RSTOPPING, STOPPED, FAILED)


Copyright © 2012 Railo