railo.runtime.gateway
Class CFCGateway

java.lang.Object
  extended by railo.runtime.gateway.CFCGateway
All Implemented Interfaces:
Gateway

public class CFCGateway
extends Object
implements Gateway


Field Summary
 
Fields inherited from interface org.opencfml.eventgateway.Gateway
FAILED, RUNNING, STARTING, STOPPED, STOPPING
 
Constructor Summary
CFCGateway(String cfcPath)
           
 
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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CFCGateway

public CFCGateway(String cfcPath)
Method Detail

init

public void init(GatewayEngine engine,
                 String id,
                 String cfcPath,
                 Map config)
          throws GatewayException
Description copied from interface: Gateway
method to initialize the gateway

Specified by:
init in interface 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:
GatewayException
See Also:
org.opencfml.eventgateway.Gateway#init(java.lang.String, java.lang.String, railo.runtime.type.Struct)

doRestart

public void doRestart()
               throws GatewayException
Description copied from interface: Gateway
restart the gateway

Specified by:
doRestart in interface Gateway
Throws:
GatewayException
See Also:
Gateway.doRestart()

doStart

public void doStart()
             throws GatewayException
Description copied from interface: Gateway
starts the gateway

Specified by:
doStart in interface Gateway
Throws:
GatewayException
See Also:
Gateway.doStart()

doStop

public void doStop()
            throws GatewayException
Description copied from interface: Gateway
stop the gateway

Specified by:
doStop in interface Gateway
Throws:
GatewayException
See Also:
Gateway.doStop()

getHelper

public Object getHelper()
Description copied from interface: Gateway
return helper object

Specified by:
getHelper in interface Gateway
Returns:
helper object
See Also:
Gateway.getHelper()

getId

public String getId()
Description copied from interface: Gateway
returns the id of the gateway

Specified by:
getId in interface Gateway
Returns:
the id of the gateway
See Also:
Gateway.getId()

getState

public int getState()
Description copied from interface: Gateway
returns a string that is used by the event gateway administrator to display status

Specified by:
getState in interface Gateway
Returns:
status (STARTING, RSTOPPING, STOPPED, FAILED)
See Also:
Gateway.getState()

sendMessage

public String sendMessage(Map data)
                   throws GatewayException
Description copied from interface: Gateway
sends a message based on given data

Specified by:
sendMessage in interface Gateway
Returns:
answer from gateway
Throws:
GatewayException
See Also:
org.opencfml.eventgateway.Gateway#sendMessage(railo.runtime.type.Struct)


Copyright © 2012 Railo