eventgateway.cfc

CFIDE.adminapi.eventgateway
Component eventgateway (event gateway)

Add, modify, delete, and manage event gateways.

hierarchy: WEB-INF.cftags.component
CFIDE.adminapi.base
CFIDE.adminapi.eventgateway
path: {web-root}\CFIDE\adminapi\eventgateway.cfc
serializable: Yes
properties:
methods: deleteGatewayInstance, deleteGatewayType, getGatewayEvents, getGatewayInstances, getGatewayInstanceStatus, getGatewayProperty, getGatewayServiceStatus, getGatewayTypes, getSMSTestServerStatus, ResetGatewayEvents, restartGatewayInstance, setGatewayInstance, setGatewayProperty, setGatewayServiceStatus, setGatewayType, startGatewayInstance, startGatewayService, startSMSTestServer, stopGatewayInstance, stopGatewayService, stopSMSTestServer
inherited methods: dump, getEdition, getInstallType, getJRunRootDir, isAdminUser, RDSInvoker, setJrunSN

* – private method

deleteGatewayInstance
public void deleteGatewayInstance ( required gatewayid
)

Delete an instance of a gateway.

Output: suppressed
Parameters:
gatewayid: any, required, gatewayid – ID of the gateway instance

deleteGatewayType
public void deleteGatewayType ( required type
)

Removes an event gateway type.

Output: suppressed
Parameters:
type: any, required, type – gateway type

getGatewayEvents
public any getGatewayEvents ( required gatewayID, required propertyName
)

Return value of specified gateway event counters, these are reset on server start.

Output: suppressed
Parameters:
gatewayID: any, required, gatewayID – Name of the the gateway.
propertyName: any, required, propertyName – Valid Properties are:

  • EventsIn
  • EventsOut
getGatewayInstances
public any getGatewayInstances ( gatewayid
)

Returns instances of all gateways or of a specified gateway instance.

Output: suppressed
Parameters:
gatewayid: any, optional, gatewayid – Specifies the ID of a gateway instance.

getGatewayInstanceStatus
public boolean getGatewayInstanceStatus ( required gatewayid
)

Return status (started/stopped) for a gateway instance.

Output: suppressed
Parameters:
gatewayid: any, required, gatewayid – Name of the gateway instance.

getGatewayProperty
public any getGatewayProperty ( required propertyName
)

Return value of specified gateway property.

Output: suppressed
Parameters:
propertyName: any, required, propertyName – Valid Properties are:

  • ThreadPoolSize
  • MaxQueueSize
getGatewayServiceStatus
public any getGatewayServiceStatus (

)

Returns gateway service status.

Output: suppressed

getGatewayTypes
public any getGatewayTypes ( type
)

Returns known types of event gateways.

Output: suppressed
Parameters:
type: any, optional, type – Specifies a gateway type.

getSMSTestServerStatus
public boolean getSMSTestServerStatus (

)

Returns status (started/stopped) of SMS Test Server.

Output: suppressed

ResetGatewayEvents
public any ResetGatewayEvents ( required gatewayID, required propertyName
)

Reset the internal event counters for a specific gateway.

Output: suppressed
Parameters:
gatewayID: any, required, gatewayID – Name of the the gateway.
propertyName: any, required, propertyName – Valid Properties are:

  • EventsIn
  • EventsOut
restartGatewayInstance
public void restartGatewayInstance ( required gatewayid
)

Restart an instance of an event gateway.

Output: suppressed
Parameters:
gatewayid: any, required, gatewayid – Name of the gateway instance.

setGatewayInstance
public void setGatewayInstance ( required gatewayid, required type, required array cfcPaths, required configurationpath, required mode
)

Adds a gateway instance.

Output: enabled
Parameters:
gatewayid: any, required, gatewayid – A name for the gateway instance.
type: any, required, type – Gateway type, such as SMS, SocketGateway, etc.
cfcPaths: array, required, cfcPaths – Absolute path to listener CFC for incoming messages.
configurationpath: any, required, configurationpath – Configuration file for the gateway instance.
mode: any, required, mode – Gateway startup status:

  • auto
  • manual
  • disabled
setGatewayProperty
public void setGatewayProperty ( required propertyName, required propertyValue
)

Set a value for a specified gateway property.

Output: suppressed
Parameters:
propertyName: any, required, propertyName – Valid Properties are:

  • ThreadPoolSize
  • MaxQueueSize

propertyValue: any, required, propertyValue – Value for the specified property.

setGatewayServiceStatus
public void setGatewayServiceStatus ( required enableGatewayService
)

Enables/Disables ColdFusion Event Gateway Services

Output: suppressed
Parameters:
enableGatewayService: any, required, enableGatewayService – Specifies whether ColdFusion Event Gateway Services are enabled.

setGatewayType
public void setGatewayType ( required type, required description, required class, timeout="30", killOnTimeout="true"
)

Adds an event gateway type.

Output: suppressed
Parameters:
type: any, required, type – gateway type
description: any, required, description – description of gateway type
class: any, required, class – name of Java class for gateway type
timeout: any, optional, timeout – timeout value
killOnTimeout: any, optional, killOnTimeout – Yes or No

startGatewayInstance
public void startGatewayInstance ( required gatewayid
)

Start an instance of an event gateway.

Output: suppressed
Parameters:
gatewayid: any, required, gatewayid – Name of the gateway instance.

startGatewayService
public void startGatewayService (

)

Enables event gateway service.

Output: suppressed

startSMSTestServer
public void startSMSTestServer (

)

Starts SMS Test Server.

Output: suppressed

stopGatewayInstance
public void stopGatewayInstance ( required gatewayid
)

Stop an instance of an event gateway.

Output: suppressed
Parameters:
gatewayid: any, required, gatewayid – Name of the gateway instance.

stopGatewayService
public void stopGatewayService (

)

Stops event gateway service.

Output: suppressed

stopSMSTestServer
public void stopSMSTestServer (

)

Stops SMS Test Server.

Output: suppressed