Packagecom.kaazing.gateway.jms.client.stomp
Classpublic class StompConnectionFactory
ImplementsConnectionFactory

StompConnectionFactory is used to create a connection with a JMS provider via a WebSocket connection.



Public Methods
 MethodDefined by
  
StompConnectionFactory(providerURL:String, properties:StompConnectionProperties = null)
Creates a new StompConnectionFactory to create connections to the target url specified.
StompConnectionFactory
  
createConnection(username:String = null, password:String = null, callback:Function = null):ConnectionFuture
Creates a JMS Connection via WebSocket, using the username and password specified as credentials to authenticate with the Gateway.
StompConnectionFactory
  
createConnectionWithClientID(username:String = null, password:String = null, clientID:String = null, callback:Function = null):ConnectionFuture
Creates a JMS Connection via WebSocket, using the username and password specified as credentials to authenticate with the Gateway, and using the given clientID to distinguish the durable subscribers for this connection from those of other users.
StompConnectionFactory
Constructor detail
StompConnectionFactory()constructor
public function StompConnectionFactory(providerURL:String, properties:StompConnectionProperties = null)

Creates a new StompConnectionFactory to create connections to the target url specified. A WebSocket is used to establish the connection. The url should specify a protocol such as ws: or wss:. For example: ws://localhost:8000/jms

Parameters
providerURL:String
 
properties:StompConnectionProperties (default = null)
Method detail
createConnection()method
public function createConnection(username:String = null, password:String = null, callback:Function = null):ConnectionFuture

Creates a JMS Connection via WebSocket, using the username and password specified as credentials to authenticate with the Gateway.

Parameters
username:String (default = null)
 
password:String (default = null)
 
callback:Function (default = null)

Returns
ConnectionFuture
createConnectionWithClientID()method 
public function createConnectionWithClientID(username:String = null, password:String = null, clientID:String = null, callback:Function = null):ConnectionFuture

Creates a JMS Connection via WebSocket, using the username and password specified as credentials to authenticate with the Gateway, and using the given clientID to distinguish the durable subscribers for this connection from those of other users.

Parameters
username:String (default = null) — Client identifier. This is combined with durable subscriber names, using the format given in the stomp.jms service parameter " client.durable.name.format", to make them unique for the current user
 
password:String (default = null)
 
clientID:String (default = null)
 
callback:Function (default = null)

Returns
ConnectionFuture