Package org.apache.camel.component.hazelcast

Class HazelcastDefaultEndpoint

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultEndpoint
org.apache.camel.component.hazelcast.HazelcastDefaultEndpoint
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.ComponentAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.EndpointServiceLocation, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
Direct Known Subclasses:
HazelcastAtomicnumberEndpoint, HazelcastInstanceEndpoint, HazelcastListEndpoint, HazelcastMapEndpoint, HazelcastMultimapEndpoint, HazelcastQueueEndpoint, HazelcastReplicatedmapEndpoint, HazelcastRingbufferEndpoint, HazelcastSedaEndpoint, HazelcastSetEndpoint, HazelcastTopicEndpoint
public abstract class HazelcastDefaultEndpoint extends org.apache.camel.support.DefaultEndpoint implements org.apache.camel.spi.EndpointServiceLocation
The hazelcast component allows you to work with the Hazelcast distributed data grid / cache.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    cacheName
     
    protected HazelcastCommand
    command
     
    protected com.hazelcast.core.HazelcastInstance
    hazelcastInstance
     
    protected String
    hazelcastInstanceName
     

    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
    Modifier
    Constructor
    Description
    protected
    HazelcastDefaultEndpoint(com.hazelcast.core.HazelcastInstance hazelcastInstance, String endpointUri, org.apache.camel.Component component)
     
    protected
    HazelcastDefaultEndpoint(com.hazelcast.core.HazelcastInstance hazelcastInstance, String endpointUri, org.apache.camel.Component component, String cacheName)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.apache.camel.Consumer
    createConsumer(org.apache.camel.Processor processor)
     
    abstract org.apache.camel.Producer
    createProducer()
     
    String
    getCacheName()
     
    HazelcastCommand
    getCommand()
     
    HazelcastOperation
    getDefaultOperation()
     
    String
    getHazelcastConfigUri()
     
    com.hazelcast.core.HazelcastInstance
    getHazelcastInstance()
     
    String
    getHazelcastInstanceName()
     
    String
    getServiceProtocol()
     
    String
    getServiceUrl()
     
    void
    setCacheName(String cacheName)
    The name of the cache
    void
    setCommand(HazelcastCommand command)
    What operation to perform.
    void
    setDefaultOperation(HazelcastOperation defaultOperation)
    To specify a default operation to use, if no operation header has been provided.
    void
    setHazelcastConfigUri(String hazelcastConfigUri)
    Hazelcast configuration file.
    void
    setHazelcastInstance(com.hazelcast.core.HazelcastInstance hazelcastInstance)
    The hazelcast instance reference which can be used for hazelcast endpoint.
    void
    setHazelcastInstanceName(String hazelcastInstanceName)
    The hazelcast instance reference name which can be used for hazelcast endpoint.

    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, doStart, doStop, doSuspend, fail, getInternalLock, 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.ComponentAware

    getComponent

    Methods inherited from interface org.apache.camel.Endpoint

    getEndpointBaseUri, isRemote, isSingletonProducer

    Methods inherited from interface org.apache.camel.spi.EndpointServiceLocation

    getServiceMetadata

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

    Methods inherited from interface org.apache.camel.ShutdownableService

    shutdown

    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

  • Field Details

    • command

      protected HazelcastCommand command

    • cacheName

      @UriPath @Metadata(required=true) protected String cacheName

    • hazelcastInstance

      @UriParam protected com.hazelcast.core.HazelcastInstance hazelcastInstance

    • hazelcastInstanceName

      @UriParam protected String hazelcastInstanceName

  • Constructor Details

    • HazelcastDefaultEndpoint

      protected HazelcastDefaultEndpoint(com.hazelcast.core.HazelcastInstance hazelcastInstance, String endpointUri, org.apache.camel.Component component)

    • HazelcastDefaultEndpoint

      protected HazelcastDefaultEndpoint(com.hazelcast.core.HazelcastInstance hazelcastInstance, String endpointUri, org.apache.camel.Component component, String cacheName)

  • Method Details

    • getServiceUrl

      public String getServiceUrl()
      Specified by:
      getServiceUrl in interface org.apache.camel.spi.EndpointServiceLocation

    • getServiceProtocol

      public String getServiceProtocol()
      Specified by:
      getServiceProtocol in interface org.apache.camel.spi.EndpointServiceLocation

    • createConsumer

      public abstract org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor) throws Exception
      Specified by:
      createConsumer in interface org.apache.camel.Endpoint
      Throws:
      Exception

    • createProducer

      public abstract org.apache.camel.Producer createProducer() throws Exception
      Specified by:
      createProducer in interface org.apache.camel.Endpoint
      Throws:
      Exception

    • getCommand

      public HazelcastCommand getCommand()

    • setCommand

      public void setCommand(HazelcastCommand command)
      What operation to perform.

    • getCacheName

      public String getCacheName()

    • setCacheName

      public void setCacheName(String cacheName)
      The name of the cache

    • getHazelcastInstance

      public com.hazelcast.core.HazelcastInstance getHazelcastInstance()

    • setHazelcastInstance

      public void setHazelcastInstance(com.hazelcast.core.HazelcastInstance hazelcastInstance)
      The hazelcast instance reference which can be used for hazelcast endpoint.

    • getHazelcastInstanceName

      public String getHazelcastInstanceName()

    • setHazelcastInstanceName

      public void setHazelcastInstanceName(String hazelcastInstanceName)
      The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance.

    • setDefaultOperation

      public void setDefaultOperation(HazelcastOperation defaultOperation)
      To specify a default operation to use, if no operation header has been provided.

    • getDefaultOperation

      public HazelcastOperation getDefaultOperation()

    • getHazelcastConfigUri

      public String getHazelcastConfigUri()

    • setHazelcastConfigUri

      public void setHazelcastConfigUri(String hazelcastConfigUri)
      Hazelcast configuration file.