org.apache.camel.component.jgroups.raft

Class JGroupsRaftEndpoint

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.jgroups.raft.JGroupsRaftEndpoint

All Implemented Interfaces:

AutoCloseable, 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.24.0",
             scheme="jgroups-raft",
             title="JGroups raft",
             syntax="jgroup-raft:clusterName",
             category={CLUSTERING,MESSAGING})
public class JGroupsRaftEndpoint
extends org.apache.camel.support.DefaultEndpoint

Exchange messages with JGroups-raft clusters.

Field Summary

Fields inherited from class org.apache.camel.support.service.BaseService

BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
JGroupsRaftEndpoint(String endpointUri, String clusterName, org.apache.camel.Component component, String remaining, Map<String,Object> parameters, String raftId, String channelProperties, org.jgroups.protocols.raft.StateMachine stateMachine, org.jgroups.raft.RaftHandle raftHandle)

Method Summary

Modifier and Type	Method and Description
void	connect() Connect shared RaftHandle channel, called by producer and consumer.
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
void	disconnect() Disconnect shared RaftHandle channel, called by producer and consumer.
protected void	doStart()
protected void	doStop()
String	getChannelProperties()
String	getClusterName()
org.jgroups.raft.RaftHandle	getRaftHandle()
String	getRaftId()
org.jgroups.raft.RaftHandle	getResolvedRaftHandle()
org.jgroups.protocols.raft.StateMachine	getStateMachine()
boolean	isEnableRoleChangeEvents()
void	populateJGroupsRaftHeaders(org.apache.camel.Exchange exchange)
void	setChannelProperties(String channelProperties)
void	setClusterName(String clusterName) The name of the JGroupsraft cluster the component should connect to.
void	setEnableRoleChangeEvents(boolean enableRoleChangeEvents) If set to true, the consumer endpoint will receive roleChange event as well (not just connecting and/or using the state machine).
void	setRaftHandle(org.jgroups.raft.RaftHandle raftHandle)
void	setRaftId(String raftId)
void	setStateMachine(org.jgroups.protocols.raft.StateMachine stateMachine)

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

configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

Methods inherited from class org.apache.camel.support.service.BaseService

build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, 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.Endpoint

getEndpointBaseUri, isSingletonProducer

Methods inherited from interface org.apache.camel.IsSingleton

test

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Constructor Detail

JGroupsRaftEndpoint

public JGroupsRaftEndpoint(String endpointUri,
                           String clusterName,
                           org.apache.camel.Component component,
                           String remaining,
                           Map<String,Object> parameters,
                           String raftId,
                           String channelProperties,
                           org.jgroups.protocols.raft.StateMachine stateMachine,
                           org.jgroups.raft.RaftHandle raftHandle)

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

populateJGroupsRaftHeaders

public void populateJGroupsRaftHeaders(org.apache.camel.Exchange exchange)

doStart

protected void doStart()
                throws Exception

Overrides:

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

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

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

Throws:

Exception

connect

public void connect()
             throws Exception

Connect shared RaftHandle channel, called by producer and consumer.

Throws:

Exception

disconnect

public void disconnect()

Disconnect shared RaftHandle channel, called by producer and consumer.

getClusterName

public String getClusterName()

setClusterName

public void setClusterName(String clusterName)

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

isEnableRoleChangeEvents

public boolean isEnableRoleChangeEvents()

setEnableRoleChangeEvents

public void setEnableRoleChangeEvents(boolean enableRoleChangeEvents)

If set to true, the consumer endpoint will receive roleChange event as well (not just connecting and/or using the state machine). By default it is set to false.

getChannelProperties

public String getChannelProperties()

setChannelProperties

public void setChannelProperties(String channelProperties)

getRaftId

public String getRaftId()

setRaftId

public void setRaftId(String raftId)

getRaftHandle

public org.jgroups.raft.RaftHandle getRaftHandle()

setRaftHandle

public void setRaftHandle(org.jgroups.raft.RaftHandle raftHandle)

getStateMachine

public org.jgroups.protocols.raft.StateMachine getStateMachine()

setStateMachine

public void setStateMachine(org.jgroups.protocols.raft.StateMachine stateMachine)

getResolvedRaftHandle

public org.jgroups.raft.RaftHandle getResolvedRaftHandle()