Class ReceiveSubscriber
java.lang.Object
org.apache.jmeter.protocol.jms.client.ReceiveSubscriber
- All Implemented Interfaces:
Closeable,AutoCloseable,javax.jms.MessageListener
Generic MessageConsumer class, which has two possible strategies.
- Use MessageConsumer.receive(timeout) to fetch messages.
- Use MessageListener.onMessage() to cache messages in a local queue.
getMessage(long) method is used to return the next message,
either directly using receive(timeout) or from the queue using poll(timeout).-
Constructor Summary
ConstructorsConstructorDescriptionReceiveSubscriber(boolean useProps, String initialContextFactory, String providerUrl, String connfactory, String destinationName, String durableSubscriptionId, String clientId, String jmsSelector, boolean useAuth, String securityPrincipal, String securityCredentials) Constructor takes the necessary JNDI related parameters to create a connection and prepare to begin receiving messages.ReceiveSubscriber(int queueSize, boolean useProps, String initialContextFactory, String providerUrl, String connfactory, String destinationName, String durableSubscriptionId, String clientId, String jmsSelector, boolean useAuth, String securityPrincipal, String securityCredentials) Constructor takes the necessary JNDI related parameters to create a connection and create an onMessageListener to prepare to begin receiving messages. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()close() will stop the connection first.javax.jms.MessagegetMessage(long timeout) Get the next message ornull.voidonMessage(javax.jms.Message message) voidstart()Calls Connection.start() to begin receiving inbound messages.voidstop()Calls Connection.stop() to stop receiving inbound messages.
-
Constructor Details
-
ReceiveSubscriber
public ReceiveSubscriber(boolean useProps, String initialContextFactory, String providerUrl, String connfactory, String destinationName, String durableSubscriptionId, String clientId, String jmsSelector, boolean useAuth, String securityPrincipal, String securityCredentials) throws NamingException, javax.jms.JMSException Constructor takes the necessary JNDI related parameters to create a connection and prepare to begin receiving messages.
The caller must then invokestart()to enable message reception.- Parameters:
useProps- iftrue, use jndi.properties instead ofinitialContextFactory,providerUrl,securityPrincipal,securityCredentialsinitialContextFactory- name of the initial context factory (will be ignored ifusePropsistrue)providerUrl- url of the provider (will be ignored ifusePropsistrue)connfactory- name of the object factory to look up in contextdestinationName- name of the destinationdurableSubscriptionId- id for a durable subscription (if empty ornullno durable subscription will be done)clientId- client id to use (may be empty ornull)jmsSelector- Message SelectoruseAuth- flag whether auth should be used (will be ignored ifusePropsistrue)securityPrincipal- name of the principal to use for auth (will be ignored ifusePropsistrue)securityCredentials- credentials for the principal (will be ignored ifusePropsistrue)- Throws:
javax.jms.JMSException- if could not create context or other problem occurred.NamingException- when lookup of context or destination fails
-
ReceiveSubscriber
public ReceiveSubscriber(int queueSize, boolean useProps, String initialContextFactory, String providerUrl, String connfactory, String destinationName, String durableSubscriptionId, String clientId, String jmsSelector, boolean useAuth, String securityPrincipal, String securityCredentials) throws NamingException, javax.jms.JMSException Constructor takes the necessary JNDI related parameters to create a connection and create an onMessageListener to prepare to begin receiving messages.
The caller must then invokestart()to enable message reception.- Parameters:
queueSize- maximum queue size, where aqueueSize<=0 means no limituseProps- iftrue, use jndi.properties instead ofinitialContextFactory,providerUrl,securityPrincipal,securityCredentialsinitialContextFactory- name of the initial context factory (will be ignored ifusePropsistrue)providerUrl- url of the provider (will be ignored ifusePropsistrue)connfactory- name of the object factory to look up in contextdestinationName- name of the destinationdurableSubscriptionId- id for a durable subscription (if empty ornullno durable subscription will be done)clientId- client id to use (may be empty ornull)jmsSelector- Message SelectoruseAuth- flag whether auth should be used (will be ignored ifusePropsistrue)securityPrincipal- name of the principal to use for auth (will be ignored ifusePropsistrue)securityCredentials- credentials for the principal (will be ignored ifusePropsistrue)- Throws:
javax.jms.JMSException- if could not create context or other problem occurred.NamingException- when lookup of context or destination fails
-
-
Method Details
-
start
public void start() throws javax.jms.JMSExceptionCalls Connection.start() to begin receiving inbound messages.- Throws:
javax.jms.JMSException- when starting the context fails
-
stop
public void stop() throws javax.jms.JMSExceptionCalls Connection.stop() to stop receiving inbound messages.- Throws:
javax.jms.JMSException- when stopping the context fails
-
getMessage
public javax.jms.Message getMessage(long timeout) throws javax.jms.JMSException Get the next message ornull.Never blocks for longer than the specified timeout.
- Parameters:
timeout- in milliseconds- Returns:
- the next message or
null - Throws:
javax.jms.JMSException- when receiving the message fails
-
close
public void close()close() will stop the connection first. Then it closes the subscriber, session and connection.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable
-
onMessage
public void onMessage(javax.jms.Message message) - Specified by:
onMessagein interfacejavax.jms.MessageListener
-