public class AmqpProvider extends Object implements Provider, TransportListener, AmqpResourceParent
Constructor and Description |
---|
AmqpProvider(URI remoteURI)
Create a new instance of an AmqpProvider bonded to the given remote URI.
|
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 |
addChildResource(AmqpResource resource)
Adds the given resource as a child of this resource so that it's
lifetime becomes managed by that of its parent.
|
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.
|
int |
getChannelMax() |
long |
getCloseTimeout() |
long |
getConnectTimeout() |
int |
getIdleTimeout() |
int |
getMaxFrameSize() |
JmsMessageFactory |
getMessageFactory()
Gets the Provider specific Message factory for use in the JMS layer when a Session
is asked to create a Message type.
|
org.apache.qpid.proton.engine.Connection |
getProtonConnection() |
org.apache.qpid.proton.engine.Transport |
getProtonTransport() |
AmqpProvider |
getProvider() |
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.
|
long |
getRequestTimeout() |
String[] |
getSaslMechanisms() |
long |
getSendTimeout() |
long |
getSessionOutgoingWindow() |
String |
getVhost() |
boolean |
isPresettleConsumers() |
boolean |
isPresettleProducers() |
boolean |
isSaslLayer() |
boolean |
isTraceBytes() |
boolean |
isTraceFrames() |
void |
onData(io.netty.buffer.ByteBuf input)
Called when new incoming data has become available.
|
void |
onTransportClosed()
Callback method for the Transport to report that the underlying connection
has closed.
|
void |
onTransportError(Throwable error)
Callback method for the Transport to report connection errors.
|
void |
pull(JmsConsumerId consumerId,
long timeout,
AsyncResult request)
Request a remote peer send a Message to this client.
|
protected boolean |
pumpToProtonTransport() |
protected boolean |
pumpToProtonTransport(AsyncResult request) |
void |
recover(JmsSessionId sessionId,
AsyncResult request)
Called to recover all unacknowledged messages for a Session in client Ack mode.
|
void |
removeChildResource(AmqpResource resource)
Removes the given resource from the registered child resources
managed by this one.
|
void |
rollback(JmsTransactionInfo transactionInfo,
AsyncResult request)
Called to roll back an open transaction.
|
ScheduledFuture<?> |
scheduleRequestTimeout(AsyncResult request,
long timeout,
Exception error)
Allows a resource to request that its parent resource schedule a future
cancellation of a request and return it a
Future instance that
can be used to cancel the scheduled automatic failure of the request. |
void |
send(JmsOutboundMessageDispatch envelope,
AsyncResult request)
Sends the JmsMessage contained in the outbound dispatch envelope.
|
void |
setChannelMax(int channelMax) |
void |
setIdleTimeout(int idleTimeout)
Sets the idle timeout (in milliseconds) after which the connection will
be closed if the peer has not send any data.
|
void |
setMaxFrameSize(int maxFrameSize)
Sets the max frame size (in bytes).
|
void |
setPresettle(boolean presettle) |
void |
setPresettleConsumers(boolean presettle) |
void |
setPresettleProducers(boolean presettle) |
void |
setProviderListener(ProviderListener listener)
Sets the listener of events from this Provider instance.
|
void |
setSaslLayer(boolean saslLayer)
Sets whether a sasl layer is used for the connection or not.
|
void |
setSaslMechanisms(String[] saslMechanisms)
Sets a selection of mechanisms to restrict the choice to, enabling only
a subset of the servers offered mechanisms to be selectable.
|
void |
setSessionOutgoingWindow(long sessionOutoingWindow)
Sets the outgoing window size for the AMQP session.
|
void |
setTraceBytes(boolean trace) |
void |
setTraceFrames(boolean trace) |
void |
setVhost(String vhost)
Sets the hostname to be used in the AMQP SASL Init and Open frames.
|
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. |
String |
toString() |
void |
unsubscribe(String subscription,
AsyncResult request)
Remove a durable topic subscription by name.
|
public AmqpProvider(URI remoteURI)
remoteURI
- The URI of the AMQP broker this Provider instance will connect to.public void connect() throws IOException
Provider
connect
in interface Provider
IOException
- if the remote resource can not be contacted.public void start() throws IOException, IllegalStateException
Provider
start
in interface Provider
IOException
- if an error occurs during start processing.IllegalStateException
- if the Provider is improperly configured.public void close()
Provider
public void create(JmsResource resource, AsyncResult request) throws IOException, javax.jms.JMSException
Provider
create
in interface Provider
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.public void start(JmsResource resource, AsyncResult request) throws IOException
Provider
start
in interface Provider
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.public void stop(JmsResource resource, AsyncResult request) throws IOException
Provider
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.stop
in interface Provider
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.public void destroy(JmsResource resource, AsyncResult request) throws IOException
Provider
destroy
in interface Provider
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.public void send(JmsOutboundMessageDispatch envelope, AsyncResult request) throws IOException
Provider
send
in interface Provider
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.public void acknowledge(JmsSessionId sessionId, ProviderConstants.ACK_TYPE ackType, AsyncResult request) throws IOException
Provider
acknowledge
in interface Provider
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.public void acknowledge(JmsInboundMessageDispatch envelope, ProviderConstants.ACK_TYPE ackType, AsyncResult request) throws IOException
Provider
acknowledge
in interface Provider
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.public void commit(JmsTransactionInfo transactionInfo, AsyncResult request) throws IOException
Provider
commit
in interface Provider
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.public void rollback(JmsTransactionInfo transactionInfo, AsyncResult request) throws IOException
Provider
rollback
in interface Provider
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.public void recover(JmsSessionId sessionId, AsyncResult request) throws IOException
Provider
recover
in interface Provider
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.public void unsubscribe(String subscription, AsyncResult request) throws IOException
Provider
unsubscribe
in interface Provider
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.public void pull(JmsConsumerId consumerId, long timeout, AsyncResult request) throws IOException
Provider
pull
in interface Provider
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.public void onData(io.netty.buffer.ByteBuf input)
TransportListener
onData
in interface TransportListener
input
- the next incoming packet of data.public void onTransportError(Throwable error)
onTransportError
in interface TransportListener
error
- the error that causes the transport to fail.public void onTransportClosed()
onTransportClosed
in interface TransportListener
protected boolean pumpToProtonTransport()
protected boolean pumpToProtonTransport(AsyncResult request)
public void addChildResource(AmqpResource resource)
AmqpResourceParent
addChildResource
in interface AmqpResourceParent
resource
- The AmqpResource that is a child of this one.public void removeChildResource(AmqpResource resource)
AmqpResourceParent
removeChildResource
in interface AmqpResourceParent
resource
- The AmqpResource that is no longer a child of this one.public JmsMessageFactory getMessageFactory()
Provider
getMessageFactory
in interface Provider
public void setTraceFrames(boolean trace)
public boolean isTraceFrames()
public void setTraceBytes(boolean trace)
public boolean isTraceBytes()
public boolean isSaslLayer()
public void setSaslLayer(boolean saslLayer)
saslLayer
- true to enable the sasl layer, false to disable it.public String[] getSaslMechanisms()
public void setSaslMechanisms(String[] saslMechanisms)
saslMechanisms
- the mechanisms to restrict choice to, or null not to restrict.public String getVhost()
public void setVhost(String vhost)
vhost
- the hostname to include in SASL Init and Open frames.public int getIdleTimeout()
public void setIdleTimeout(int idleTimeout)
idleTimeout
- the timeout in milliseconds.public int getMaxFrameSize()
public void setMaxFrameSize(int maxFrameSize)
maxFrameSize
- the frame size in bytes.public long getSessionOutgoingWindow()
public void setSessionOutgoingWindow(long sessionOutoingWindow)
sessionOutoingWindow
- the outgoing window sizepublic long getCloseTimeout()
public long getConnectTimeout()
public long getRequestTimeout()
public long getSendTimeout()
public void setPresettle(boolean presettle)
public boolean isPresettleConsumers()
public void setPresettleConsumers(boolean presettle)
public boolean isPresettleProducers()
public void setPresettleProducers(boolean presettle)
public int getChannelMax()
public void setChannelMax(int channelMax)
public void setProviderListener(ProviderListener listener)
Provider
setProviderListener
in interface Provider
listener
- The listener instance that will receive all event callbacks.public ProviderListener getProviderListener()
Provider
getProviderListener
in interface Provider
public URI getRemoteURI()
Provider
getRemoteURI
in interface Provider
public org.apache.qpid.proton.engine.Transport getProtonTransport()
public org.apache.qpid.proton.engine.Connection getProtonConnection()
public AmqpProvider getProvider()
getProvider
in interface AmqpResourceParent
public ScheduledFuture<?> scheduleRequestTimeout(AsyncResult request, long timeout, Exception error)
Future
instance that
can be used to cancel the scheduled automatic failure of the request.request
- The request that should be marked as failed based on configuration.timeout
- The time to wait before marking the request as failed.error
- The error to use when failing the pending request.ScheduledFuture
that can be stored by the caller.Copyright © 2013–2016 The Apache Software Foundation. All rights reserved.