com.microsoft.azure.servicebus.jms

Class ServiceBusJmsConnectionFactory

java.lang.Object

com.microsoft.azure.servicebus.jms.jndi.JNDIStorable

com.microsoft.azure.servicebus.jms.ServiceBusJmsConnectionFactory

All Implemented Interfaces:

javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory, javax.jms.TopicConnectionFactory, Referenceable

Direct Known Subclasses:

ServiceBusJmsQueueConnectionFactory, ServiceBusJmsTopicConnectionFactory

public class ServiceBusJmsConnectionFactory
extends JNDIStorable
implements javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory, javax.jms.TopicConnectionFactory

Field Summary

Fields inherited from class com.microsoft.azure.servicebus.jms.jndi.JNDIStorable

REQUIRED_PROPERTY_MESSAGE_FORMAT

Constructor Summary

Constructors

Constructor and Description
ServiceBusJmsConnectionFactory() Intended to be used by JNDI only.
ServiceBusJmsConnectionFactory(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder connectionStringBuilder, ServiceBusJmsConnectionFactorySettings settings) Create a ServiceBusJmsConnectionFactory using a given Azure ServiceBus ConnectionStringBuilder.
ServiceBusJmsConnectionFactory(String connectionString, ServiceBusJmsConnectionFactorySettings settings) Create a ServiceBusJmsConnectionFactory using a given Azure ServiceBus connection string.
ServiceBusJmsConnectionFactory(String sasKeyName, String sasKey, String host, ServiceBusJmsConnectionFactorySettings settings) Create a ServiceBusJmsConnectionFactory using shared access key and host name.

Method Summary

Modifier and Type	Method and Description
javax.jms.Connection	createConnection()
javax.jms.Connection	createConnection(String userName, String password)
javax.jms.JMSContext	createContext()
javax.jms.JMSContext	createContext(int sessionMode)
javax.jms.JMSContext	createContext(String userName, String password)
javax.jms.JMSContext	createContext(String userName, String password, int sessionMode)
javax.jms.QueueConnection	createQueueConnection()
javax.jms.QueueConnection	createQueueConnection(String userName, String password)
javax.jms.TopicConnection	createTopicConnection()
javax.jms.TopicConnection	createTopicConnection(String userName, String password)
String	getClientId()
com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder	getConnectionStringBuilder()
protected String	getCustomUserAgent()
protected Map<String,String>	getProperties()
ServiceBusJmsConnectionFactorySettings	getSettings()
void	setClientId(String clientId)
protected void	setCustomUserAgent(String customUserAgent)
protected void	setProperties(Map<String,String> properties)

Methods inherited from class com.microsoft.azure.servicebus.jms.jndi.JNDIStorable

checkRequiredProperty, getReference

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceBusJmsConnectionFactory

public ServiceBusJmsConnectionFactory()

Intended to be used by JNDI only. Users should not be actively calling this constructor to create a ServiceBusJmsConnectionFactory instance.

ServiceBusJmsConnectionFactory

public ServiceBusJmsConnectionFactory(String connectionString,
                                      ServiceBusJmsConnectionFactorySettings settings)

Create a ServiceBusJmsConnectionFactory using a given Azure ServiceBus connection string.

Parameters:

connectionString - The ServiceBus connection string. For details on how to get your connection string, please see https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-create-namespace-portal#get-the-connection-string.

settings - The options used for this ConnectionFactory. Null can be used as default.

ServiceBusJmsConnectionFactory

public ServiceBusJmsConnectionFactory(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder connectionStringBuilder,
                                      ServiceBusJmsConnectionFactorySettings settings)

Create a ServiceBusJmsConnectionFactory using a given Azure ServiceBus ConnectionStringBuilder.

Parameters:

connectionStringBuilder - The ConnectionStringBuilder constructed using the SerivceBus connection string

settings - The options used for this ConnectionFactory. Null can be used as default.

ServiceBusJmsConnectionFactory

public ServiceBusJmsConnectionFactory(String sasKeyName,
                                      String sasKey,
                                      String host,
                                      ServiceBusJmsConnectionFactorySettings settings)

Create a ServiceBusJmsConnectionFactory using shared access key and host name.

Parameters:

sasKeyName - The Shared access policy name.

sasKey - The Shared access policy key.

host - The host name of the ServiceBus namespace. Example: your-namespace-name.servicebus.windows.net

settings - The options used for this ConnectionFactory. Null can be used as default.

Method Detail

getConnectionStringBuilder

public com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder getConnectionStringBuilder()

getClientId

public String getClientId()

Returns:

The clientId set for this ConnectionFactory.

setClientId

public void setClientId(String clientId)

Parameters:

clientId - Set the clientId for this ConnectionFactory. Connections created with this ConnectionFactory will have this value as its clientId.

getSettings

public ServiceBusJmsConnectionFactorySettings getSettings()

Returns:

The ServiceBusConnectionFactorySettings used to initialize this ServiceBusJmsConnectionFactory

createConnection

public javax.jms.Connection createConnection()
                                      throws javax.jms.JMSException

Specified by:

createConnection in interface javax.jms.ConnectionFactory

Throws:

javax.jms.JMSException

createConnection

public javax.jms.Connection createConnection(String userName,
                                             String password)
                                      throws javax.jms.JMSException

Specified by:

createConnection in interface javax.jms.ConnectionFactory

Throws:

javax.jms.JMSException

createContext

public javax.jms.JMSContext createContext()

Specified by:

createContext in interface javax.jms.ConnectionFactory

createContext

public javax.jms.JMSContext createContext(int sessionMode)

Specified by:

createContext in interface javax.jms.ConnectionFactory

createContext

public javax.jms.JMSContext createContext(String userName,
                                          String password)

Specified by:

createContext in interface javax.jms.ConnectionFactory

createContext

public javax.jms.JMSContext createContext(String userName,
                                          String password,
                                          int sessionMode)

Specified by:

createContext in interface javax.jms.ConnectionFactory

createTopicConnection

public javax.jms.TopicConnection createTopicConnection()
                                                throws javax.jms.JMSException

Specified by:

createTopicConnection in interface javax.jms.TopicConnectionFactory

Throws:

javax.jms.JMSException

createTopicConnection

public javax.jms.TopicConnection createTopicConnection(String userName,
                                                       String password)
                                                throws javax.jms.JMSException

Specified by:

createTopicConnection in interface javax.jms.TopicConnectionFactory

Throws:

javax.jms.JMSException

createQueueConnection

public javax.jms.QueueConnection createQueueConnection()
                                                throws javax.jms.JMSException

Specified by:

createQueueConnection in interface javax.jms.QueueConnectionFactory

Throws:

javax.jms.JMSException

createQueueConnection

public javax.jms.QueueConnection createQueueConnection(String userName,
                                                       String password)
                                                throws javax.jms.JMSException

Specified by:

createQueueConnection in interface javax.jms.QueueConnectionFactory

Throws:

javax.jms.JMSException

getProperties

protected Map<String,String> getProperties()

Specified by:

getProperties in class JNDIStorable

setProperties

protected void setProperties(Map<String,String> properties)

Specified by:

setProperties in class JNDIStorable

getCustomUserAgent

protected String getCustomUserAgent()

setCustomUserAgent

protected void setCustomUserAgent(String customUserAgent)