public interface Provider
Modifier and Type | Method and Description |
---|---|
void |
acknowledge(JmsInboundMessageDispatch envelope,
ProviderConstants.ACK_TYPE ackType,
AsyncResult request)
Called to acknowledge a JmsMessage has been delivered, consumed, re-delivered...etc.
|
void |
acknowledge(JmsSessionId sessionId,
ProviderConstants.ACK_TYPE ackType,
AsyncResult request)
Called to acknowledge all messages that have been delivered in a given session.
|
void |
close()
Closes this Provider terminating all connections and canceling any pending
operations.
|
void |
commit(JmsTransactionInfo transactionInfo,
AsyncResult request)
Called to commit an open transaction.
|
void |
connect()
Performs the initial low level connection for this provider such as TCP or
SSL connection to a remote Broker.
|
void |
create(JmsResource resource,
AsyncResult request)
Create the Provider version of the given JmsResource.
|
void |
destroy(JmsResource resource,
AsyncResult request)
Instruct the Provider to dispose of a given JmsResource.
|
JmsMessageFactory |
getMessageFactory()
Gets the Provider specific Message factory for use in the JMS layer when a Session
is asked to create a Message type.
|
ProviderListener |
getProviderListener()
Gets the currently set ProdiverListener instance.
|
URI |
getRemoteURI()
Returns the URI used to configure this Provider and specify the remote address of the
Broker it connects to.
|
void |
pull(JmsConsumerId consumerId,
long timeout,
AsyncResult request)
Request a remote peer send a Message to this client.
|
void |
recover(JmsSessionId sessionId,
AsyncResult request)
Called to recover all unacknowledged messages for a Session in client Ack mode.
|
void |
rollback(JmsTransactionInfo transactionInfo,
AsyncResult request)
Called to roll back an open transaction.
|
void |
send(JmsOutboundMessageDispatch envelope,
AsyncResult request)
Sends the JmsMessage contained in the outbound dispatch envelope.
|
void |
setProviderListener(ProviderListener listener)
Sets the listener of events from this Provider instance.
|
void |
start()
Starts the Provider.
|
void |
start(JmsResource resource,
AsyncResult request)
Starts the Provider version of the given JmsResource.
|
void |
stop(JmsResource resource,
AsyncResult request)
Stops (pauses) the Provider version of the given JmsResource, the resource would then
need to be started again via a call to
start()
For some JMS Resources it is necessary or advantageous to have a stopped state that
can be triggered to stop the resource generating new events or messages. |
void |
unsubscribe(String subscription,
AsyncResult request)
Remove a durable topic subscription by name.
|
void connect() throws IOException
IOException
- if the remote resource can not be contacted.void start() throws IOException, IllegalStateException
IOException
- if an error occurs during start processing.IllegalStateException
- if the Provider is improperly configured.void close()
URI getRemoteURI()
void create(JmsResource resource, AsyncResult request) throws IOException, javax.jms.JMSException
resource
- The JmsResouce instance that indicates what is being created.request
- The request object that should be signaled when this operation completes.IOException
- if an error occurs or the Provider is already closed.javax.jms.JMSException
- if an error occurs due to JMS violation such as bad credentials.void start(JmsResource resource, AsyncResult request) throws IOException, javax.jms.JMSException
resource
- The JmsResouce instance that indicates what is being started.request
- The request object that should be signaled when this operation completes.IOException
- if an error occurs or the Provider is already closed.javax.jms.JMSException
- if an error occurs due to JMS violation such as already closed resource.void stop(JmsResource resource, AsyncResult request) throws IOException, javax.jms.JMSException
start()
For some JMS Resources it is necessary or advantageous to have a stopped state that
can be triggered to stop the resource generating new events or messages.
An example of this would be a JMS Session which should not receive any incoming messages
for any consumers until the JMS layer is in a state to handle them. One such time would be
during a transaction rollback. A JMS Session should normally ensure that messages received
in a transaction are set to be redelivered prior to any new deliveries on a transaction
rollback.
The provider is required to implement this method and not throw any error other than
an IOException if a communication error occurs. The stop operation is not required to
have any effect on the provider resource but must not throw UnsupportedOperation etc.resource
- The JmsResouce instance that indicates what is being stopped.request
- The request object that should be signaled when this operation completes.IOException
- if an error occurs or the Provider is already closed.javax.jms.JMSException
- if an error occurs due to JMS violation such as already closed resource.void destroy(JmsResource resource, AsyncResult request) throws IOException, javax.jms.JMSException
resource
- The JmsResouce that identifies a previously created JmsResource.request
- The request object that should be signaled when this operation completes.IOException
- if an error occurs or the Provider is already closed.javax.jms.JMSException
- if an error occurs due to JMS violation such as not authorized.void send(JmsOutboundMessageDispatch envelope, AsyncResult request) throws IOException, javax.jms.JMSException
envelope
- the message envelope containing the JmsMessage to send.request
- The request object that should be signaled when this operation completes.IOException
- if an error occurs or the Provider is already closed.javax.jms.JMSException
- if an error that maps to JMS occurs such as not authorized.void acknowledge(JmsSessionId sessionId, ProviderConstants.ACK_TYPE ackType, AsyncResult request) throws IOException, javax.jms.JMSException
sessionId
- the ID of the Session whose delivered messages should be acknowledged.ackType
- The type of acknowledgement being done.request
- The request object that should be signaled when this operation completes.IOException
- if an error occurs or the Provider is already closed.javax.jms.JMSException
- if an error occurs due to JMS violation such as unmatched ack.void acknowledge(JmsInboundMessageDispatch envelope, ProviderConstants.ACK_TYPE ackType, AsyncResult request) throws IOException, javax.jms.JMSException
envelope
- The message dispatch envelope containing the Message delivery information.ackType
- The type of acknowledgement being done.request
- The request object that should be signaled when this operation completes.IOException
- if an error occurs or the Provider is already closed.javax.jms.JMSException
- if an error occurs due to JMS violation such as unmatched ack.void commit(JmsTransactionInfo transactionInfo, AsyncResult request) throws IOException, javax.jms.JMSException
transactionInfo
- the transaction info that describes the transaction being committed.request
- The request object that should be signaled when this operation completes.IOException
- if an error occurs or the Provider is already closed.javax.jms.JMSException
- if an error occurs due to JMS violation such not authorized.void rollback(JmsTransactionInfo transactionInfo, AsyncResult request) throws IOException, javax.jms.JMSException
transactionInfo
- the transaction info that describes the transaction being rolled back.request
- The request object that should be signaled when this operation completes.IOException
- if an error occurs or the Provider is already closed.javax.jms.JMSException
- if an error occurs due to JMS violation such not authorized.void recover(JmsSessionId sessionId, AsyncResult request) throws IOException
sessionId
- the Id of the JmsSession that is recovering unacknowledged messages..request
- The request object that should be signaled when this operation completes.IOException
- if an error occurs or the Provider is already closed.void unsubscribe(String subscription, AsyncResult request) throws IOException, javax.jms.JMSException
subscription
- the name of the durable subscription that is to be removed.request
- The request object that should be signaled when this operation completes.IOException
- if an error occurs or the Provider is already closed.javax.jms.JMSException
- if an error occurs due to JMS violation such not authorized.void pull(JmsConsumerId consumerId, long timeout, AsyncResult request) throws IOException
consumerId
- the ID of the Consumer instance that is attempt to pull a message from the remote.timeout
- the amount of time to tell the remote peer to keep this pull request valid.request
- The request object that should be signaled when this operation completes.IOException
- if an error occurs or the Provider is already closed.JmsMessageFactory getMessageFactory()
void setProviderListener(ProviderListener listener)
listener
- The listener instance that will receive all event callbacks.ProviderListener getProviderListener()
Copyright © 2013–2016 The Apache Software Foundation. All rights reserved.