public abstract class JmsConnectionFactory extends Object implements javax.jms.ConnectionFactory
| Modifier | Constructor and Description |
|---|---|
protected |
JmsConnectionFactory()
Creates a new JMSConnectionFactory to create connections.
|
protected |
JmsConnectionFactory(URI url)
Creates a new JMSConnectionFactory to create connections to the target url specified.
|
protected |
JmsConnectionFactory(URI url,
JmsConnectionProperties properties)
Creates a new JMSConnectionFactory to create connections to the target url specified.
|
| Modifier and Type | Method and Description |
|---|---|
javax.jms.Connection |
createConnection()
Creates a JMS Connection via WebSocket, using the default username and password
to authenticate with the Gateway.
|
javax.jms.Connection |
createConnection(String clientID)
Creates a JMS Connection via WebSocket, using the default username and password
to authenticate with the Gateway, and using the given clientID to distinguish the
durable subscribers for this connection from those of other users.
|
javax.jms.Connection |
createConnection(String username,
String password)
Creates a JMS Connection via WebSocket, using the username and password
specified as credentials to authenticate with the Gateway.
|
abstract javax.jms.Connection |
createConnection(String username,
String password,
String clientID)
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.
|
static JmsConnectionFactory |
createConnectionFactory()
Creates and returns a new JmsConnectionFactory to create a connection.
|
static JmsConnectionFactory |
createConnectionFactory(URI url)
Creates and returns a new JmsConnectionFactory to create connections to the
specified target url.
|
static JmsConnectionFactory |
createConnectionFactory(URI url,
JmsConnectionProperties properties)
Creates and returns a new JmsConnectionFactory to create connections to the
specified target url.
|
JmsConnectionProperties |
getConnectionProperties()
Returns the connection properties for the factory.
|
URI |
getGatewayLocation()
Gets the target Gateway location.
|
WebSocketFactory |
getWebSocketFactory()
Returns the instance of underlying
WebSocketFactory that is used
to create and establish WebSocket connection to send/receive
data over WebSocket connection. |
void |
setGatewayLocation(URI gatewayLocation)
Sets the target Gateway location.
|
void |
setWebSocketFactory(WebSocketFactory webSocketFactory)
Sets the
WebSocketFactory that will be used to create and establish
WebSocket connection to send/receive data over WebSocket connection. |
protected JmsConnectionFactory()
throws javax.jms.JMSException
javax.jms.JMSExceptionprotected JmsConnectionFactory(URI url) throws javax.jms.JMSException
javax.jms.JMSExceptionprotected JmsConnectionFactory(URI url, JmsConnectionProperties properties) throws javax.jms.JMSException
javax.jms.JMSExceptionpublic static JmsConnectionFactory createConnectionFactory() throws javax.jms.JMSException
javax.jms.JMSExceptionpublic static JmsConnectionFactory createConnectionFactory(URI url) throws javax.jms.JMSException
url - target url to connectjavax.jms.JMSExceptionpublic static JmsConnectionFactory createConnectionFactory(URI url, JmsConnectionProperties properties) throws javax.jms.JMSException
url - target url or the endpoint of the WebSocket providerproperties - JmsConnectionProperties for configuring the connectionjavax.jms.JMSExceptionpublic JmsConnectionProperties getConnectionProperties()
public URI getGatewayLocation()
public void setGatewayLocation(URI gatewayLocation)
public WebSocketFactory getWebSocketFactory()
WebSocketFactory that is used
to create and establish WebSocket connection to send/receive
data over WebSocket connection.
The WebSocketFactory instance can be used to set default
characteristics. For example, an application developer can use it to set
the ChallengeHandler to perform authentication.WebSocketFactorypublic void setWebSocketFactory(WebSocketFactory webSocketFactory)
WebSocketFactory that will be used to create and establish
WebSocket connection to send/receive data over WebSocket connection.
When JmsConnectionFactory is created, the WebSocketFactory is
implicitly created. The function can be used to replace the default WebSocketFactory.
Application developer can create WebSocketFactory externally, enable extensions, set
parameter values and can provide that WebSocketFactory to the JmsConnectionFactory.webSocketFactory - Instance of WebSocketFactorypublic javax.jms.Connection createConnection()
throws javax.jms.JMSException
createConnection in interface javax.jms.ConnectionFactoryjavax.jms.JMSExceptionpublic javax.jms.Connection createConnection(String clientID) throws javax.jms.JMSException
clientID - Client identifier. This is combined with durable subscriber names, using
the format specified for "jms" service parameter "client.durable.name.format", to
make them unique for the current userjavax.jms.JMSExceptionpublic javax.jms.Connection createConnection(String username, String password) throws javax.jms.JMSException
createConnection in interface javax.jms.ConnectionFactoryjavax.jms.JMSExceptionpublic abstract javax.jms.Connection createConnection(String username, String password, String clientID) throws javax.jms.JMSException
clientID - Client identifier. This is combined with durable subscriber names, using
the format specified for "jms" service parameter "client.durable.name.format", to
make them unique for the current userjavax.jms.JMSExceptionCopyright © 2016. All Rights Reserved.