org.apache.camel.component.jms

Class JmsQueueEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.jms.JmsEndpoint

org.apache.camel.component.jms.JmsQueueEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, MultipleConsumersSupport, Service, ShutdownableService, BrowsableEndpoint, HasId, HeaderFilterStrategyAware, StatefulService, SuspendableService

Direct Known Subclasses:

JmsTemporaryQueueEndpoint

@ManagedResource(description="Managed JMS Queue Endpoint")
public class JmsQueueEndpoint
extends JmsEndpoint
implements BrowsableEndpoint

An endpoint for a JMS Queue which is also browsable

Version:

Field Summary

Fields inherited from class org.apache.camel.component.jms.JmsEndpoint

log

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
JmsQueueEndpoint(javax.jms.Queue destination)
JmsQueueEndpoint(String uri, JmsComponent component, String destination, JmsConfiguration configuration)
JmsQueueEndpoint(String uri, JmsComponent component, String destination, JmsConfiguration configuration, QueueBrowseStrategy queueBrowseStrategy)
JmsQueueEndpoint(String endpointUri, String destination)
JmsQueueEndpoint(String endpointUri, String destination, QueueBrowseStrategy queueBrowseStrategy)

Method Summary

Methods

Modifier and Type	Method and Description
String	browseAllMessagesAsXml(Boolean includeBody)
String	browseExchange(Integer index)
String	browseMessageAsXml(Integer index, Boolean includeBody)
String	browseMessageBody(Integer index)
String	browseRangeMessagesAsXml(Integer fromIndex, Integer toIndex, Boolean includeBody)
protected QueueBrowseStrategy	createQueueBrowseStrategy()
List<Exchange>	getExchanges() Return the exchanges available on this endpoint
int	getMaximumBrowseSize()
long	queueSize()
void	setMaximumBrowseSize(int maximumBrowseSize) If a number is set > 0 then this limits the number of messages that are returned when browsing the queue

Methods inherited from class org.apache.camel.component.jms.JmsEndpoint

configureListenerContainer, createConsumer, createConsumer, createEndpointUri, createExchange, createExchange, createInOnlyTemplate, createInOutTemplate, createMessageListenerContainer, createPollingConsumer, createProducer, getAcknowledgementMode, getAcknowledgementModeName, getAsyncStartStopExecutorService, getBinding, getCacheLevel, getCacheLevelName, getCamelId, getCamelManagementName, getClientId, getComponent, getConcurrentConsumers, getConfiguration, getConnectionFactory, getDefaultTaskExecutorType, getDeliveryMode, getDestination, getDestinationName, getDestinationResolver, getDestinationType, getDurableSubscriptionName, getEndpointConfiguredDestinationName, getEndpointUri, getErrorHandler, getErrorHandlerLoggingLevel, getExceptionListener, getHeaderFilterStrategy, getIdleConsumerLimit, getIdleTaskExecutionLimit, getJmsKeyFormatStrategy, getJmsMessageType, getJmsOperations, getListenerConnectionFactory, getMaxConcurrentConsumers, getMaxMessagesPerTask, getMessageConverter, getMessageListenerContainerFactory, getMetadataJmsOperations, getMetadataJmsOperations, getPriority, getProviderMetadata, getReceiveTimeout, getRecoveryInterval, getReplyTo, getReplyToCacheLevelName, getReplyToDestinationSelectorName, getReplyToType, getRequestTimeout, getRequestTimeoutCheckerInterval, getRunningMessageListeners, getSelector, getState, getTaskExecutor, getTemplateConnectionFactory, getTemporaryQueueType, getTemporaryTopicType, getThreadName, getTimeToLive, getTransactionManager, getTransactionName, getTransactionTimeout, isAcceptMessagesWhileStopping, isAllowNullBody, isAlwaysCopyMessage, isAsyncConsumer, isAsyncStartListener, isAsyncStopListener, isAutoStartup, isDeliveryPersistent, isDisableReplyTo, isDisableTimeToLive, isEagerLoadingOfProperties, isErrorHandlerLogStackTrace, isExplicitQosEnabled, isExposeListenerSession, isForceSendOriginalMessage, isIncludeAllJMSXProperties, isIncludeSentJMSMessageID, isLazyCreateTransactionManager, isMessageIdEnabled, isMessageTimestampEnabled, isMultipleConsumersSupported, isPreserveMessageQos, isPubSubDomain, isPubSubNoLocal, isReplyToDeliveryPersistent, isRunning, isSingleton, isSubscriptionDurable, isTestConnectionOnStartup, isTransacted, isTransactedInOut, isTransferException, isTransferExchange, isUseMessageIDAsCorrelationID, newInstance, newInstance, onListenerContainerStarting, onListenerContainerStopped, setAcceptMessagesWhileStopping, setAcknowledgementMode, setAcknowledgementModeName, setAllowNullBody, setAlwaysCopyMessage, setAsyncConsumer, setAsyncStartListener, setAsyncStopListener, setAutoStartup, setBinding, setCacheLevel, setCacheLevelName, setClientId, setConcurrentConsumers, setConfiguration, setConnectionFactory, setDefaultTaskExecutorType, setDeliveryMode, setDeliveryPersistent, setDestination, setDestinationName, setDestinationResolver, setDestinationType, setDisableReplyTo, setDisableTimeToLive, setDurableSubscriptionName, setEagerLoadingOfProperties, setErrorHandler, setErrorHandlerLogStackTrace, setExceptionListener, setExplicitQosEnabled, setExposeListenerSession, setForceSendOriginalMessage, setHeaderFilterStrategy, setIdleConsumerLimit, setIdleTaskExecutionLimit, setIncludeAllJMSXProperties, setIncludeSentJMSMessageID, setJmsKeyFormatStrategy, setJmsMessageType, setJmsOperations, setLazyCreateTransactionManager, setListenerConnectionFactory, setMaxConcurrentConsumers, setMaxMessagesPerTask, setMessageConverter, setMessageIdEnabled, setMessageListenerContainerFactory, setMessageTimestampEnabled, setMetadataJmsOperations, setPreserveMessageQos, setPriority, setProviderMetadata, setPubSubNoLocal, setReceiveTimeout, setRecoveryInterval, setReplyTo, setReplyToCacheLevelName, setReplyToDeliveryPersistent, setReplyToDestinationSelectorName, setReplyToType, setRequestTimeout, setSelector, setSubscriptionDurable, setTaskExecutor, setTemplateConnectionFactory, setTestConnectionOnStartup, setTimeToLive, setTransacted, setTransactedInOut, setTransactionManager, setTransactionName, setTransactionTimeout, setTransferException, setTransferExchange, setUseMessageIDAsCorrelationID, shutdown, stop

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createExchange, createExchange, doStart, doStop, equals, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getExchangePattern, getId, getPollingConsumerQueueSize, hashCode, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, resume, start, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Endpoint

configureProperties, createConsumer, createExchange, createExchange, createExchange, createPollingConsumer, createProducer, getCamelContext, getEndpointConfiguration, getEndpointKey, getEndpointUri, isLenientProperties, setCamelContext

Methods inherited from interface org.apache.camel.IsSingleton

isSingleton

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

JmsQueueEndpoint

public JmsQueueEndpoint(javax.jms.Queue destination)
                 throws javax.jms.JMSException

Throws:

javax.jms.JMSException

JmsQueueEndpoint

public JmsQueueEndpoint(String uri,
                JmsComponent component,
                String destination,
                JmsConfiguration configuration)

JmsQueueEndpoint

public JmsQueueEndpoint(String uri,
                JmsComponent component,
                String destination,
                JmsConfiguration configuration,
                QueueBrowseStrategy queueBrowseStrategy)

JmsQueueEndpoint

public JmsQueueEndpoint(String endpointUri,
                String destination,
                QueueBrowseStrategy queueBrowseStrategy)

JmsQueueEndpoint

public JmsQueueEndpoint(String endpointUri,
                String destination)

Method Detail

getMaximumBrowseSize

@ManagedAttribute
public int getMaximumBrowseSize()

setMaximumBrowseSize

@ManagedAttribute
public void setMaximumBrowseSize(int maximumBrowseSize)

If a number is set > 0 then this limits the number of messages that are returned when browsing the queue

getExchanges

public List<Exchange> getExchanges()

Description copied from interface: BrowsableEndpoint

Return the exchanges available on this endpoint

Specified by:

getExchanges in interface BrowsableEndpoint

Returns:

the exchanges on this endpoint

queueSize

@ManagedOperation(description="Current number of Exchanges in Queue")
public long queueSize()

browseExchange

@ManagedOperation(description="Get Exchange from queue by index")
public String browseExchange(Integer index)

browseMessageBody

@ManagedOperation(description="Get message body from queue by index")
public String browseMessageBody(Integer index)

browseMessageAsXml

@ManagedOperation(description="Get message as XML from queue by index")
public String browseMessageAsXml(Integer index,
                                                    Boolean includeBody)

browseAllMessagesAsXml

@ManagedOperation(description="Gets all the messages as XML from the queue")
public String browseAllMessagesAsXml(Boolean includeBody)

browseRangeMessagesAsXml

@ManagedOperation(description="Gets the range of messages as XML from the queue")
public String browseRangeMessagesAsXml(Integer fromIndex,
                                                          Integer toIndex,
                                                          Boolean includeBody)

createQueueBrowseStrategy

protected QueueBrowseStrategy createQueueBrowseStrategy()