org.apache.camel.component.jgroups

Class JGroupsEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.jgroups.JGroupsEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="2.13.0",
             scheme="jgroups",
             title="JGroups",
             syntax="jgroups:clusterName",
             consumerClass=JGroupsConsumer.class,
             label="clustering,messaging")
public class JGroupsEndpoint
extends org.apache.camel.impl.DefaultEndpoint

The jgroups component provides exchange of messages between Camel and JGroups clusters.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADER_JGROUPS_CHANNEL_ADDRESS
static String	HEADER_JGROUPS_DEST
static String	HEADER_JGROUPS_ORIGINAL_MESSAGE
static String	HEADER_JGROUPS_SRC

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

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

Constructor Summary

Constructors

Constructor and Description
JGroupsEndpoint(String endpointUri, org.apache.camel.Component component, org.jgroups.JChannel channel, String clusterName, String channelProperties, boolean enableViewMessages)

Method Summary

Modifier and Type	Method and Description
void	connect() Connect shared channel, called by producer and consumer.
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Exchange	createExchange()
org.apache.camel.Exchange	createExchange(org.jgroups.Message message)
org.apache.camel.Exchange	createExchange(org.jgroups.View view)
org.apache.camel.Producer	createProducer()
void	disconnect() Disconnect shared channel, called by producer and consumer.
protected void	doStart()
protected void	doStop()
org.jgroups.JChannel	getChannel()
String	getChannelProperties()
String	getClusterName()
boolean	isEnableViewMessages()
boolean	isSingleton()
void	setChannel(org.jgroups.JChannel channel) The channel to use
void	setChannelProperties(String channelProperties) Specifies configuration properties of the JChannel used by the endpoint.
void	setClusterName(String clusterName) The name of the JGroups cluster the component should connect to.
void	setEnableViewMessages(boolean enableViewMessages) If set to true, the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances).

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

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, 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, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.Service

start, stop

Field Detail

HEADER_JGROUPS_ORIGINAL_MESSAGE

public static final String HEADER_JGROUPS_ORIGINAL_MESSAGE

See Also:

Constant Field Values

HEADER_JGROUPS_SRC

public static final String HEADER_JGROUPS_SRC

See Also:

Constant Field Values

HEADER_JGROUPS_DEST

public static final String HEADER_JGROUPS_DEST

See Also:

Constant Field Values

HEADER_JGROUPS_CHANNEL_ADDRESS

public static final String HEADER_JGROUPS_CHANNEL_ADDRESS

See Also:

Constant Field Values

Constructor Detail

JGroupsEndpoint

public JGroupsEndpoint(String endpointUri,
                       org.apache.camel.Component component,
                       org.jgroups.JChannel channel,
                       String clusterName,
                       String channelProperties,
                       boolean enableViewMessages)

Method Detail

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

isSingleton

public boolean isSingleton()

createExchange

public org.apache.camel.Exchange createExchange(org.jgroups.Message message)

createExchange

public org.apache.camel.Exchange createExchange(org.jgroups.View view)

createExchange

public org.apache.camel.Exchange createExchange()

Specified by:

createExchange in interface org.apache.camel.Endpoint

Overrides:

createExchange in class org.apache.camel.impl.DefaultEndpoint

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.apache.camel.impl.DefaultEndpoint

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.apache.camel.impl.DefaultEndpoint

Throws:

Exception

connect

public void connect()
             throws Exception

Connect shared channel, called by producer and consumer.

Throws:

Exception

disconnect

public void disconnect()

Disconnect shared channel, called by producer and consumer.

getChannel

public org.jgroups.JChannel getChannel()

setChannel

public void setChannel(org.jgroups.JChannel channel)

The channel to use

getClusterName

public String getClusterName()

setClusterName

public void setClusterName(String clusterName)

The name of the JGroups cluster the component should connect to.

getChannelProperties

public String getChannelProperties()

setChannelProperties

public void setChannelProperties(String channelProperties)

Specifies configuration properties of the JChannel used by the endpoint.

isEnableViewMessages

public boolean isEnableViewMessages()

setEnableViewMessages

public void setEnableViewMessages(boolean enableViewMessages)

If set to true, the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances). By default only regular messages are consumed by the endpoint.