Class GroupVariableRepository

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.GroupVariableRepository
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.BrowsableVariableRepository, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.VariableRepository, org.apache.camel.StatefulService, org.apache.camel.StaticService, org.apache.camel.SuspendableService, org.apache.camel.VariableAware
public final class GroupVariableRepository extends org.apache.camel.support.service.ServiceSupport implements org.apache.camel.spi.BrowsableVariableRepository, org.apache.camel.CamelContextAware
Group VariableRepository which stores variables in-memory per named group.

Variables are scoped by group name using the syntax groupId:variableName. This allows sharing variables across a subset of routes — wider than per-route but narrower than global scope.

Since:
4.21

  • 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
    GroupVariableRepository()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
     
    protected void
    doInit()
     
    org.apache.camel.CamelContext
    getCamelContext()
     
    Set<String>
    getGroupIds()
    Gets the ids of all groups that currently have variables.
    String
    getId()
     
    Object
    getVariable(String name)
     
    Map<String,Object>
    getVariables()
     
    boolean
    hasVariables()
     
    Stream<String>
    names()
     
    Object
    removeVariable(String name)
     
    void
    setCamelContext(org.apache.camel.CamelContext camelContext)
     
    void
    setVariable(String name, Object value)
     
    int
    size()
     

    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 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

    • GroupVariableRepository

      public GroupVariableRepository()

  • Method Details

    • getCamelContext

      public org.apache.camel.CamelContext getCamelContext()
      Specified by:
      getCamelContext in interface org.apache.camel.spi.HasCamelContext

    • setCamelContext

      public void setCamelContext(org.apache.camel.CamelContext camelContext)
      Specified by:
      setCamelContext in interface org.apache.camel.CamelContextAware

    • getVariable

      public Object getVariable(String name)
      Specified by:
      getVariable in interface org.apache.camel.VariableAware

    • setVariable

      public void setVariable(String name, Object value)
      Specified by:
      setVariable in interface org.apache.camel.VariableAware

    • hasVariables

      public boolean hasVariables()
      Specified by:
      hasVariables in interface org.apache.camel.spi.BrowsableVariableRepository

    • size

      public int size()
      Specified by:
      size in interface org.apache.camel.spi.BrowsableVariableRepository

    • names

      public Stream<String> names()
      Specified by:
      names in interface org.apache.camel.spi.BrowsableVariableRepository

    • getVariables

      public Map<String,Object> getVariables()
      Specified by:
      getVariables in interface org.apache.camel.spi.BrowsableVariableRepository

    • getGroupIds

      public Set<String> getGroupIds()
      Gets the ids of all groups that currently have variables.

    • clear

      public void clear()
      Specified by:
      clear in interface org.apache.camel.spi.BrowsableVariableRepository

    • getId

      public String getId()
      Specified by:
      getId in interface org.apache.camel.spi.VariableRepository

    • removeVariable

      public Object removeVariable(String name)
      Specified by:
      removeVariable in interface org.apache.camel.spi.VariableRepository

    • doInit

      protected void doInit() throws Exception
      Overrides:
      doInit in class org.apache.camel.support.service.BaseService
      Throws:
      Exception