Package org.apache.activemq.artemis.core.config

Interface Configuration

public interface Configuration
A Configuration is used to configure ActiveMQ Artemis servers.

  • Method Details

    • getName

      String getName()
      To be used on dependency management on the application server

    • setName

      Configuration setName(String name)
      To be used on dependency management on the application server

    • setSystemPropertyPrefix

      Configuration setSystemPropertyPrefix(String systemPropertyPrefix)
      We use Bean-utils to pass in System.properties that start with setSystemPropertyPrefix(String)} The default should be brokerconfig. (Including the "."). For example if you want to set clustered through a system property you must do: -Dbrokerconfig.clustered=true}

      The prefix is configured here.

    • getSystemPropertyPrefix

      String getSystemPropertyPrefix()
      See doc at setSystemPropertyPrefix(String)}

    • parseProperties

      Configuration parseProperties(String optionalUrlToPropertiesFile) throws Exception
      Throws:
      Exception

    • parsePrefixedProperties

      void parsePrefixedProperties(Object target, String name, Properties properties, String prefix) throws Exception
      Throws:
      Exception

    • isCriticalAnalyzer

      boolean isCriticalAnalyzer()

    • setCriticalAnalyzer

      Configuration setCriticalAnalyzer(boolean CriticalAnalyzer)

    • getCriticalAnalyzerTimeout

      long getCriticalAnalyzerTimeout()

    • setCriticalAnalyzerTimeout

      Configuration setCriticalAnalyzerTimeout(long timeout)

    • getCriticalAnalyzerCheckPeriod

      long getCriticalAnalyzerCheckPeriod()

    • setCriticalAnalyzerCheckPeriod

      Configuration setCriticalAnalyzerCheckPeriod(long checkPeriod)

    • getCriticalAnalyzerPolicy

      org.apache.activemq.artemis.utils.critical.CriticalAnalyzerPolicy getCriticalAnalyzerPolicy()

    • setCriticalAnalyzerPolicy

      Configuration setCriticalAnalyzerPolicy(org.apache.activemq.artemis.utils.critical.CriticalAnalyzerPolicy policy)

    • isClustered

      boolean isClustered()
      Returns whether this server is clustered. true if getClusterConfigurations() is not empty.
      Returns:
      whether this server is clustered. true if getClusterConfigurations() is not empty

    • isPersistDeliveryCountBeforeDelivery

      boolean isPersistDeliveryCountBeforeDelivery()
      Returns whether delivery count is persisted before messages are delivered to the consumers; default is ActiveMQDefaultConfiguration.DEFAULT_PERSIST_DELIVERY_COUNT_BEFORE_DELIVERY.
      Returns:
      whether delivery count is persisted before messages are delivered to the consumers; default is ActiveMQDefaultConfiguration.DEFAULT_PERSIST_DELIVERY_COUNT_BEFORE_DELIVERY

    • setPersistDeliveryCountBeforeDelivery

      Configuration setPersistDeliveryCountBeforeDelivery(boolean persistDeliveryCountBeforeDelivery)
      Sets whether delivery count is persisted before messages are delivered to consumers.

    • isPersistenceEnabled

      boolean isPersistenceEnabled()
      Returns whether this server is using persistence and store data; default is ActiveMQDefaultConfiguration.DEFAULT_PERSISTENCE_ENABLED.
      Returns:
      whether this server is using persistence and store data; default is ActiveMQDefaultConfiguration.DEFAULT_PERSISTENCE_ENABLED

    • setPersistenceEnabled

      Configuration setPersistenceEnabled(boolean enable)
      Sets whether this server is using persistence and store data.

    • setMaxRedeliveryRecords

      Configuration setMaxRedeliveryRecords(int maxPersistRedelivery)
      Maximum number of redelivery records stored on the journal per message reference.

    • getMaxRedeliveryRecords

      int getMaxRedeliveryRecords()

    • isJournalDatasync

      boolean isJournalDatasync()
      Should use fdatasync on journal files.
      Returns:
      a boolean
      See Also:

    • setJournalDatasync

      Configuration setJournalDatasync(boolean enable)
      documented at isJournalDatasync()
      Returns:
      this

    • getResourceLimitSettings

      Map<String,org.apache.activemq.artemis.core.settings.impl.ResourceLimitSettings> getResourceLimitSettings()
      Returns usernames mapped to ResourceLimitSettings.
      Returns:
      usernames mapped to ResourceLimitSettings

    • setResourceLimitSettings

      Configuration setResourceLimitSettings(Map<String,org.apache.activemq.artemis.core.settings.impl.ResourceLimitSettings> resourceLimitSettings)
      Set the collection of resource limits indexed by username.
      Parameters:
      resourceLimitSettings - usernames mapped to ResourceLimitSettings

    • addResourceLimitSettings

      Configuration addResourceLimitSettings(org.apache.activemq.artemis.core.settings.impl.ResourceLimitSettings resourceLimitSettings)
      Add a resource limit to the underlying collection.
      Parameters:
      resourceLimitSettings - the ResourceLimitSettings to add

    • getFileDeployerScanPeriod

      long getFileDeployerScanPeriod()
      Returns the period (in milliseconds) to scan configuration files used by deployment; default is ActiveMQDefaultConfiguration.DEFAULT_FILE_DEPLOYER_SCAN_PERIOD.
      Returns:
      the period (in milliseconds) to scan configuration files used by deployment; default is ActiveMQDefaultConfiguration.DEFAULT_FILE_DEPLOYER_SCAN_PERIOD

    • setFileDeployerScanPeriod

      Configuration setFileDeployerScanPeriod(long period)
      Sets the period to scan configuration files used by deployment.

    • getThreadPoolMaxSize

      int getThreadPoolMaxSize()
      Returns the maximum number of threads in the thread pool of this server; default is ActiveMQDefaultConfiguration.DEFAULT_THREAD_POOL_MAX_SIZE.
      Returns:
      the maximum number of threads in the thread pool of this server; default is ActiveMQDefaultConfiguration.DEFAULT_THREAD_POOL_MAX_SIZE

    • setThreadPoolMaxSize

      Configuration setThreadPoolMaxSize(int maxSize)
      Sets the maximum number of threads in the thread pool of this server.

    • getScheduledThreadPoolMaxSize

      int getScheduledThreadPoolMaxSize()
      Returns the maximum number of threads in the scheduled thread pool of this server; default is ActiveMQDefaultConfiguration.DEFAULT_SCHEDULED_THREAD_POOL_MAX_SIZE.
      Returns:
      the maximum number of threads in the scheduled thread pool of this server; default is ActiveMQDefaultConfiguration.DEFAULT_SCHEDULED_THREAD_POOL_MAX_SIZE

    • setScheduledThreadPoolMaxSize

      Configuration setScheduledThreadPoolMaxSize(int maxSize)
      Sets the maximum number of threads in the scheduled thread pool of this server.

    • getSecurityInvalidationInterval

      long getSecurityInvalidationInterval()
      Returns the interval time (in milliseconds) to invalidate security credentials; default is ActiveMQDefaultConfiguration.DEFAULT_SECURITY_INVALIDATION_INTERVAL.
      Returns:
      the interval time (in milliseconds) to invalidate security credentials; default is ActiveMQDefaultConfiguration.DEFAULT_SECURITY_INVALIDATION_INTERVAL

    • setSecurityInvalidationInterval

      Configuration setSecurityInvalidationInterval(long interval)
      Sets the interval time (in milliseconds) to invalidate security credentials.

    • setAuthenticationCacheSize

      Configuration setAuthenticationCacheSize(long size)
      Sets the size of the authentication cache.

    • getAuthenticationCacheSize

      long getAuthenticationCacheSize()
      Returns the configured size of the authentication cache; default is ActiveMQDefaultConfiguration.DEFAULT_AUTHENTICATION_CACHE_SIZE.
      Returns:
      the configured size of the authentication cache; default is ActiveMQDefaultConfiguration.DEFAULT_AUTHENTICATION_CACHE_SIZE

    • setAuthorizationCacheSize

      Configuration setAuthorizationCacheSize(long size)
      Sets the size of the authorization cache.

    • getAuthorizationCacheSize

      long getAuthorizationCacheSize()
      Returns the configured size of the authorization cache; default is ActiveMQDefaultConfiguration.DEFAULT_AUTHORIZATION_CACHE_SIZE.
      Returns:
      the configured size of the authorization cache; default is ActiveMQDefaultConfiguration.DEFAULT_AUTHORIZATION_CACHE_SIZE

    • isSecurityEnabled

      boolean isSecurityEnabled()
      Returns whether security is enabled for this server; default is ActiveMQDefaultConfiguration.DEFAULT_SECURITY_ENABLED.
      Returns:
      whether security is enabled for this server; default is ActiveMQDefaultConfiguration.DEFAULT_SECURITY_ENABLED

    • setSecurityEnabled

      Configuration setSecurityEnabled(boolean enabled)
      Sets whether security is enabled for this server.

    • isGracefulShutdownEnabled

      boolean isGracefulShutdownEnabled()
      Returns whether graceful shutdown is enabled for this server; default is ActiveMQDefaultConfiguration.DEFAULT_GRACEFUL_SHUTDOWN_ENABLED.
      Returns:
      whether graceful shutdown is enabled for this server; default is ActiveMQDefaultConfiguration.DEFAULT_GRACEFUL_SHUTDOWN_ENABLED

    • setGracefulShutdownEnabled

      Configuration setGracefulShutdownEnabled(boolean enabled)
      Sets whether security is enabled for this server.

    • getGracefulShutdownTimeout

      long getGracefulShutdownTimeout()
      Returns the graceful shutdown timeout for this server; default is ActiveMQDefaultConfiguration.DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT.
      Returns:
      the graceful shutdown timeout for this server; default is ActiveMQDefaultConfiguration.DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT

    • setGracefulShutdownTimeout

      Configuration setGracefulShutdownTimeout(long timeout)
      Sets the graceful shutdown timeout

    • isJMXManagementEnabled

      boolean isJMXManagementEnabled()
      Returns whether this server is manageable using JMX or not; default is ActiveMQDefaultConfiguration.DEFAULT_JMX_MANAGEMENT_ENABLED.
      Returns:
      whether this server is manageable using JMX or not; default is ActiveMQDefaultConfiguration.DEFAULT_JMX_MANAGEMENT_ENABLED

    • setJMXManagementEnabled

      Configuration setJMXManagementEnabled(boolean enabled)
      Sets whether this server is manageable using JMX or not; default is ActiveMQDefaultConfiguration.DEFAULT_JMX_MANAGEMENT_ENABLED}

    • getJMXDomain

      String getJMXDomain()
      Returns the domain used by JMX MBeans (provided JMX management is enabled); default is ActiveMQDefaultConfiguration.DEFAULT_JMX_DOMAIN.
      Returns:
      the domain used by JMX MBeans (provided JMX management is enabled); default is ActiveMQDefaultConfiguration.DEFAULT_JMX_DOMAIN

    • setJMXDomain

      Configuration setJMXDomain(String domain)
      Sets the domain used by JMX MBeans (provided JMX management is enabled).

      Changing this JMX domain is required if multiple ActiveMQ Artemis servers are run inside the same JVM and all servers are using the same MBeanServer.

    • isJMXUseBrokerName

      boolean isJMXUseBrokerName()
      whether to use the broker name in the JMX tree

    • setJMXUseBrokerName

      org.apache.activemq.artemis.core.config.impl.ConfigurationImpl setJMXUseBrokerName(boolean jmxUseBrokerName)
      whether to use the broker name in the JMX tree

    • getIncomingInterceptorClassNames

      List<String> getIncomingInterceptorClassNames()
      Returns the list of interceptors classes used by this server for incoming messages (i.e. those being delivered to the server from clients).
      Returns:
      the list of interceptors classes used by this server for incoming messages (i.e. those being delivered to the server from clients)

    • getOutgoingInterceptorClassNames

      List<String> getOutgoingInterceptorClassNames()
      Returns the list of interceptors classes used by this server for outgoing messages (i.e. those being delivered to clients from the server).
      Returns:
      the list of interceptors classes used by this server for outgoing messages (i.e. those being delivered to clients from the server)

    • setIncomingInterceptorClassNames

      Configuration setIncomingInterceptorClassNames(List<String> interceptors)
      Sets the list of interceptors classes used by this server for incoming messages (i.e. those being delivered to the server from clients).

      Classes must implement Interceptor}

    • setOutgoingInterceptorClassNames

      Configuration setOutgoingInterceptorClassNames(List<String> interceptors)
      Sets the list of interceptors classes used by this server for outgoing messages (i.e. those being delivered to clients from the server).

      Classes must implement Interceptor}

    • getConnectionTTLOverride

      long getConnectionTTLOverride()
      Returns the connection time to live; This value overrides the connection time-to-live sent by the client; default is ActiveMQDefaultConfiguration.DEFAULT_CONNECTION_TTL_OVERRIDE.
      Returns:
      the connection time to live; This value overrides the connection time-to-live sent by the client; default is ActiveMQDefaultConfiguration.DEFAULT_CONNECTION_TTL_OVERRIDE

    • setConnectionTTLOverride

      Configuration setConnectionTTLOverride(long ttl)
      Sets the connection time to live.

    • isAmqpUseCoreSubscriptionNaming

      boolean isAmqpUseCoreSubscriptionNaming()
      Returns if to use Core subscription naming for AMQP.
      Returns:
      if to use Core subscription naming for AMQP

    • setAmqpUseCoreSubscriptionNaming

      Configuration setAmqpUseCoreSubscriptionNaming(boolean amqpUseCoreSubscriptionNaming)
      Sets if to use Core subscription naming for AMQP.

    • isAsyncConnectionExecutionEnabled

      @Deprecated boolean isAsyncConnectionExecutionEnabled()
      Deprecated.
      Returns whether code coming from connection is executed asynchronously or not; default is ActiveMQDefaultConfiguration.DEFAULT_ASYNC_CONNECTION_EXECUTION_ENABLED.

      Returns:
      whether code coming from connection is executed asynchronously or not; default is ActiveMQDefaultConfiguration.DEFAULT_ASYNC_CONNECTION_EXECUTION_ENABLED

    • setEnabledAsyncConnectionExecution

      @Deprecated Configuration setEnabledAsyncConnectionExecution(boolean enabled)
      Deprecated.
      Sets whether code coming from connection is executed asynchronously or not.

    • getAcceptorConfigurations

      Set<TransportConfiguration> getAcceptorConfigurations()
      Returns the acceptors configured for this server.
      Returns:
      the acceptors configured for this server

    • setAcceptorConfigurations

      Configuration setAcceptorConfigurations(Set<TransportConfiguration> infos)
      Sets the acceptors configured for this server.

    • addAcceptorConfiguration

      Configuration addAcceptorConfiguration(TransportConfiguration infos)

    • addAcceptorConfiguration

      Configuration addAcceptorConfiguration(String name, String uri) throws Exception
      Add an acceptor to the config
      Parameters:
      name - the name of the acceptor
      uri - the URI of the acceptor
      Returns:
      this
      Throws:
      Exception - in case of Parsing errors on the URI
      See Also:

    • clearAcceptorConfigurations

      Configuration clearAcceptorConfigurations()

    • getConnectorConfigurations

      Map<String,TransportConfiguration> getConnectorConfigurations()
      Returns the connectors configured for this server.
      Returns:
      the connectors configured for this server

    • setConnectorConfigurations

      Configuration setConnectorConfigurations(Map<String,TransportConfiguration> infos)
      Sets the connectors configured for this server.

    • addConnectorConfiguration

      Configuration addConnectorConfiguration(String key, TransportConfiguration info)

    • addConnectorConfiguration

      Configuration addConnectorConfiguration(String name, String uri) throws Exception
      Throws:
      Exception

    • clearConnectorConfigurations

      Configuration clearConnectorConfigurations()

    • getBroadcastGroupConfigurations

      List<BroadcastGroupConfiguration> getBroadcastGroupConfigurations()
      Returns the broadcast groups configured for this server.
      Returns:
      the broadcast groups configured for this server

    • setBroadcastGroupConfigurations

      Configuration setBroadcastGroupConfigurations(List<BroadcastGroupConfiguration> configs)
      Sets the broadcast groups configured for this server}

    • addBroadcastGroupConfiguration

      Configuration addBroadcastGroupConfiguration(BroadcastGroupConfiguration config)

    • getDiscoveryGroupConfigurations

      Map<String,DiscoveryGroupConfiguration> getDiscoveryGroupConfigurations()
      Returns the discovery groups configured for this server.
      Returns:
      the discovery groups configured for this server

    • setDiscoveryGroupConfigurations

      Configuration setDiscoveryGroupConfigurations(Map<String,DiscoveryGroupConfiguration> configs)
      Sets the discovery groups configured for this server.

    • addDiscoveryGroupConfiguration

      Configuration addDiscoveryGroupConfiguration(String key, DiscoveryGroupConfiguration discoveryGroupConfiguration)

    • getGroupingHandlerConfiguration

      org.apache.activemq.artemis.core.server.group.impl.GroupingHandlerConfiguration getGroupingHandlerConfiguration()
      Returns the grouping handler configured for this server.
      Returns:
      the grouping handler configured for this server

    • setGroupingHandlerConfiguration

      Configuration setGroupingHandlerConfiguration(org.apache.activemq.artemis.core.server.group.impl.GroupingHandlerConfiguration groupingHandlerConfiguration)
      Sets the grouping handler configured for this server.

    • getBridgeConfigurations

      List<BridgeConfiguration> getBridgeConfigurations()
      Returns the bridges configured for this server.
      Returns:
      the bridges configured for this server

    • setBridgeConfigurations

      Configuration setBridgeConfigurations(List<BridgeConfiguration> configs)
      Sets the bridges configured for this server.

    • getDivertConfigurations

      List<DivertConfiguration> getDivertConfigurations()
      Returns the diverts configured for this server.
      Returns:
      the diverts configured for this server

    • setDivertConfigurations

      Configuration setDivertConfigurations(List<DivertConfiguration> configs)
      Sets the diverts configured for this server.

    • addDivertConfiguration

      Configuration addDivertConfiguration(DivertConfiguration config)

    • getConnectionRouters

      List<ConnectionRouterConfiguration> getConnectionRouters()
      Returns the redirects configured for this server.
      Returns:
      the redirects configured for this server

    • setConnectionRouters

      Configuration setConnectionRouters(List<ConnectionRouterConfiguration> configs)
      Sets the redirects configured for this server.

    • addConnectionRouter

      Configuration addConnectionRouter(ConnectionRouterConfiguration config)

    • getClusterConfigurations

      List<ClusterConnectionConfiguration> getClusterConfigurations()
      Returns the cluster connections configured for this server; modifying the returned list will modify the list of ClusterConnectionConfiguration used by this configuration.
      Returns:
      the cluster connections configured for this server; modifying the returned list will modify the list of ClusterConnectionConfiguration used by this configuration

    • setClusterConfigurations

      Configuration setClusterConfigurations(List<ClusterConnectionConfiguration> configs)
      Sets the cluster connections configured for this server.

    • addClusterConfiguration

      Configuration addClusterConfiguration(ClusterConnectionConfiguration config)

    • addClusterConfiguration

      ClusterConnectionConfiguration addClusterConfiguration(String name, String uri) throws Exception
      Throws:
      Exception

    • clearClusterConfigurations

      Configuration clearClusterConfigurations()

    • addAMQPConnection

      Configuration addAMQPConnection(AMQPBrokerConnectConfiguration amqpBrokerConnectConfiguration)

    • getAMQPConnection

      List<AMQPBrokerConnectConfiguration> getAMQPConnection()

    • setAMQPConnectionConfigurations

      Configuration setAMQPConnectionConfigurations(List<AMQPBrokerConnectConfiguration> amqpConnectionConfiugrations)
      Quick set of all AMQP connection configurations in one call which will clear all previously set or added broker configurations.
      Parameters:
      amqpConnectionConfiugrations - A list of AMQP broker connection configurations to assign to the broker.
      Returns:
      this configuration object

    • clearAMQPConnectionConfigurations

      Configuration clearAMQPConnectionConfigurations()
      Clears the current configuration object of all set or added AMQP connection configuration elements.
      Returns:
      this configuration object

    • getQueueConfigurations

      @Deprecated List<CoreQueueConfiguration> getQueueConfigurations()
      Deprecated.
      Returns the queues configured for this server.
      Returns:
      the queues configured for this server

    • getQueueConfigs

      List<QueueConfiguration> getQueueConfigs()
      Returns the queues configured for this server; modifying the returned List will not impact the underlying List.
      Returns:
      the queues configured for this server; modifying the returned List will not impact the underlying List

    • setQueueConfigurations

      @Deprecated Configuration setQueueConfigurations(List<CoreQueueConfiguration> configs)
      Deprecated.
      Sets the queues configured for this server.

    • setQueueConfigs

      Configuration setQueueConfigs(List<QueueConfiguration> configs)
      Sets the queues configured for this server.

    • addQueueConfiguration

      @Deprecated Configuration addQueueConfiguration(CoreQueueConfiguration config)
      Deprecated.

    • addQueueConfiguration

      Configuration addQueueConfiguration(QueueConfiguration config)

    • getAddressConfigurations

      List<CoreAddressConfiguration> getAddressConfigurations()
      Returns the addresses configured for this server.
      Returns:
      the addresses configured for this server

    • setAddressConfigurations

      Configuration setAddressConfigurations(List<CoreAddressConfiguration> configs)
      Sets the addresses configured for this server.

    • addAddressConfiguration

      Configuration addAddressConfiguration(CoreAddressConfiguration config)
      Adds an addresses configuration

    • getManagementAddress

      SimpleString getManagementAddress()
      Returns the management address of this server; Clients can send management messages to this address to manage this server; default is ActiveMQDefaultConfiguration.DEFAULT_MANAGEMENT_ADDRESS.
      Returns:
      the management address of this server; Clients can send management messages to this address to manage this server; default is ActiveMQDefaultConfiguration.DEFAULT_MANAGEMENT_ADDRESS

    • setManagementAddress

      Configuration setManagementAddress(SimpleString address)
      Sets the management address of this server.

    • getManagementNotificationAddress

      SimpleString getManagementNotificationAddress()
      Returns the management notification address of this server; Clients can bind queues to this address to receive management notifications emitted by this server; default is ActiveMQDefaultConfiguration.DEFAULT_MANAGEMENT_NOTIFICATION_ADDRESS.
      Returns:
      the management notification address of this server; Clients can bind queues to this address to receive management notifications emitted by this server; default is ActiveMQDefaultConfiguration.DEFAULT_MANAGEMENT_NOTIFICATION_ADDRESS

    • setManagementNotificationAddress

      Configuration setManagementNotificationAddress(SimpleString address)
      Sets the management notification address of this server.

    • getClusterUser

      String getClusterUser()
      Returns the cluster user for this server; default is ActiveMQDefaultConfiguration.DEFAULT_CLUSTER_USER.
      Returns:
      the cluster user for this server; default is ActiveMQDefaultConfiguration.DEFAULT_CLUSTER_USER

    • setClusterUser

      Configuration setClusterUser(String user)
      Sets the cluster user for this server.

    • getClusterPassword

      String getClusterPassword()
      Returns the cluster password for this server; default is ActiveMQDefaultConfiguration.DEFAULT_CLUSTER_PASSWORD.
      Returns:
      the cluster password for this server; default is ActiveMQDefaultConfiguration.DEFAULT_CLUSTER_PASSWORD

    • setClusterPassword

      Configuration setClusterPassword(String password)
      Sets the cluster password for this server.

    • getIDCacheSize

      int getIDCacheSize()
      Returns the size of the cache for pre-creating message IDs; default is ActiveMQDefaultConfiguration.DEFAULT_ID_CACHE_SIZE.
      Returns:
      the size of the cache for pre-creating message IDs; default is ActiveMQDefaultConfiguration.DEFAULT_ID_CACHE_SIZE

    • setIDCacheSize

      Configuration setIDCacheSize(int idCacheSize)
      Sets the size of the cache for pre-creating message IDs.

    • isPersistIDCache

      boolean isPersistIDCache()
      Returns whether message ID cache is persisted; default is ActiveMQDefaultConfiguration.DEFAULT_PERSIST_ID_CACHE.
      Returns:
      whether message ID cache is persisted; default is ActiveMQDefaultConfiguration.DEFAULT_PERSIST_ID_CACHE

    • setPersistIDCache

      Configuration setPersistIDCache(boolean persist)
      Sets whether message ID cache is persisted.

    • getBindingsDirectory

      String getBindingsDirectory()
      Returns the file system directory used to store bindings; default is ActiveMQDefaultConfiguration.DEFAULT_BINDINGS_DIRECTORY.
      Returns:
      the file system directory used to store bindings; default is ActiveMQDefaultConfiguration.DEFAULT_BINDINGS_DIRECTORY

    • getBindingsLocation

      File getBindingsLocation()
      The binding location related to artemis.instance.

    • setBindingsDirectory

      Configuration setBindingsDirectory(String dir)
      Sets the file system directory used to store bindings.

    • getPageMaxConcurrentIO

      int getPageMaxConcurrentIO()
      Returns the max number of concurrent reads allowed on paging; default is ActiveMQDefaultConfiguration.DEFAULT_MAX_CONCURRENT_PAGE_IO.
      Returns:
      the max number of concurrent reads allowed on paging; default is ActiveMQDefaultConfiguration.DEFAULT_MAX_CONCURRENT_PAGE_IO

    • setPageMaxConcurrentIO

      Configuration setPageMaxConcurrentIO(int maxIO)
      The max number of concurrent reads allowed on paging.

      Default = 5

    • isReadWholePage

      boolean isReadWholePage()
      Returns whether the whole page is read while getting message after page cache is evicted; default is ActiveMQDefaultConfiguration.DEFAULT_READ_WHOLE_PAGE.
      Returns:
      whether the whole page is read while getting message after page cache is evicted; default is ActiveMQDefaultConfiguration.DEFAULT_READ_WHOLE_PAGE

    • setReadWholePage

      Configuration setReadWholePage(boolean read)
      Sets whether the whole page is read while getting message after page cache is evicted.

    • getJournalDirectory

      String getJournalDirectory()
      Returns the file system directory used to store journal log; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_DIR.
      Returns:
      the file system directory used to store journal log; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_DIR

    • getJournalLocation

      File getJournalLocation()
      Returns the location of the journal related to artemis.instance.
      Returns:
      the location of the journal related to artemis.instance

    • getNodeManagerLockLocation

      File getNodeManagerLockLocation()
      Returns the location of the node manager lock file related to artemis.instance.
      Returns:
      the location of the node manager lock file related to artemis.instance

    • setNodeManagerLockDirectory

      Configuration setNodeManagerLockDirectory(String dir)
      Sets the file system directory used to store the node manager lock file.

    • getNodeManagerLockDirectory

      String getNodeManagerLockDirectory()
      Returns the directory that contains the lock file.
      Returns:
      the directory that contains the lock file

    • setJournalDirectory

      Configuration setJournalDirectory(String dir)
      Sets the file system directory used to store journal log.

    • getJournalRetentionDirectory

      String getJournalRetentionDirectory()

    • setJournalRetentionDirectory

      Configuration setJournalRetentionDirectory(String dir)
      Sets the file system directory used to store historical backup journal.

    • getJournalRetentionLocation

      File getJournalRetentionLocation()

    • getJournalRetentionPeriod

      long getJournalRetentionPeriod()
      Returns the retention period for the journal in milliseconds (always in milliseconds, a conversion is performed on set).
      Returns:
      the retention period for the journal in milliseconds (always in milliseconds, a conversion is performed on set)

    • setJournalRetentionPeriod

      Configuration setJournalRetentionPeriod(TimeUnit unit, long limit)

    • getJournalRetentionMaxBytes

      long getJournalRetentionMaxBytes()

    • setJournalRetentionMaxBytes

      Configuration setJournalRetentionMaxBytes(long bytes)

    • getJournalType

      org.apache.activemq.artemis.core.server.JournalType getJournalType()
      Returns the type of journal used by this server (NIO, ASYNCIO or MAPPED); default is ASYNCIO.
      Returns:
      the type of journal used by this server (NIO, ASYNCIO or MAPPED); default is ASYNCIO

    • setJournalType

      Configuration setJournalType(org.apache.activemq.artemis.core.server.JournalType type)
      Sets the type of journal used by this server (either NIO or ASYNCIO).

    • isJournalSyncTransactional

      boolean isJournalSyncTransactional()
      Returns whether the journal is synchronized when receiving transactional data; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_SYNC_TRANSACTIONAL.
      Returns:
      whether the journal is synchronized when receiving transactional data; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_SYNC_TRANSACTIONAL

    • setJournalSyncTransactional

      Configuration setJournalSyncTransactional(boolean sync)
      Sets whether the journal is synchronized when receiving transactional data.

    • isJournalSyncNonTransactional

      boolean isJournalSyncNonTransactional()
      Returns whether the journal is synchronized when receiving non-transactional data; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_SYNC_NON_TRANSACTIONAL.
      Returns:
      whether the journal is synchronized when receiving non-transactional data; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_SYNC_NON_TRANSACTIONAL

    • setJournalSyncNonTransactional

      Configuration setJournalSyncNonTransactional(boolean sync)
      Sets whether the journal is synchronized when receiving non-transactional data.

    • getJournalFileSize

      int getJournalFileSize()
      Returns the size (in bytes) of each journal files; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_FILE_SIZE.
      Returns:
      the size (in bytes) of each journal files; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_FILE_SIZE

    • setJournalFileSize

      Configuration setJournalFileSize(int size)
      Sets the size (in bytes) of each journal files.

    • getJournalCompactMinFiles

      int getJournalCompactMinFiles()
      Returns the minimal number of journal files before compacting; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_COMPACT_MIN_FILES.
      Returns:
      the minimal number of journal files before compacting; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_COMPACT_MIN_FILES

    • setJournalCompactMinFiles

      Configuration setJournalCompactMinFiles(int minFiles)
      Sets the minimal number of journal files before compacting.

    • getJournalPoolFiles

      int getJournalPoolFiles()
      Number of files that would be acceptable to keep on a pool; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_POOL_FILES}

    • setJournalPoolFiles

      Configuration setJournalPoolFiles(int poolSize)
      Number of files that would be acceptable to keep on a pool; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_POOL_FILES}

    • getJournalCompactPercentage

      int getJournalCompactPercentage()
      Returns the percentage of live data before compacting the journal; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_COMPACT_PERCENTAGE.
      Returns:
      the percentage of live data before compacting the journal; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_COMPACT_PERCENTAGE

    • getJournalFileOpenTimeout

      int getJournalFileOpenTimeout()
      Returns How long to wait when opening a new Journal file before failing.
      Returns:
      How long to wait when opening a new Journal file before failing

    • setJournalFileOpenTimeout

      Configuration setJournalFileOpenTimeout(int journalFileOpenTimeout)
      Sets the journal file open timeout

    • setJournalCompactPercentage

      Configuration setJournalCompactPercentage(int percentage)
      Sets the percentage of live data before compacting the journal.

    • getJournalMinFiles

      int getJournalMinFiles()
      Returns the number of journal files to pre-create; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_MIN_FILES.
      Returns:
      the number of journal files to pre-create; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_MIN_FILES

    • setJournalMinFiles

      Configuration setJournalMinFiles(int files)
      Sets the number of journal files to pre-create.

    • getJournalMaxIO_AIO

      int getJournalMaxIO_AIO()
      Returns the maximum number of write requests that can be in the AIO queue at any given time; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_MAX_IO_AIO.
      Returns:
      the maximum number of write requests that can be in the AIO queue at any given time; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_MAX_IO_AIO

    • setJournalMaxIO_AIO

      Configuration setJournalMaxIO_AIO(int journalMaxIO)
      Sets the maximum number of write requests that can be in the AIO queue at any given time.

    • getJournalBufferTimeout_AIO

      int getJournalBufferTimeout_AIO()
      Returns the timeout (in nanoseconds) used to flush buffers in the AIO queue; default is ArtemisConstants.DEFAULT_JOURNAL_BUFFER_TIMEOUT_AIO.
      Returns:
      the timeout (in nanoseconds) used to flush buffers in the AIO queue; default is ArtemisConstants.DEFAULT_JOURNAL_BUFFER_TIMEOUT_AIO

    • setJournalBufferTimeout_AIO

      Configuration setJournalBufferTimeout_AIO(int journalBufferTimeout)
      Sets the timeout (in nanoseconds) used to flush buffers in the AIO queue.

    • getJournalDeviceBlockSize

      Integer getJournalDeviceBlockSize()
      This is the device block size used on writing. This is usually translated as st_blksize from fstat. Returning null means the system should instead make a call on fstat and use st_blksize. The intention of this setting was to bypass the value in certain devices that will return a huge number as their block size (e.g. CephFS)

    • setJournalDeviceBlockSize

      Configuration setJournalDeviceBlockSize(Integer deviceBlockSize)
      Set the journal device block size.
      See Also:

    • getJournalBufferSize_AIO

      int getJournalBufferSize_AIO()
      Returns the buffer size (in bytes) for AIO; default is ArtemisConstants.DEFAULT_JOURNAL_BUFFER_SIZE_AIO.
      Returns:
      the buffer size (in bytes) for AIO; default is ArtemisConstants.DEFAULT_JOURNAL_BUFFER_SIZE_AIO

    • setJournalBufferSize_AIO

      Configuration setJournalBufferSize_AIO(int journalBufferSize)
      Sets the buffer size (in bytes) for AIO.

    • getJournalMaxIO_NIO

      int getJournalMaxIO_NIO()
      Returns the maximum number of write requests for NIO journal; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_MAX_IO_NIO.
      Returns:
      the maximum number of write requests for NIO journal; default is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_MAX_IO_NIO

    • setJournalMaxIO_NIO

      Configuration setJournalMaxIO_NIO(int journalMaxIO)
      Sets the maximum number of write requests for NIO journal.

    • getJournalBufferTimeout_NIO

      int getJournalBufferTimeout_NIO()
      Returns the timeout (in nanoseconds) used to flush buffers in the NIO; default is ArtemisConstants.DEFAULT_JOURNAL_BUFFER_TIMEOUT_NIO.
      Returns:
      the timeout (in nanoseconds) used to flush buffers in the NIO; default is ArtemisConstants.DEFAULT_JOURNAL_BUFFER_TIMEOUT_NIO

    • setJournalBufferTimeout_NIO

      Configuration setJournalBufferTimeout_NIO(int journalBufferTimeout)
      Sets the timeout (in nanoseconds) used to flush buffers in the NIO.

    • getJournalBufferSize_NIO

      int getJournalBufferSize_NIO()
      Returns the buffer size (in bytes) for NIO; default is ArtemisConstants.DEFAULT_JOURNAL_BUFFER_SIZE_NIO.
      Returns:
      the buffer size (in bytes) for NIO; default is ArtemisConstants.DEFAULT_JOURNAL_BUFFER_SIZE_NIO

    • setJournalBufferSize_NIO

      Configuration setJournalBufferSize_NIO(int journalBufferSize)
      Sets the buffer size (in bytes) for NIO.

    • getJournalMaxAtticFiles

      int getJournalMaxAtticFiles()
      Returns the maximal number of data files before we can start deleting corrupted files instead of moving them to attic; default value is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_MAX_ATTIC_FILES.
      Returns:
      the maximal number of data files before we can start deleting corrupted files instead of moving them to attic; default value is ActiveMQDefaultConfiguration.DEFAULT_JOURNAL_MAX_ATTIC_FILES

    • setJournalMaxAtticFiles

      Configuration setJournalMaxAtticFiles(int maxAtticFiles)
      Sets the maximal number of data files before we can start deleting corrupted files instead of moving them to attic.

    • isCreateBindingsDir

      boolean isCreateBindingsDir()
      Returns whether the bindings directory is created on this server startup; default is ActiveMQDefaultConfiguration.DEFAULT_CREATE_BINDINGS_DIR.
      Returns:
      whether the bindings directory is created on this server startup; default is ActiveMQDefaultConfiguration.DEFAULT_CREATE_BINDINGS_DIR

    • setCreateBindingsDir

      Configuration setCreateBindingsDir(boolean create)
      Sets whether the bindings directory is created on this server startup.

    • isCreateJournalDir

      boolean isCreateJournalDir()
      Returns whether the journal directory is created on this server startup; default is ActiveMQDefaultConfiguration.DEFAULT_CREATE_JOURNAL_DIR.
      Returns:
      whether the journal directory is created on this server startup; default is ActiveMQDefaultConfiguration.DEFAULT_CREATE_JOURNAL_DIR

    • setCreateJournalDir

      Configuration setCreateJournalDir(boolean create)
      Sets whether the journal directory is created on this server startup.

    • isLogJournalWriteRate

      boolean isLogJournalWriteRate()

    • setLogJournalWriteRate

      Configuration setLogJournalWriteRate(boolean rate)

    • getServerDumpInterval

      long getServerDumpInterval()

    • setServerDumpInterval

      Configuration setServerDumpInterval(long interval)

    • getMemoryWarningThreshold

      int getMemoryWarningThreshold()

    • setMemoryWarningThreshold

      Configuration setMemoryWarningThreshold(int memoryWarningThreshold)

    • getMemoryMeasureInterval

      long getMemoryMeasureInterval()

    • setMemoryMeasureInterval

      Configuration setMemoryMeasureInterval(long memoryMeasureInterval)

    • getPagingDirectory

      String getPagingDirectory()
      Returns the file system directory used to store paging files; default is ActiveMQDefaultConfiguration.DEFAULT_PAGING_DIR.
      Returns:
      the file system directory used to store paging files; default is ActiveMQDefaultConfiguration.DEFAULT_PAGING_DIR

    • setPagingDirectory

      Configuration setPagingDirectory(String dir)
      Sets the file system directory used to store paging files.

    • getPagingLocation

      File getPagingLocation()
      The paging location related to artemis.instance

    • getLargeMessagesDirectory

      String getLargeMessagesDirectory()
      Returns the file system directory used to store large messages; default is ActiveMQDefaultConfiguration.DEFAULT_LARGE_MESSAGES_DIR.
      Returns:
      the file system directory used to store large messages; default is ActiveMQDefaultConfiguration.DEFAULT_LARGE_MESSAGES_DIR

    • getLargeMessagesLocation

      File getLargeMessagesLocation()
      The large message location related to artemis.instance

    • setLargeMessagesDirectory

      Configuration setLargeMessagesDirectory(String directory)
      Sets the file system directory used to store large messages.

    • isWildcardRoutingEnabled

      boolean isWildcardRoutingEnabled()
      Returns whether wildcard routing is supported by this server; default is ActiveMQDefaultConfiguration.DEFAULT_WILDCARD_ROUTING_ENABLED.
      Returns:
      whether wildcard routing is supported by this server; default is ActiveMQDefaultConfiguration.DEFAULT_WILDCARD_ROUTING_ENABLED

    • setWildcardRoutingEnabled

      Configuration setWildcardRoutingEnabled(boolean enabled)
      Sets whether wildcard routing is supported by this server.

    • getWildcardConfiguration

      WildcardConfiguration getWildcardConfiguration()

    • setWildCardConfiguration

      Configuration setWildCardConfiguration(WildcardConfiguration wildcardConfiguration)

    • getTransactionTimeout

      long getTransactionTimeout()
      Returns the timeout (in milliseconds) after which transactions is removed from the resource manager after it was created; default is ActiveMQDefaultConfiguration.DEFAULT_TRANSACTION_TIMEOUT.
      Returns:
      the timeout (in milliseconds) after which transactions is removed from the resource manager after it was created; default is ActiveMQDefaultConfiguration.DEFAULT_TRANSACTION_TIMEOUT

    • setTransactionTimeout

      Configuration setTransactionTimeout(long timeout)
      Sets the timeout (in milliseconds) after which transactions is removed from the resource manager after it was created.

    • isMessageCounterEnabled

      boolean isMessageCounterEnabled()
      Returns whether message counter is enabled for this server; default is ActiveMQDefaultConfiguration.DEFAULT_MESSAGE_COUNTER_ENABLED.
      Returns:
      whether message counter is enabled for this server; default is ActiveMQDefaultConfiguration.DEFAULT_MESSAGE_COUNTER_ENABLED

    • setMessageCounterEnabled

      Configuration setMessageCounterEnabled(boolean enabled)
      Sets whether message counter is enabled for this server.

    • getMessageCounterSamplePeriod

      long getMessageCounterSamplePeriod()
      Returns the sample period (in milliseconds) to take message counter snapshot; default is ActiveMQDefaultConfiguration.DEFAULT_MESSAGE_COUNTER_SAMPLE_PERIOD.
      Returns:
      the sample period (in milliseconds) to take message counter snapshot; default is ActiveMQDefaultConfiguration.DEFAULT_MESSAGE_COUNTER_SAMPLE_PERIOD

    • setMessageCounterSamplePeriod

      Configuration setMessageCounterSamplePeriod(long period)
      Sets the sample period to take message counter snapshot.
      Parameters:
      period - value must be greater than 1000ms

    • getMessageCounterMaxDayHistory

      int getMessageCounterMaxDayHistory()
      Returns the maximum number of days kept in memory for message counter; default is ActiveMQDefaultConfiguration.DEFAULT_MESSAGE_COUNTER_MAX_DAY_HISTORY.
      Returns:
      the maximum number of days kept in memory for message counter; default is ActiveMQDefaultConfiguration.DEFAULT_MESSAGE_COUNTER_MAX_DAY_HISTORY

    • setMessageCounterMaxDayHistory

      Configuration setMessageCounterMaxDayHistory(int maxDayHistory)
      Sets the maximum number of days kept in memory for message counter.
      Parameters:
      maxDayHistory - value must be greater than 0

    • getTransactionTimeoutScanPeriod

      long getTransactionTimeoutScanPeriod()
      Returns the frequency (in milliseconds) to scan transactions to detect which transactions have timed out; default is ActiveMQDefaultConfiguration.DEFAULT_TRANSACTION_TIMEOUT_SCAN_PERIOD.
      Returns:
      the frequency (in milliseconds) to scan transactions to detect which transactions have timed out; default is ActiveMQDefaultConfiguration.DEFAULT_TRANSACTION_TIMEOUT_SCAN_PERIOD

    • setTransactionTimeoutScanPeriod

      Configuration setTransactionTimeoutScanPeriod(long period)
      Sets the frequency (in milliseconds) to scan transactions to detect which transactions have timed out.

    • getMessageExpiryScanPeriod

      long getMessageExpiryScanPeriod()
      Returns the frequency (in milliseconds) to scan messages to detect which messages have expired; default is ActiveMQDefaultConfiguration.DEFAULT_MESSAGE_EXPIRY_SCAN_PERIOD.
      Returns:
      the frequency (in milliseconds) to scan messages to detect which messages have expired; default is ActiveMQDefaultConfiguration.DEFAULT_MESSAGE_EXPIRY_SCAN_PERIOD

    • setMessageExpiryScanPeriod

      Configuration setMessageExpiryScanPeriod(long messageExpiryScanPeriod)
      Sets the frequency (in milliseconds) to scan messages to detect which messages have expired.

    • getMessageExpiryThreadPriority

      @Deprecated int getMessageExpiryThreadPriority()
      Deprecated.
      Returns the priority of the thread used to scan message expiration; default is ActiveMQDefaultConfiguration.DEFAULT_MESSAGE_EXPIRY_THREAD_PRIORITY.
      Returns:
      the priority of the thread used to scan message expiration; default is ActiveMQDefaultConfiguration.DEFAULT_MESSAGE_EXPIRY_THREAD_PRIORITY

    • setMessageExpiryThreadPriority

      @Deprecated Configuration setMessageExpiryThreadPriority(int messageExpiryThreadPriority)
      Deprecated.
      Sets the priority of the thread used to scan message expiration.

    • getAddressQueueScanPeriod

      long getAddressQueueScanPeriod()
      Returns the frequency (in milliseconds) to scan addresses and queues to detect which ones should be deleted; default is ActiveMQDefaultConfiguration.DEFAULT_MESSAGE_EXPIRY_SCAN_PERIOD.
      Returns:
      the frequency (in milliseconds) to scan addresses and queues to detect which ones should be deleted; default is ActiveMQDefaultConfiguration.DEFAULT_MESSAGE_EXPIRY_SCAN_PERIOD

    • setAddressQueueScanPeriod

      Configuration setAddressQueueScanPeriod(long addressQueueScanPeriod)
      Sets the frequency (in milliseconds) to scan addresses and queues to detect which ones should be deleted.

    • getAddressSettings

      Map<String,org.apache.activemq.artemis.core.settings.impl.AddressSettings> getAddressSettings()
      Returns A list of AddressSettings per matching to be deployed to the address settings repository.
      Returns:
      A list of AddressSettings per matching to be deployed to the address settings repository

    • setAddressSettings

      Configuration setAddressSettings(Map<String,org.apache.activemq.artemis.core.settings.impl.AddressSettings> addressSettings)
      Set the collection of AddressSettings indexed by address match.
      Parameters:
      addressSettings - list of AddressSettings per matching to be deployed to the address settings repository

    • addAddressSetting

      Configuration addAddressSetting(String key, org.apache.activemq.artemis.core.settings.impl.AddressSettings addressesSetting)
      Add an AddressSettings to the underlying collection.
      Parameters:
      key - the address match
      addressesSetting - the AddressSettings to add

    • clearAddressSettings

      Configuration clearAddressSettings()

    • getAddressesSettings

      @Deprecated Map<String,org.apache.activemq.artemis.core.settings.impl.AddressSettings> getAddressesSettings()
      Deprecated.

    • setAddressesSettings

      @Deprecated Configuration setAddressesSettings(Map<String,org.apache.activemq.artemis.core.settings.impl.AddressSettings> addressesSettings)
      Deprecated.

    • addAddressesSetting

      @Deprecated Configuration addAddressesSetting(String key, org.apache.activemq.artemis.core.settings.impl.AddressSettings addressesSetting)
      Deprecated.

    • clearAddressesSettings

      @Deprecated Configuration clearAddressesSettings()
      Deprecated.

    • setSecurityRoles

      Configuration setSecurityRoles(Map<String,Set<org.apache.activemq.artemis.core.security.Role>> roles)
      Set the collection of Role objects indexed by match (i.e. address name).
      Parameters:
      roles - a list of roles per matching

    • getSecurityRoles

      Map<String,Set<org.apache.activemq.artemis.core.security.Role>> getSecurityRoles()
      Returns a collection of roles indexed by matched.
      Returns:
      a collection of roles indexed by matched

    • addSecurityRoleNameMapping

      Configuration addSecurityRoleNameMapping(String internalRole, Set<String> externalRoles)

    • getSecurityRoleNameMappings

      Map<String,Set<String>> getSecurityRoleNameMappings()

    • putSecurityRoles

      Configuration putSecurityRoles(String match, Set<org.apache.activemq.artemis.core.security.Role> roles)

    • setConnectorServiceConfigurations

      Configuration setConnectorServiceConfigurations(List<ConnectorServiceConfiguration> configs)

    • addConnectorServiceConfiguration

      Configuration addConnectorServiceConfiguration(ConnectorServiceConfiguration config)

    • setSecuritySettingPlugins

      Configuration setSecuritySettingPlugins(List<org.apache.activemq.artemis.core.server.SecuritySettingPlugin> plugins)

    • addSecuritySettingPlugin

      Configuration addSecuritySettingPlugin(org.apache.activemq.artemis.core.server.SecuritySettingPlugin plugin)

    • setMetricsPlugin

      @Deprecated Configuration setMetricsPlugin(org.apache.activemq.artemis.core.server.metrics.ActiveMQMetricsPlugin plugin)
      Deprecated.

    • setMetricsConfiguration

      Configuration setMetricsConfiguration(MetricsConfiguration metricsConfiguration)

    • getConnectorServiceConfigurations

      List<ConnectorServiceConfiguration> getConnectorServiceConfigurations()
      Returns list of ConnectorServiceConfiguration.
      Returns:
      list of ConnectorServiceConfiguration

    • getSecuritySettingPlugins

      List<org.apache.activemq.artemis.core.server.SecuritySettingPlugin> getSecuritySettingPlugins()

    • getMetricsPlugin

      @Deprecated org.apache.activemq.artemis.core.server.metrics.ActiveMQMetricsPlugin getMetricsPlugin()
      Deprecated.

    • getMetricsConfiguration

      MetricsConfiguration getMetricsConfiguration()

    • setPasswordCodec

      Configuration setPasswordCodec(String codec)
      The default password decoder

    • getPasswordCodec

      String getPasswordCodec()
      Gets the default password decoder

    • setMaskPassword

      Configuration setMaskPassword(Boolean maskPassword)
      Sets if passwords should be masked or not. True means the passwords should be masked.

    • isMaskPassword

      Boolean isMaskPassword()
      If passwords are masked. True means the passwords are masked.

    • setResolveProtocols

      Configuration setResolveProtocols(boolean resolveProtocols)
      Whether to use all protocols available on the classpath. If false only the core protocol will be set, any other protocols will need to be set directly on the ActiveMQServer

    • getTransportConfigurations

      TransportConfiguration[] getTransportConfigurations(String... connectorNames)

    • getTransportConfigurations

      TransportConfiguration[] getTransportConfigurations(List<String> connectorNames)

    • isResolveProtocols

      boolean isResolveProtocols()
      Returns whether to resolve and use any Protocols available on the classpath; default is ActiveMQDefaultConfiguration.DEFAULT_RESOLVE_PROTOCOLS.
      Returns:
      whether to resolve and use any Protocols available on the classpath; default is ActiveMQDefaultConfiguration.DEFAULT_RESOLVE_PROTOCOLS

    • copy

      Configuration copy() throws Exception
      Throws:
      Exception

    • setJournalLockAcquisitionTimeout

      Configuration setJournalLockAcquisitionTimeout(long journalLockAcquisitionTimeout)

    • getJournalLockAcquisitionTimeout

      long getJournalLockAcquisitionTimeout()

    • getHAPolicyConfiguration

      HAPolicyConfiguration getHAPolicyConfiguration()

    • setHAPolicyConfiguration

      Configuration setHAPolicyConfiguration(HAPolicyConfiguration haPolicyConfiguration)

    • setBrokerInstance

      void setBrokerInstance(File directory)
      Set the Artemis instance relative folder for data and stuff.

    • getBrokerInstance

      File getBrokerInstance()
      Set the Artemis instance relative folder for data and stuff.

    • isJDBC

      default boolean isJDBC()

    • getStoreConfiguration

      StoreConfiguration getStoreConfiguration()

    • setStoreConfiguration

      Configuration setStoreConfiguration(StoreConfiguration storeConfiguration)

    • isPopulateValidatedUser

      boolean isPopulateValidatedUser()

    • setPopulateValidatedUser

      Configuration setPopulateValidatedUser(boolean populateValidatedUser)

    • isRejectEmptyValidatedUser

      boolean isRejectEmptyValidatedUser()

    • setRejectEmptyValidatedUser

      Configuration setRejectEmptyValidatedUser(boolean rejectEmptyValidatedUser)

    • debugConnectors

      String debugConnectors()
      It will return all the connectors in a toString manner for debug purposes.

    • setConnectionTtlCheckInterval

      Configuration setConnectionTtlCheckInterval(long connectionTtlCheckInterval)

    • getConnectionTtlCheckInterval

      long getConnectionTtlCheckInterval()

    • getConfigurationUrl

      URL getConfigurationUrl()

    • setConfigurationUrl

      Configuration setConfigurationUrl(URL configurationUrl)

    • getConfigurationFileRefreshPeriod

      long getConfigurationFileRefreshPeriod()

    • setConfigurationFileRefreshPeriod

      Configuration setConfigurationFileRefreshPeriod(long configurationFileRefreshPeriod)

    • getGlobalMaxSizePercentOfJvmMaxMemory

      int getGlobalMaxSizePercentOfJvmMaxMemory()

    • setGlobalMaxSizePercentOfJvmMaxMemory

      org.apache.activemq.artemis.core.config.impl.ConfigurationImpl setGlobalMaxSizePercentOfJvmMaxMemory(int percentOfJvmMaxMemory)

    • getGlobalMaxSize

      long getGlobalMaxSize()

    • setGlobalMaxSize

      Configuration setGlobalMaxSize(long globalMaxSize)

    • setGlobalMaxMessages

      Configuration setGlobalMaxMessages(long globalMaxMessages)

    • getGlobalMaxMessages

      long getGlobalMaxMessages()

    • getMaxDiskUsage

      int getMaxDiskUsage()

    • setMaxDiskUsage

      Configuration setMaxDiskUsage(int maxDiskUsage)

    • getMinDiskFree

      long getMinDiskFree()

    • setMinDiskFree

      Configuration setMinDiskFree(long minDiskFree)

    • setInternalNamingPrefix

      org.apache.activemq.artemis.core.config.impl.ConfigurationImpl setInternalNamingPrefix(String internalNamingPrefix)

    • setDiskScanPeriod

      Configuration setDiskScanPeriod(int diskScanPeriod)

    • getDiskScanPeriod

      int getDiskScanPeriod()

    • setNetworkCheckList

      Configuration setNetworkCheckList(String list)
      A comma separated list of IPs we could use to validate if the network is UP. In case of none of these Ips are reached (if configured) the server will be shutdown.

    • getNetworkCheckList

      String getNetworkCheckList()

    • setNetworkCheckURLList

      Configuration setNetworkCheckURLList(String uris)
      A comma separated list of URIs we could use to validate if the network is UP. In case of none of these Ips are reached (if configured) the server will be shutdown. The difference from networkCheckList is that we will use HTTP to make this validation.

    • getNetworkCheckURLList

      String getNetworkCheckURLList()

    • setNetworkCheckPeriod

      Configuration setNetworkCheckPeriod(long period)
      The interval on which we will perform network checks.

    • getNetworkCheckPeriod

      long getNetworkCheckPeriod()

    • setNetworkCheckTimeout

      Configuration setNetworkCheckTimeout(int timeout)
      Time in ms for how long we should wait for a ping to finish.

    • getNetworkCheckTimeout

      int getNetworkCheckTimeout()

    • setNetworCheckNIC

      @Deprecated Configuration setNetworCheckNIC(String nic)
      Deprecated.
      The NIC name to be used on network checks

    • setNetworkCheckNIC

      Configuration setNetworkCheckNIC(String nic)
      The NIC name to be used on network checks

    • getNetworkCheckNIC

      String getNetworkCheckNIC()

    • getNetworkCheckPingCommand

      String getNetworkCheckPingCommand()

    • setNetworkCheckPingCommand

      Configuration setNetworkCheckPingCommand(String command)

    • getNetworkCheckPing6Command

      String getNetworkCheckPing6Command()

    • setNetworkCheckPing6Command

      Configuration setNetworkCheckPing6Command(String command)

    • getInternalNamingPrefix

      String getInternalNamingPrefix()

    • getPageSyncTimeout

      int getPageSyncTimeout()
      Returns the timeout (in nanoseconds) used to sync pages; default is ArtemisConstants.DEFAULT_JOURNAL_BUFFER_TIMEOUT_NIO.
      Returns:
      the timeout (in nanoseconds) used to sync pages; default is ArtemisConstants.DEFAULT_JOURNAL_BUFFER_TIMEOUT_NIO

    • setPageSyncTimeout

      Configuration setPageSyncTimeout(int pageSyncTimeout)
      Sets the timeout (in nanoseconds) used to sync pages.

    • registerBrokerPlugins

      void registerBrokerPlugins(List<ActiveMQServerBasePlugin> plugins)

    • registerBrokerPlugin

      void registerBrokerPlugin(ActiveMQServerBasePlugin plugin)

    • unRegisterBrokerPlugin

      void unRegisterBrokerPlugin(ActiveMQServerBasePlugin plugin)

    • getBrokerPlugins

      List<ActiveMQServerBasePlugin> getBrokerPlugins()

    • getBrokerConnectionPlugins

      List<ActiveMQServerConnectionPlugin> getBrokerConnectionPlugins()

    • getBrokerSessionPlugins

      List<ActiveMQServerSessionPlugin> getBrokerSessionPlugins()

    • getBrokerConsumerPlugins

      List<ActiveMQServerConsumerPlugin> getBrokerConsumerPlugins()

    • getBrokerAddressPlugins

      List<ActiveMQServerAddressPlugin> getBrokerAddressPlugins()

    • getBrokerQueuePlugins

      List<ActiveMQServerQueuePlugin> getBrokerQueuePlugins()

    • getBrokerBindingPlugins

      List<ActiveMQServerBindingPlugin> getBrokerBindingPlugins()

    • getBrokerMessagePlugins

      List<ActiveMQServerMessagePlugin> getBrokerMessagePlugins()

    • getBrokerBridgePlugins

      List<ActiveMQServerBridgePlugin> getBrokerBridgePlugins()

    • getBrokerCriticalPlugins

      List<ActiveMQServerCriticalPlugin> getBrokerCriticalPlugins()

    • getBrokerFederationPlugins

      List<ActiveMQServerFederationPlugin> getBrokerFederationPlugins()

    • getBrokerAMQPFederationPlugins

      List<AMQPFederationBrokerPlugin> getBrokerAMQPFederationPlugins()

    • getFederationConfigurations

      List<FederationConfiguration> getFederationConfigurations()

    • getBrokerResourcePlugins

      List<ActiveMQServerResourcePlugin> getBrokerResourcePlugins()

    • getTemporaryQueueNamespace

      String getTemporaryQueueNamespace()

    • setTemporaryQueueNamespace

      Configuration setTemporaryQueueNamespace(String temporaryQueueNamespace)

    • setMqttSessionScanInterval

      Configuration setMqttSessionScanInterval(long mqttSessionScanInterval)
      This is necessary because the MQTT session scan interval is a broker-wide setting and can't be set on a per-connector basis like most of the other MQTT-specific settings.

    • getMqttSessionScanInterval

      long getMqttSessionScanInterval()
      Get the MQTT session scan interval
      See Also:

    • setMqttSessionStatePersistenceTimeout

      Configuration setMqttSessionStatePersistenceTimeout(long mqttSessionStatePersistenceTimeout)
      This is necessary because MQTT sessions and handled on a broker-wide basis so this can't be set on a per-connector basis like most of the other MQTT-specific settings.

    • getMqttSessionStatePersistenceTimeout

      long getMqttSessionStatePersistenceTimeout()
      Get the MQTT session state persistence timeout
      See Also:

    • isSuppressSessionNotifications

      boolean isSuppressSessionNotifications()
      Returns whether suppression of session-notifications is enabled for this server; default is ActiveMQDefaultConfiguration.DEFAULT_SUPPRESS_SESSION_NOTIFICATIONS.
      Returns:
      whether suppression of session-notifications is enabled for this server; default is ActiveMQDefaultConfiguration.DEFAULT_SUPPRESS_SESSION_NOTIFICATIONS

    • setSuppressSessionNotifications

      Configuration setSuppressSessionNotifications(boolean suppressSessionNotifications)

    • resolvePropertiesSources

      default String resolvePropertiesSources(String propertiesFileUrl)

    • getStatus

      String getStatus()

    • setStatus

      void setStatus(String status)
      This value can reflect a desired state (revision) of config. Useful when configurationFileRefreshPeriod > 0. Eventually with some coordination we can update it from various server components.

    • getLiteralMatchMarkers

      String getLiteralMatchMarkers()

    • setLiteralMatchMarkers

      Configuration setLiteralMatchMarkers(String literalMatchMarkers)

    • setLargeMessageSync

      Configuration setLargeMessageSync(boolean largeMessageSync)

    • isLargeMessageSync

      boolean isLargeMessageSync()

    • getViewPermissionMethodMatchPattern

      String getViewPermissionMethodMatchPattern()

    • setViewPermissionMethodMatchPattern

      void setViewPermissionMethodMatchPattern(String permissionMatchPattern)

    • isManagementMessageRbac

      boolean isManagementMessageRbac()

    • setManagementMessageRbac

      void setManagementMessageRbac(boolean val)

    • getManagementRbacPrefix

      String getManagementRbacPrefix()

    • setManagementRbacPrefix

      void setManagementRbacPrefix(String prefix)

    • getMirrorAckManagerQueueAttempts

      int getMirrorAckManagerQueueAttempts()
      This configures the Mirror Ack Manager number of attempts on queues before trying page acks. The default value here is 5.

    • setMirrorAckManagerQueueAttempts

      Configuration setMirrorAckManagerQueueAttempts(int queueAttempts)

    • getMirrorAckManagerPageAttempts

      int getMirrorAckManagerPageAttempts()
      This configures the Mirror Ack Manager number of attempts on page acks. The default value here is 2.

    • setMirrorAckManagerPageAttempts

      Configuration setMirrorAckManagerPageAttempts(int pageAttempts)

    • getMirrorAckManagerRetryDelay

      int getMirrorAckManagerRetryDelay()
      This configures the interval in which the Mirror AckManager will retry acks when It is not intended to be configured through the XML. The default value here is 100, and this is in milliseconds.

    • setMirrorAckManagerRetryDelay

      Configuration setMirrorAckManagerRetryDelay(int delay)

    • isMirrorPageTransaction

      boolean isMirrorPageTransaction()
      Should Mirror use Page Transactions When target destinations is paging? When a target queue on the mirror is paged, the mirror will not record a page transaction for every message. The default is false, and the overhead of paged messages will be smaller, but there is a possibility of eventual duplicates in case of interrupted communication between the mirror source and target. If you set this to true there will be a record stored on the journal for the page-transaction additionally to the record in the page store.

    • setMirrorPageTransaction

      Configuration setMirrorPageTransaction(boolean ignorePageTransactions)

    • setMirrorAckManagerWarnUnacked

      Configuration setMirrorAckManagerWarnUnacked(boolean warnUnacked)
      should log.warn when ack retries failed.

    • isMirrorAckManagerWarnUnacked

      boolean isMirrorAckManagerWarnUnacked()

    • exportAsProperties

      void exportAsProperties(File to) throws Exception
      Throws:
      Exception