Package org.apache.qpid.jms.provider.amqp.builders

Class AmqpConsumerBuilder

java.lang.Object

org.apache.qpid.jms.provider.amqp.builders.AmqpResourceBuilder<AmqpConsumer,AmqpSession,JmsConsumerInfo,org.apache.qpid.proton.engine.Receiver>

org.apache.qpid.jms.provider.amqp.builders.AmqpConsumerBuilder

All Implemented Interfaces:

AmqpEventSink, AmqpExceptionBuilder

public class AmqpConsumerBuilder
extends AmqpResourceBuilder<AmqpConsumer,AmqpSession,JmsConsumerInfo,org.apache.qpid.proton.engine.Receiver>

Resource builder responsible for creating and opening an AmqpConsumer instance.

Field Summary

Fields inherited from class org.apache.qpid.jms.provider.amqp.builders.AmqpResourceBuilder

endpoint, parent, provider, request, requestTimeoutTask, resource, resourceInfo

Constructor Summary

Constructors

Constructor	Description
AmqpConsumerBuilder(AmqpSession parent, JmsConsumerInfo consumerInfo)

Method Summary

Modifier and Type	Method	Description
protected void	afterClosed(AmqpConsumer resource, JmsConsumerInfo info)	Called if endpoint opening process fails in order to give the subclasses a place to perform any follow-on processing or teardown steps before the operation is deemed to have been completed and failure is signalled.
protected void	afterOpened()	Called once an endpoint has been opened and validated to give the subclasses a place to perform any follow-on processing or setup steps before the operation is deemed to have been completed and success is signaled.
protected org.apache.qpid.proton.engine.Receiver	createEndpoint(JmsConsumerInfo resourceInfo)	Given the resource information provided create and configure the local endpoint whose open phase is managed by this builder.
protected AmqpConsumer	createResource(AmqpSession parent, JmsConsumerInfo resourceInfo, org.apache.qpid.proton.engine.Receiver endpoint)	Create the managed resource instance.
protected ProviderException	getDefaultOpenAbortException()	When aborting the open operation, and there isn't an error condition, provided by the peer, the returned exception will be used instead.
protected boolean	isClosePending()	If the resource was opened but its current state indicates a close is pending then we do no need to proceed further into the resource creation process.
void	processRemoteDetach(AmqpProvider provider)	Event handler for remote peer detach of this resource.

Methods inherited from class org.apache.qpid.jms.provider.amqp.builders.AmqpResourceBuilder

buildResource, createException, getEndpoint, getOpenAbortExceptionFromRemote, getParent, getRequest, getRequestTimeout, getResource, getResourceInfo, handleClosed, handleOpened, hasRemoteError, isOpenedEndpointValid, processDeliveryUpdates, processFlowUpdates, processRemoteClose, processRemoteOpen

Methods inherited from class java.lang.Object

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

Constructor Detail

AmqpConsumerBuilder

public AmqpConsumerBuilder(AmqpSession parent,
                           JmsConsumerInfo consumerInfo)

Method Detail

createEndpoint

protected org.apache.qpid.proton.engine.Receiver createEndpoint(JmsConsumerInfo resourceInfo)

Description copied from class: AmqpResourceBuilder

Given the resource information provided create and configure the local endpoint whose open phase is managed by this builder.

Specified by:

createEndpoint in class AmqpResourceBuilder<AmqpConsumer,AmqpSession,JmsConsumerInfo,org.apache.qpid.proton.engine.Receiver>

Returns:

a new endpoint to be managed.

afterOpened

protected void afterOpened()

Description copied from class: AmqpResourceBuilder

Called once an endpoint has been opened and validated to give the subclasses a place to perform any follow-on processing or setup steps before the operation is deemed to have been completed and success is signaled.

Overrides:

afterOpened in class AmqpResourceBuilder<AmqpConsumer,AmqpSession,JmsConsumerInfo,org.apache.qpid.proton.engine.Receiver>

afterClosed

protected void afterClosed(AmqpConsumer resource,
                           JmsConsumerInfo info)

Description copied from class: AmqpResourceBuilder

Called if endpoint opening process fails in order to give the subclasses a place to perform any follow-on processing or teardown steps before the operation is deemed to have been completed and failure is signalled.

Overrides:

afterClosed in class AmqpResourceBuilder<AmqpConsumer,AmqpSession,JmsConsumerInfo,org.apache.qpid.proton.engine.Receiver>

Parameters:

resource - the resource

info - the resourceInfo

processRemoteDetach

public void processRemoteDetach(AmqpProvider provider)

Description copied from interface: AmqpEventSink

Event handler for remote peer detach of this resource.

Specified by:

processRemoteDetach in interface AmqpEventSink

Overrides:

processRemoteDetach in class AmqpResourceBuilder<AmqpConsumer,AmqpSession,JmsConsumerInfo,org.apache.qpid.proton.engine.Receiver>

Parameters:

provider - the AmqpProvider instance for easier access to fire events.

createResource

protected AmqpConsumer createResource(AmqpSession parent,
                                      JmsConsumerInfo resourceInfo,
                                      org.apache.qpid.proton.engine.Receiver endpoint)

Description copied from class: AmqpResourceBuilder

Create the managed resource instance.

Specified by:

createResource in class AmqpResourceBuilder<AmqpConsumer,AmqpSession,JmsConsumerInfo,org.apache.qpid.proton.engine.Receiver>

Parameters:

parent - The parent of the newly created resource.

resourceInfo - The resource information used to configure the resource.

endpoint - The local endpoint for the managed resource to wrap.

Returns:

the resource instance who open life-cycle is managed by this builder.

getDefaultOpenAbortException

protected ProviderException getDefaultOpenAbortException()

Description copied from class: AmqpResourceBuilder

When aborting the open operation, and there isn't an error condition, provided by the peer, the returned exception will be used instead. A subclass may override this method to provide alternative behavior.

Overrides:

getDefaultOpenAbortException in class AmqpResourceBuilder<AmqpConsumer,AmqpSession,JmsConsumerInfo,org.apache.qpid.proton.engine.Receiver>

Returns:

an Exception to describes the open failure for this resource.

isClosePending

protected boolean isClosePending()

Description copied from class: AmqpResourceBuilder

If the resource was opened but its current state indicates a close is pending then we do no need to proceed further into the resource creation process. Each endpoint build must implement this and examine the opened endpoint to determine if a close frame will follow the open.

Specified by:

isClosePending in class AmqpResourceBuilder<AmqpConsumer,AmqpSession,JmsConsumerInfo,org.apache.qpid.proton.engine.Receiver>

Returns:

true if the resource state indicates it will be immediately closed.