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

Class AmqpResourceBuilder<TARGET extends AmqpResource,PARENT extends AmqpResourceParent,INFO extends JmsResource,ENDPOINT extends org.apache.qpid.proton.engine.Endpoint>

java.lang.Object

org.apache.qpid.jms.provider.amqp.builders.AmqpResourceBuilder<TARGET,PARENT,INFO,ENDPOINT>

Type Parameters:

TARGET - The Type of resource that will be created.

PARENT - The Type of this resource's parent.

INFO - The Type of JmsResource used to describe the target resource.

ENDPOINT - The AMQP Endpoint that the target resource encapsulates.

All Implemented Interfaces:

AmqpEventSink

Direct Known Subclasses:

AmqpConnectionBuilder, AmqpConsumerBuilder, AmqpProducerBuilder, AmqpSessionBuilder, AmqpTemporaryDestinationBuilder, AmqpTransactionCoordinatorBuilder

public abstract class AmqpResourceBuilder<TARGET extends AmqpResource,PARENT extends AmqpResourceParent,INFO extends JmsResource,ENDPOINT extends org.apache.qpid.proton.engine.Endpoint>
extends Object
implements AmqpEventSink

Base for all AmqpResource builders.

Field Summary

Fields

Modifier and Type	Field and Description
protected ENDPOINT	endpoint
protected PARENT	parent
protected AsyncResult	request
protected ScheduledFuture<?>	requestTimeoutTask
protected TARGET	resource
protected INFO	resourceInfo

Constructor Summary

Constructors

Constructor and Description
AmqpResourceBuilder(PARENT parent, INFO resourceInfo)

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	buildResource(AsyncResult request) Called to initiate the process of building the resource type that is managed by this builder.
protected abstract ENDPOINT	createEndpoint(INFO resourceInfo) Given the resource information provided create and configure the local endpoint whose open phase is managed by this builder.
protected abstract TARGET	createResource(PARENT parent, INFO resourceInfo, ENDPOINT endpoint) Create the managed resource instance.
ENDPOINT	getEndpoint()
protected Exception	getOpenAbortException() When aborting the open operation, and there isn't an error condition, provided by the peer, the returned exception will be used instead.
PARENT	getParent()
AsyncResult	getRequest()
TARGET	getResource()
INFO	getResourceInfo()
protected void	handleClosed(AmqpProvider provider)
protected void	handleOpened(AmqpProvider provider)
protected boolean	hasRemoteError()
protected abstract 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.
protected boolean	isOpenedEndpointValid() Following the open of the endpoint implementations of this method should validate that the endpoint properties match what was requested.
void	processDeliveryUpdates(AmqpProvider provider) Called when the Proton Engine signals an Delivery related event has been triggered for the given endpoint.
void	processFlowUpdates(AmqpProvider provider) Called when the Proton Engine signals an Flow related event has been triggered for the given endpoint.
void	processRemoteClose(AmqpProvider provider) Event handler for remote peer close of this resource.
void	processRemoteDetach(AmqpProvider provider) Event handler for remote peer detach of this resource.
void	processRemoteOpen(AmqpProvider provider) Event handler for remote peer open of this resource.

Methods inherited from class java.lang.Object

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

Field Detail

request

protected AsyncResult request

requestTimeoutTask

protected ScheduledFuture<?> requestTimeoutTask

resource

protected TARGET extends AmqpResource resource

endpoint

protected ENDPOINT extends org.apache.qpid.proton.engine.Endpoint endpoint

parent

protected final PARENT extends AmqpResourceParent parent

resourceInfo

protected final INFO extends JmsResource resourceInfo

Constructor Detail

AmqpResourceBuilder

public AmqpResourceBuilder(PARENT parent,
                   INFO resourceInfo)

Method Detail

buildResource

public void buildResource(AsyncResult request)

Called to initiate the process of building the resource type that is managed by this builder. The resource is created and the open process occurs asynchronously. If the resource is successfully opened it will added to its parent resource for use.

Parameters:

request - The request that initiated the resource creation.

processRemoteOpen

public void processRemoteOpen(AmqpProvider provider)
                       throws IOException

Description copied from interface: AmqpEventSink

Event handler for remote peer open of this resource.

Specified by:

processRemoteOpen in interface AmqpEventSink

Parameters:

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

Throws:

IOException - if an error occurs while processing the update.

processRemoteClose

public void processRemoteClose(AmqpProvider provider)
                        throws IOException

Description copied from interface: AmqpEventSink

Event handler for remote peer close of this resource.

Specified by:

processRemoteClose in interface AmqpEventSink

Parameters:

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

Throws:

IOException - if an error occurs while processing the update.

processRemoteDetach

public void processRemoteDetach(AmqpProvider provider)
                         throws IOException

Description copied from interface: AmqpEventSink

Event handler for remote peer detach of this resource.

Specified by:

processRemoteDetach in interface AmqpEventSink

Parameters:

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

Throws:

IOException - if an error occurs while processing the update.

processDeliveryUpdates

public void processDeliveryUpdates(AmqpProvider provider)
                            throws IOException

Description copied from interface: AmqpEventSink

Called when the Proton Engine signals an Delivery related event has been triggered for the given endpoint.

Specified by:

processDeliveryUpdates in interface AmqpEventSink

Parameters:

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

Throws:

IOException - if an error occurs while processing the update.

processFlowUpdates

public void processFlowUpdates(AmqpProvider provider)
                        throws IOException

Description copied from interface: AmqpEventSink

Called when the Proton Engine signals an Flow related event has been triggered for the given endpoint.

Specified by:

processFlowUpdates in interface AmqpEventSink

Parameters:

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

Throws:

IOException - if an error occurs while processing the update.

handleOpened

protected final void handleOpened(AmqpProvider provider)

handleClosed

protected final void handleClosed(AmqpProvider provider)

createEndpoint

protected abstract ENDPOINT createEndpoint(INFO resourceInfo)

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

Returns:

a new endpoint to be managed.

createResource

protected abstract TARGET createResource(PARENT parent,
                    INFO resourceInfo,
                    ENDPOINT endpoint)

Create the managed resource instance.

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.

isClosePending

protected abstract 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. Each endpoint build must implement this and examine the opened endpoint to determine if a close frame will follow the open.

Returns:

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

isOpenedEndpointValid

protected boolean isOpenedEndpointValid()

Following the open of the endpoint implementations of this method should validate that the endpoint properties match what was requested.

Returns:

true if the endpoint is valid based on what was requested.

afterOpened

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.

hasRemoteError

protected boolean hasRemoteError()

getOpenAbortException

protected Exception getOpenAbortException()

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.

getEndpoint

public ENDPOINT getEndpoint()

getRequest

public AsyncResult getRequest()

getResource

public TARGET getResource()

getParent

public PARENT getParent()

getResourceInfo

public INFO getResourceInfo()