Package org.apache.camel.component.directvm

Class DirectVmComponent

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultComponent
org.apache.camel.component.directvm.DirectVmComponent
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
@Component("direct-vm") public class DirectVmComponent extends org.apache.camel.support.DefaultComponent
The Direct VM Component manages DirectVmEndpoint and holds the list of named direct-vm endpoints.

  • 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
    Description
    DirectVmComponent()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addConsumer(DirectVmEndpoint endpoint, DirectVmConsumer consumer)
     
    protected org.apache.camel.Endpoint
    createEndpoint(String uri, String remaining, Map<String,Object> parameters)
     
    protected void
    doStart()
     
    protected void
    doStop()
     
    DirectVmConsumer
    getConsumer(DirectVmEndpoint endpoint)
     
    static Collection<org.apache.camel.Endpoint>
    getConsumerEndpoints()
    Gets all the consumer endpoints.
    org.apache.camel.spi.HeaderFilterStrategy
    getHeaderFilterStrategy()
     
    long
    getTimeout()
     
    boolean
    isBlock()
     
    boolean
    isPropagateProperties()
     
    void
    removeConsumer(DirectVmEndpoint endpoint)
     
    void
    setBlock(boolean block)
    If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active.
    void
    setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
    Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response).
    void
    setPropagateProperties(boolean propagateProperties)
    Whether to propagate or not properties from the producer side to the consumer side, and vice versa.
    void
    setTimeout(long timeout)
    The timeout value to use if block is enabled.

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

    afterConfiguration, createEndpoint, createEndpoint, doBuild, doInit, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getDefaultName, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, resolveRawParameterValues, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

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

    build, 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    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

  • Constructor Details

    • DirectVmComponent

      public DirectVmComponent()

  • Method Details

    • getConsumerEndpoints

      public static Collection<org.apache.camel.Endpoint> getConsumerEndpoints()
      Gets all the consumer endpoints.
      Returns:
      consumer endpoints

    • createEndpoint

      protected org.apache.camel.Endpoint createEndpoint(String uri, String remaining, Map<String,Object> parameters) throws Exception
      Specified by:
      createEndpoint in class org.apache.camel.support.DefaultComponent
      Throws:
      Exception

    • getConsumer

      public DirectVmConsumer getConsumer(DirectVmEndpoint endpoint)

    • addConsumer

      public void addConsumer(DirectVmEndpoint endpoint, DirectVmConsumer consumer)

    • removeConsumer

      public void removeConsumer(DirectVmEndpoint endpoint)

    • doStart

      protected void doStart() throws Exception
      Overrides:
      doStart in class org.apache.camel.support.DefaultComponent
      Throws:
      Exception

    • doStop

      protected void doStop() throws Exception
      Overrides:
      doStop in class org.apache.camel.support.DefaultComponent
      Throws:
      Exception

    • isBlock

      public boolean isBlock()

    • setBlock

      public void setBlock(boolean block)
      If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active.

    • getTimeout

      public long getTimeout()

    • setTimeout

      public void setTimeout(long timeout)
      The timeout value to use if block is enabled.

    • getHeaderFilterStrategy

      public org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()

    • setHeaderFilterStrategy

      public void setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
      Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response).

      Default value: none.

    • isPropagateProperties

      public boolean isPropagateProperties()

    • setPropagateProperties

      public void setPropagateProperties(boolean propagateProperties)
      Whether to propagate or not properties from the producer side to the consumer side, and vice versa.

      Default value: true.