Package org.apache.camel.component.atlasmap

Class AtlasMapEndpoint

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.api.management.mbean.ManagedResourceEndpointMBean, 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="3.7.0",
             scheme="atlasmap",
             title="AtlasMap",
             syntax="atlasmap:resourceUri",
             producerOnly=true,
             category=TRANSFORMATION)
public class AtlasMapEndpoint
extends org.apache.camel.component.ResourceEndpoint
    Transforms the message using an AtlasMap transformation.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String CONTENT_TYPE_JSON  
      static String CONTENT_TYPE_XML  

      • Fields inherited from class org.apache.camel.component.ResourceEndpoint

        log

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected String createEndpointUri()  
      AtlasMapEndpoint findOrCreateEndpoint​(String uri, String newResourceUri)  
      io.atlasmap.api.AtlasContext getAtlasContext()  
      io.atlasmap.api.AtlasContextFactory getAtlasContextFactory()  
      org.apache.camel.ExchangePattern getExchangePattern()  
      String getSourceMapName()  
      AtlasMapEndpoint.TargetMapMode getTargetMapMode()  
      String getTargetMapName()  
      boolean isForceReload()  
      protected void onExchange​(org.apache.camel.Exchange exchange)  
      void setAtlasContext​(io.atlasmap.api.AtlasContext atlasContext)  
      void setAtlasContextFactory​(io.atlasmap.api.AtlasContextFactory atlasContextFactory)  
      void setForceReload​(boolean forceReload)
      Whether to enable or disable force reload mode.
      void setSourceMapName​(String name)
      The Exchange property name for a source message map which hold java.util.Map<String, Message> where the key is AtlasMap Document ID.
      void setTargetMapMode​(AtlasMapEndpoint.TargetMapMode mode)
      AtlasMapEndpoint.TargetMapMode enum value to specify how multiple target documents are delivered if exist.
      void setTargetMapName​(String name)
      The Exchange property name for a target document map which hold java.util.Map<String, Object> where the key is AtlasMap Document ID.

      • Methods inherited from class org.apache.camel.component.ResourceEndpoint

        clearContentCache, getCamelId, getCamelManagementName, getResourceAsInputStream, getResourceAsInputStreamWithoutCache, getResourceUri, getState, isAllowContextMapAll, isContentCache, isContentCacheCleared, loadResource, setAllowContextMapAll, setContentCache, setResourceUri

      • Methods inherited from class org.apache.camel.support.ProcessorEndpoint

        createPollingConsumer, createProcessor, createProducer, getProcessor, setProcessor

      • Methods inherited from class org.apache.camel.support.DefaultPollingEndpoint

        createConsumer

      • Methods inherited from class org.apache.camel.support.ScheduledPollEndpoint

        configureConsumer, configureProperties, configureScheduledPollConsumerProperties, doConfigureConsumer, doStart, doStop, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDefaultDelay, getDelay, getInitialDelay, getPollStrategy, getRepeatCount, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRepeatCount, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

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

        configureExchange, configurePollingConsumer, createAsyncProducer, createExchange, createExchange, doInit, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, 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 interface org.apache.camel.Endpoint

        getEndpointBaseUri, isSingletonProducer

      • 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

    • Method Detail

      • getExchangePattern

        public org.apache.camel.ExchangePattern getExchangePattern()
        Specified by:
        getExchangePattern in interface org.apache.camel.Endpoint
        Overrides:
        getExchangePattern in class org.apache.camel.support.DefaultEndpoint

      • createEndpointUri

        protected String createEndpointUri()
        Overrides:
        createEndpointUri in class org.apache.camel.support.DefaultEndpoint

      • getAtlasContextFactory

        public io.atlasmap.api.AtlasContextFactory getAtlasContextFactory()

      • setAtlasContextFactory

        public void setAtlasContextFactory​(io.atlasmap.api.AtlasContextFactory atlasContextFactory)

      • getAtlasContext

        public io.atlasmap.api.AtlasContext getAtlasContext()

      • setAtlasContext

        public void setAtlasContext​(io.atlasmap.api.AtlasContext atlasContext)

      • setSourceMapName

        public void setSourceMapName​(String name)
        The Exchange property name for a source message map which hold java.util.Map<String, Message> where the key is AtlasMap Document ID. AtlasMap consumes Message bodies as source documents, as well as message headers as source properties where the scope equals to Document ID.
        Parameters:
        name - Exchange property name for source map

      • getSourceMapName

        public String getSourceMapName()

      • setTargetMapName

        public void setTargetMapName​(String name)
        The Exchange property name for a target document map which hold java.util.Map<String, Object> where the key is AtlasMap Document ID. AtlasMap populates multiple target documents into this map.
        Parameters:
        name - Exchange property name for target map

      • getTargetMapName

        public String getTargetMapName()

      • setTargetMapMode

        public void setTargetMapMode​(AtlasMapEndpoint.TargetMapMode mode)
        AtlasMapEndpoint.TargetMapMode enum value to specify how multiple target documents are delivered if exist.
        • 'MAP': Stores them into a java.util.Map, and the java.util.Map is set to an exchange" property if 'targetMapName' is specified, otherwise message body.
          • "
        • 'MESSAGE_HEADER': Stores them into message headers.
          • "
        • 'EXCHANGE_PROPERTY': Stores them into exchange properties.
        ")
        Parameters:
        mode - AtlasMapEndpoint.TargetMapMode

      • setForceReload

        public void setForceReload​(boolean forceReload)
        Whether to enable or disable force reload mode. This is set to false by default and ADM file is loaded from a file only on a first Exchange, and AtlasContext will be reused after that until endpoint is recreated. If this is set to true, ADM file will be loaded from a file on every Exchange.
        Parameters:
        forceReload - true to enable force reload

      • isForceReload

        public boolean isForceReload()

      • onExchange

        protected void onExchange​(org.apache.camel.Exchange exchange)
                   throws Exception
        Overrides:
        onExchange in class org.apache.camel.support.ProcessorEndpoint
        Throws:
        Exception