Interface Configuration
-
- All Known Implementing Classes:
ConfigurationImpl,FileConfiguration
public interface ConfigurationA Configuration is used to configure ActiveMQ Artemis servers.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description ConfigurationaddAcceptorConfiguration(String name, String uri)Add an acceptor to the configConfigurationaddAcceptorConfiguration(TransportConfiguration infos)ConfigurationaddAddressConfiguration(CoreAddressConfiguration config)Adds an addresses configurationConfigurationaddAddressesSetting(String key, AddressSettings addressesSetting)Deprecated.ConfigurationaddAddressSetting(String key, AddressSettings addressesSetting)ConfigurationaddAMQPConnection(AMQPBrokerConnectConfiguration amqpBrokerConnectConfiguration)ConfigurationaddBroadcastGroupConfiguration(BroadcastGroupConfiguration config)ClusterConnectionConfigurationaddClusterConfiguration(String name, String uri)ConfigurationaddClusterConfiguration(ClusterConnectionConfiguration config)ConfigurationaddConnectionRouter(ConnectionRouterConfiguration config)ConfigurationaddConnectorConfiguration(String name, String uri)ConfigurationaddConnectorConfiguration(String key, TransportConfiguration info)ConfigurationaddConnectorServiceConfiguration(ConnectorServiceConfiguration config)ConfigurationaddDiscoveryGroupConfiguration(String key, DiscoveryGroupConfiguration discoveryGroupConfiguration)ConfigurationaddDivertConfiguration(DivertConfiguration config)ConfigurationaddQueueConfiguration(QueueConfiguration config)ConfigurationaddQueueConfiguration(CoreQueueConfiguration config)Deprecated.ConfigurationaddResourceLimitSettings(ResourceLimitSettings resourceLimitSettings)ConfigurationaddSecurityRoleNameMapping(String internalRole, Set<String> externalRoles)ConfigurationaddSecuritySettingPlugin(SecuritySettingPlugin plugin)ConfigurationclearAcceptorConfigurations()ConfigurationclearAddressesSettings()Deprecated.ConfigurationclearAddressSettings()ConfigurationclearClusterConfigurations()ConfigurationclearConnectorConfigurations()Configurationcopy()StringdebugConnectors()It will return all the connectors in a toString manner for debug purposes.Set<TransportConfiguration>getAcceptorConfigurations()Returns the acceptors configured for this server.List<CoreAddressConfiguration>getAddressConfigurations()Returns the addresses configured for this server.Map<String,AddressSettings>getAddressesSettings()Deprecated.longgetAddressQueueScanPeriod()Returns the frequency (in milliseconds) to scan addresses and queues to detect which ones should be deleted.Map<String,AddressSettings>getAddressSettings()List<AMQPBrokerConnectConfiguration>getAMQPConnection()longgetAuthenticationCacheSize()Returns the configured size of the authentication cache.longgetAuthorizationCacheSize()Returns the configured size of the authorization cache.StringgetBindingsDirectory()Returns the file system directory used to store bindings.FilegetBindingsLocation()The binding location related to artemis.instance.List<BridgeConfiguration>getBridgeConfigurations()Returns the bridges configured for this server.List<BroadcastGroupConfiguration>getBroadcastGroupConfigurations()Returns the broadcast groups configured for this server.List<ActiveMQServerAddressPlugin>getBrokerAddressPlugins()List<ActiveMQServerBindingPlugin>getBrokerBindingPlugins()List<ActiveMQServerBridgePlugin>getBrokerBridgePlugins()List<ActiveMQServerConnectionPlugin>getBrokerConnectionPlugins()List<ActiveMQServerConsumerPlugin>getBrokerConsumerPlugins()List<ActiveMQServerCriticalPlugin>getBrokerCriticalPlugins()List<ActiveMQServerFederationPlugin>getBrokerFederationPlugins()FilegetBrokerInstance()Set the Artemis instance relative folder for data and stuff.List<ActiveMQServerMessagePlugin>getBrokerMessagePlugins()List<ActiveMQServerBasePlugin>getBrokerPlugins()List<ActiveMQServerQueuePlugin>getBrokerQueuePlugins()List<ActiveMQServerResourcePlugin>getBrokerResourcePlugins()List<ActiveMQServerSessionPlugin>getBrokerSessionPlugins()List<ClusterConnectionConfiguration>getClusterConfigurations()Returns the cluster connections configured for this server.StringgetClusterPassword()Returns the cluster password for this server.StringgetClusterUser()Returns the cluster user for this server.longgetConfigurationFileRefreshPeriod()URLgetConfigurationUrl()List<ConnectionRouterConfiguration>getConnectionRouters()Returns the redirects configured for this server.longgetConnectionTtlCheckInterval()longgetConnectionTTLOverride()Returns the connection time to live.Map<String,TransportConfiguration>getConnectorConfigurations()Returns the connectors configured for this server.List<ConnectorServiceConfiguration>getConnectorServiceConfigurations()longgetCriticalAnalyzerCheckPeriod()CriticalAnalyzerPolicygetCriticalAnalyzerPolicy()longgetCriticalAnalyzerTimeout()Map<String,DiscoveryGroupConfiguration>getDiscoveryGroupConfigurations()Returns the discovery groups configured for this server.intgetDiskScanPeriod()List<DivertConfiguration>getDivertConfigurations()Returns the diverts configured for this server.List<FederationConfiguration>getFederationConfigurations()longgetFileDeployerScanPeriod()Returns the period (in milliseconds) to scan configuration files used by deployment.longgetGlobalMaxMessages()longgetGlobalMaxSize()longgetGracefulShutdownTimeout()Returns the graceful shutdown timeout for this server.GroupingHandlerConfigurationgetGroupingHandlerConfiguration()Returns the grouping handler configured for this server.HAPolicyConfigurationgetHAPolicyConfiguration()intgetIDCacheSize()Returns the size of the cache for pre-creating message IDs.List<String>getIncomingInterceptorClassNames()Returns the list of interceptors classes used by this server for incoming messages (i.e.StringgetInternalNamingPrefix()StringgetJMXDomain()Returns the domain used by JMX MBeans (provided JMX management is enabled).intgetJournalBufferSize_AIO()Returns the buffer size (in bytes) for AIO.intgetJournalBufferSize_NIO()Returns the buffer size (in bytes) for NIO.intgetJournalBufferTimeout_AIO()Returns the timeout (in nanoseconds) used to flush buffers in the AIO queue.intgetJournalBufferTimeout_NIO()Returns the timeout (in nanoseconds) used to flush buffers in the NIO.intgetJournalCompactMinFiles()Returns the minimal number of journal files before compacting.intgetJournalCompactPercentage()Returns the percentage of live data before compacting the journal.IntegergetJournalDeviceBlockSize()This is the device block size used on writing.StringgetJournalDirectory()Returns the file system directory used to store journal log.intgetJournalFileOpenTimeout()intgetJournalFileSize()Returns the size (in bytes) of each journal files.FilegetJournalLocation()The location of the journal related to artemis.instance.longgetJournalLockAcquisitionTimeout()intgetJournalMaxAtticFiles()Returns the maximal number of data files before we can start deleting corrupted files instead of moving them to attic.intgetJournalMaxIO_AIO()Returns the maximum number of write requests that can be in the AIO queue at any given time.intgetJournalMaxIO_NIO()Returns the maximum number of write requests for NIO journal.intgetJournalMinFiles()Returns the number of journal files to pre-create.intgetJournalPoolFiles()Number of files that would be acceptable to keep on a pool.StringgetJournalRetentionDirectory()FilegetJournalRetentionLocation()longgetJournalRetentionMaxBytes()longgetJournalRetentionPeriod()The retention period for the journal in milliseconds (always in milliseconds, a conversion is performed on set)JournalTypegetJournalType()Returns the type of journal used by this server (NIO,ASYNCIOorMAPPED).StringgetLargeMessagesDirectory()Returns the file system directory used to store large messages.FilegetLargeMessagesLocation()The large message location related to artemis.instanceSimpleStringgetManagementAddress()Returns the management address of this server.SimpleStringgetManagementNotificationAddress()Returns the management notification address of this server.intgetMaxDiskUsage()intgetMaxRedeliveryRecords()longgetMemoryMeasureInterval()intgetMemoryWarningThreshold()intgetMessageCounterMaxDayHistory()Returns the maximum number of days kept in memory for message counter.longgetMessageCounterSamplePeriod()Returns the sample period (in milliseconds) to take message counter snapshot.longgetMessageExpiryScanPeriod()Returns the frequency (in milliseconds) to scan messages to detect which messages have expired.intgetMessageExpiryThreadPriority()Deprecated.MetricsConfigurationgetMetricsConfiguration()ActiveMQMetricsPlugingetMetricsPlugin()Deprecated.longgetMqttSessionScanInterval()StringgetName()To be used on dependency management on the application serverStringgetNetworkCheckList()StringgetNetworkCheckNIC()longgetNetworkCheckPeriod()StringgetNetworkCheckPing6Command()StringgetNetworkCheckPingCommand()intgetNetworkCheckTimeout()StringgetNetworkCheckURLList()StringgetNodeManagerLockDirectory()the directory that contains the lock fileFilegetNodeManagerLockLocation()The location of the node manager lock file related to artemis.instance.List<String>getOutgoingInterceptorClassNames()Returns the list of interceptors classes used by this server for outgoing messages (i.e.intgetPageMaxConcurrentIO()The max number of concurrent reads allowed on paging.intgetPageSyncTimeout()Returns the timeout (in nanoseconds) used to sync pages.StringgetPagingDirectory()Returns the file system directory used to store paging files.FilegetPagingLocation()The paging location related to artemis.instanceStringgetPasswordCodec()Gets the default password decoderList<QueueConfiguration>getQueueConfigs()List<CoreQueueConfiguration>getQueueConfigurations()Deprecated.Map<String,ResourceLimitSettings>getResourceLimitSettings()intgetScheduledThreadPoolMaxSize()Returns the maximum number of threads in the scheduled thread pool of this server.longgetSecurityInvalidationInterval()Returns the interval time (in milliseconds) to invalidate security credentials.Map<String,Set<String>>getSecurityRoleNameMappings()Map<String,Set<Role>>getSecurityRoles()List<SecuritySettingPlugin>getSecuritySettingPlugins()longgetServerDumpInterval()StringgetStatus()StoreConfigurationgetStoreConfiguration()StringgetSystemPropertyPrefix()See doc atsetSystemPropertyPrefix(String).StringgetTemporaryQueueNamespace()intgetThreadPoolMaxSize()Returns the maximum number of threads in the thread pool of this server.longgetTransactionTimeout()Returns the timeout (in milliseconds) after which transactions is removed from the resource manager after it was created.longgetTransactionTimeoutScanPeriod()Returns the frequency (in milliseconds) to scan transactions to detect which transactions have timed out.TransportConfiguration[]getTransportConfigurations(String... connectorNames)TransportConfiguration[]getTransportConfigurations(List<String> connectorNames)WildcardConfigurationgetWildcardConfiguration()booleanisAmqpUseCoreSubscriptionNaming()Returns if to use Core subscription naming for AMQP.booleanisAsyncConnectionExecutionEnabled()Deprecated.booleanisClustered()Returns whether this server is clustered.booleanisCreateBindingsDir()Returns whether the bindings directory is created on this server startup.booleanisCreateJournalDir()Returns whether the journal directory is created on this server startup.booleanisCriticalAnalyzer()booleanisGracefulShutdownEnabled()Returns whether graceful shutdown is enabled for this server.default booleanisJDBC()booleanisJMXManagementEnabled()Returns whether this server is manageable using JMX or not.booleanisJMXUseBrokerName()whether or not to use the broker name in the JMX treebooleanisJournalDatasync()Should use fdatasync on journal files.booleanisJournalSyncNonTransactional()Returns whether the journal is synchronized when receiving non-transactional data.booleanisJournalSyncTransactional()Returns whether the journal is synchronized when receiving transactional data.booleanisLogJournalWriteRate()BooleanisMaskPassword()If passwords are masked.booleanisMessageCounterEnabled()Returns whether message counter is enabled for this server.booleanisPersistDeliveryCountBeforeDelivery()Returns whether delivery count is persisted before messages are delivered to the consumers.booleanisPersistenceEnabled()Returns whether this server is using persistence and store data.booleanisPersistIDCache()Returns whether message ID cache is persisted.booleanisPopulateValidatedUser()booleanisReadWholePage()Returns whether the whole page is read while getting message after page cache is evicted.booleanisRejectEmptyValidatedUser()booleanisResolveProtocols()booleanisSecurityEnabled()Returns whether security is enabled for this server.booleanisSuppressSessionNotifications()Returns whether suppression of session-notifications is enabled for this server.booleanisWildcardRoutingEnabled()Returns whether wildcard routing is supported by this server.voidparsePrefixedProperties(Object target, String name, Properties properties, String prefix)ConfigurationparseProperties(String optionalUrlToPropertiesFile)ConfigurationputSecurityRoles(String match, Set<Role> roles)voidregisterBrokerPlugin(ActiveMQServerBasePlugin plugin)voidregisterBrokerPlugins(List<ActiveMQServerBasePlugin> plugins)default StringresolvePropertiesSources(String propertiesFileUrl)ConfigurationsetAcceptorConfigurations(Set<TransportConfiguration> infos)Sets the acceptors configured for this server.ConfigurationsetAddressConfigurations(List<CoreAddressConfiguration> configs)Sets the addresses configured for this server.ConfigurationsetAddressesSettings(Map<String,AddressSettings> addressesSettings)Deprecated.ConfigurationsetAddressQueueScanPeriod(long addressQueueScanPeriod)Sets the frequency (in milliseconds) to scan addresses and queues to detect which ones should be deleted.ConfigurationsetAddressSettings(Map<String,AddressSettings> addressSettings)ConfigurationsetAmqpUseCoreSubscriptionNaming(boolean amqpUseCoreSubscriptionNaming)Sets if to use Core subscription naming for AMQP.ConfigurationsetAuthenticationCacheSize(long size)Sets the size of the authentication cache.ConfigurationsetAuthorizationCacheSize(long size)Sets the size of the authorization cache.ConfigurationsetBindingsDirectory(String dir)Sets the file system directory used to store bindings.ConfigurationsetBridgeConfigurations(List<BridgeConfiguration> configs)Sets the bridges configured for this server.ConfigurationsetBroadcastGroupConfigurations(List<BroadcastGroupConfiguration> configs)Sets the broadcast groups configured for this server.voidsetBrokerInstance(File directory)Set the Artemis instance relative folder for data and stuff.ConfigurationsetClusterConfigurations(List<ClusterConnectionConfiguration> configs)Sets the cluster connections configured for this server.ConfigurationsetClusterPassword(String password)Sets the cluster password for this server.ConfigurationsetClusterUser(String user)Sets the cluster user for this server.ConfigurationsetConfigurationFileRefreshPeriod(long configurationFileRefreshPeriod)ConfigurationsetConfigurationUrl(URL configurationUrl)ConfigurationsetConnectionRouters(List<ConnectionRouterConfiguration> configs)Sets the redirects configured for this server.ConfigurationsetConnectionTtlCheckInterval(long connectionTtlCheckInterval)ConfigurationsetConnectionTTLOverride(long ttl)Sets the connection time to live.ConfigurationsetConnectorConfigurations(Map<String,TransportConfiguration> infos)Sets the connectors configured for this server.ConfigurationsetConnectorServiceConfigurations(List<ConnectorServiceConfiguration> configs)ConfigurationsetCreateBindingsDir(boolean create)Sets whether the bindings directory is created on this server startup.ConfigurationsetCreateJournalDir(boolean create)Sets whether the journal directory is created on this server startup.ConfigurationsetCriticalAnalyzer(boolean CriticalAnalyzer)ConfigurationsetCriticalAnalyzerCheckPeriod(long checkPeriod)ConfigurationsetCriticalAnalyzerPolicy(CriticalAnalyzerPolicy policy)ConfigurationsetCriticalAnalyzerTimeout(long timeout)ConfigurationsetDiscoveryGroupConfigurations(Map<String,DiscoveryGroupConfiguration> configs)Sets the discovery groups configured for this server.ConfigurationsetDiskScanPeriod(int diskScanPeriod)ConfigurationsetDivertConfigurations(List<DivertConfiguration> configs)Sets the diverts configured for this server.ConfigurationsetEnabledAsyncConnectionExecution(boolean enabled)Deprecated.ConfigurationsetFileDeployerScanPeriod(long period)Sets the period to scan configuration files used by deployment.ConfigurationsetGlobalMaxMessages(long globalMaxMessages)ConfigurationsetGlobalMaxSize(long globalMaxSize)ConfigurationsetGracefulShutdownEnabled(boolean enabled)Sets whether security is enabled for this server.ConfigurationsetGracefulShutdownTimeout(long timeout)Sets the graceful shutdown timeoutConfigurationsetGroupingHandlerConfiguration(GroupingHandlerConfiguration groupingHandlerConfiguration)Sets the grouping handler configured for this server.ConfigurationsetHAPolicyConfiguration(HAPolicyConfiguration haPolicyConfiguration)ConfigurationsetIDCacheSize(int idCacheSize)Sets the size of the cache for pre-creating message IDs.ConfigurationsetIncomingInterceptorClassNames(List<String> interceptors)Sets the list of interceptors classes used by this server for incoming messages (i.e.ConfigurationImplsetInternalNamingPrefix(String internalNamingPrefix)ConfigurationsetJMXDomain(String domain)Sets the domain used by JMX MBeans (provided JMX management is enabled).ConfigurationsetJMXManagementEnabled(boolean enabled)Sets whether this server is manageable using JMX or not.ConfigurationImplsetJMXUseBrokerName(boolean jmxUseBrokerName)whether or not to use the broker name in the JMX treeConfigurationsetJournalBufferSize_AIO(int journalBufferSize)Sets the buffer size (in bytes) for AIO.ConfigurationsetJournalBufferSize_NIO(int journalBufferSize)Sets the buffer size (in bytes) for NIO.ConfigurationsetJournalBufferTimeout_AIO(int journalBufferTimeout)Sets the timeout (in nanoseconds) used to flush buffers in the AIO queue.ConfigurationsetJournalBufferTimeout_NIO(int journalBufferTimeout)Sets the timeout (in nanoseconds) used to flush buffers in the NIO.ConfigurationsetJournalCompactMinFiles(int minFiles)Sets the minimal number of journal files before compacting.ConfigurationsetJournalCompactPercentage(int percentage)Sets the percentage of live data before compacting the journal.ConfigurationsetJournalDatasync(boolean enable)documented atisJournalDatasync()()}ConfigurationsetJournalDeviceBlockSize(Integer deviceBlockSize)ConfigurationsetJournalDirectory(String dir)Sets the file system directory used to store journal log.ConfigurationsetJournalFileOpenTimeout(int journalFileOpenTimeout)Sets the journal file open timeoutConfigurationsetJournalFileSize(int size)Sets the size (in bytes) of each journal files.ConfigurationsetJournalLockAcquisitionTimeout(long journalLockAcquisitionTimeout)ConfigurationsetJournalMaxAtticFiles(int maxAtticFiles)Sets the maximal number of data files before we can start deleting corrupted files instead of moving them to attic.ConfigurationsetJournalMaxIO_AIO(int journalMaxIO)Sets the maximum number of write requests that can be in the AIO queue at any given time.ConfigurationsetJournalMaxIO_NIO(int journalMaxIO)Sets the maximum number of write requests for NIO journal.ConfigurationsetJournalMinFiles(int files)Sets the number of journal files to pre-create.ConfigurationsetJournalPoolFiles(int poolSize)Number of files that would be acceptable to keep on a pool.ConfigurationsetJournalRetentionDirectory(String dir)Sets the file system directory used to store historical backup journal.ConfigurationsetJournalRetentionMaxBytes(long bytes)ConfigurationsetJournalRetentionPeriod(TimeUnit unit, long limit)ConfigurationsetJournalSyncNonTransactional(boolean sync)Sets whether the journal is synchronized when receiving non-transactional data.ConfigurationsetJournalSyncTransactional(boolean sync)Sets whether the journal is synchronized when receiving transactional data.ConfigurationsetJournalType(JournalType type)Sets the type of journal used by this server (eitherNIOorASYNCIO).ConfigurationsetLargeMessagesDirectory(String directory)Sets the file system directory used to store large messages.ConfigurationsetLogJournalWriteRate(boolean rate)ConfigurationsetManagementAddress(SimpleString address)Sets the management address of this server.ConfigurationsetManagementNotificationAddress(SimpleString address)Sets the management notification address of this server.ConfigurationsetMaskPassword(Boolean maskPassword)Sets if passwords should be masked or not.ConfigurationsetMaxDiskUsage(int maxDiskUsage)ConfigurationsetMaxRedeliveryRecords(int maxPersistRedelivery)Maximum number of redelivery records stored on the journal per message reference.ConfigurationsetMemoryMeasureInterval(long memoryMeasureInterval)ConfigurationsetMemoryWarningThreshold(int memoryWarningThreshold)ConfigurationsetMessageCounterEnabled(boolean enabled)Sets whether message counter is enabled for this server.ConfigurationsetMessageCounterMaxDayHistory(int maxDayHistory)Sets the maximum number of days kept in memory for message counter.ConfigurationsetMessageCounterSamplePeriod(long period)Sets the sample period to take message counter snapshot.ConfigurationsetMessageExpiryScanPeriod(long messageExpiryScanPeriod)Sets the frequency (in milliseconds) to scan messages to detect which messages have expired.ConfigurationsetMessageExpiryThreadPriority(int messageExpiryThreadPriority)Deprecated.ConfigurationsetMetricsConfiguration(MetricsConfiguration metricsConfiguration)ConfigurationsetMetricsPlugin(ActiveMQMetricsPlugin plugin)Deprecated.ConfigurationsetMqttSessionScanInterval(long mqttSessionScanInterval)This is specific to MQTT, and it's necessary because the session scan interval is a broker-wide setting and can't be set on a per-connector basis like the rest of the MQTT-specific settings.ConfigurationsetName(String name)To be used on dependency management on the application serverConfigurationsetNetworCheckNIC(String nic)Deprecated.ConfigurationsetNetworkCheckList(String list)A comma separated list of IPs we could use to validate if the network is UP.ConfigurationsetNetworkCheckNIC(String nic)The NIC name to be used on network checksConfigurationsetNetworkCheckPeriod(long period)The interval on which we will perform network checks.ConfigurationsetNetworkCheckPing6Command(String command)ConfigurationsetNetworkCheckPingCommand(String command)ConfigurationsetNetworkCheckTimeout(int timeout)Time in ms for how long we should wait for a ping to finish.ConfigurationsetNetworkCheckURLList(String uris)A comma separated list of URIs we could use to validate if the network is UP.ConfigurationsetNodeManagerLockDirectory(String dir)Sets the file system directory used to store the node manager lock file.ConfigurationsetOutgoingInterceptorClassNames(List<String> interceptors)Sets the list of interceptors classes used by this server for outgoing messages (i.e.ConfigurationsetPageMaxConcurrentIO(int maxIO)The max number of concurrent reads allowed on paging.ConfigurationsetPageSyncTimeout(int pageSyncTimeout)Sets the timeout (in nanoseconds) used to sync pages.ConfigurationsetPagingDirectory(String dir)Sets the file system directory used to store paging files.ConfigurationsetPasswordCodec(String codec)The default password decoderConfigurationsetPersistDeliveryCountBeforeDelivery(boolean persistDeliveryCountBeforeDelivery)Sets whether delivery count is persisted before messages are delivered to consumers.ConfigurationsetPersistenceEnabled(boolean enable)Sets whether this server is using persistence and store data.ConfigurationsetPersistIDCache(boolean persist)Sets whether message ID cache is persisted.ConfigurationsetPopulateValidatedUser(boolean populateValidatedUser)ConfigurationsetQueueConfigs(List<QueueConfiguration> configs)Sets the queues configured for this server.ConfigurationsetQueueConfigurations(List<CoreQueueConfiguration> configs)Deprecated.ConfigurationsetReadWholePage(boolean read)Sets whether the whole page is read while getting message after page cache is evicted.ConfigurationsetRejectEmptyValidatedUser(boolean rejectEmptyValidatedUser)ConfigurationsetResolveProtocols(boolean resolveProtocols)ConfigurationsetResourceLimitSettings(Map<String,ResourceLimitSettings> resourceLimitSettings)ConfigurationsetScheduledThreadPoolMaxSize(int maxSize)Sets the maximum number of threads in the scheduled thread pool of this server.ConfigurationsetSecurityEnabled(boolean enabled)Sets whether security is enabled for this server.ConfigurationsetSecurityInvalidationInterval(long interval)Sets the interval time (in milliseconds) to invalidate security credentials.ConfigurationsetSecurityRoles(Map<String,Set<Role>> roles)ConfigurationsetSecuritySettingPlugins(List<SecuritySettingPlugin> plugins)ConfigurationsetServerDumpInterval(long interval)voidsetStatus(String status)This value can reflect a desired state (revision) of config.ConfigurationsetStoreConfiguration(StoreConfiguration storeConfiguration)ConfigurationsetSuppressSessionNotifications(boolean suppressSessionNotifications)ConfigurationsetSystemPropertyPrefix(String systemPropertyPrefix)We use Bean-utils to pass in System.properties that start withsetSystemPropertyPrefix(String).ConfigurationsetTemporaryQueueNamespace(String temporaryQueueNamespace)ConfigurationsetThreadPoolMaxSize(int maxSize)Sets the maximum number of threads in the thread pool of this server.ConfigurationsetTransactionTimeout(long timeout)Sets the timeout (in milliseconds) after which transactions is removed from the resource manager after it was created.ConfigurationsetTransactionTimeoutScanPeriod(long period)Sets the frequency (in milliseconds) to scan transactions to detect which transactions have timed out.ConfigurationsetWildCardConfiguration(WildcardConfiguration wildcardConfiguration)ConfigurationsetWildcardRoutingEnabled(boolean enabled)Sets whether wildcard routing is supported by this server.voidunRegisterBrokerPlugin(ActiveMQServerBasePlugin plugin)
-
-
-
Method Detail
-
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 withsetSystemPropertyPrefix(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.- Parameters:
systemPropertyPrefix-- Returns:
-
getSystemPropertyPrefix
String getSystemPropertyPrefix()
See doc atsetSystemPropertyPrefix(String).- Returns:
-
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
CriticalAnalyzerPolicy getCriticalAnalyzerPolicy()
-
setCriticalAnalyzerPolicy
Configuration setCriticalAnalyzerPolicy(CriticalAnalyzerPolicy policy)
-
isClustered
boolean isClustered()
-
isPersistDeliveryCountBeforeDelivery
boolean isPersistDeliveryCountBeforeDelivery()
Returns whether delivery count is persisted before messages are delivered to the consumers.
Default value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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:
- fdatasync
-
setJournalDatasync
Configuration setJournalDatasync(boolean enable)
documented atisJournalDatasync()()}- Parameters:
enable-- Returns:
- this
-
getResourceLimitSettings
Map<String,ResourceLimitSettings> getResourceLimitSettings()
- Returns:
- usernames mapped to ResourceLimitSettings
-
setResourceLimitSettings
Configuration setResourceLimitSettings(Map<String,ResourceLimitSettings> resourceLimitSettings)
- Parameters:
resourceLimitSettings- usernames mapped to ResourceLimitSettings
-
addResourceLimitSettings
Configuration addResourceLimitSettings(ResourceLimitSettings resourceLimitSettings)
- Parameters:
resourceLimitSettings- usernames mapped to ResourceLimitSettings
-
getFileDeployerScanPeriod
long getFileDeployerScanPeriod()
Returns the period (in milliseconds) to scan configuration files used by deployment.
Default value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.DEFAULT_AUTHORIZATION_CACHE_SIZE.
-
isSecurityEnabled
boolean isSecurityEnabled()
Returns whether security is enabled for this server.
Default value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.DEFAULT_JMX_MANAGEMENT_ENABLED.
-
setJMXManagementEnabled
Configuration setJMXManagementEnabled(boolean enabled)
Sets whether this server is manageable using JMX or not.
Default value isActiveMQDefaultConfiguration.DEFAULT_JMX_MANAGEMENT_ENABLED.
-
getJMXDomain
String getJMXDomain()
Returns the domain used by JMX MBeans (provided JMX management is enabled).
Default value isActiveMQDefaultConfiguration.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 or not to use the broker name in the JMX tree
-
setJMXUseBrokerName
ConfigurationImpl setJMXUseBrokerName(boolean jmxUseBrokerName)
whether or not 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).
-
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).
-
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 implementInterceptor.
-
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 implementInterceptor.
-
getConnectionTTLOverride
long getConnectionTTLOverride()
Returns the connection time to live.
This value overrides the connection time to live sent by the client.
Default value isActiveMQDefaultConfiguration.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.
-
setAmqpUseCoreSubscriptionNaming
Configuration setAmqpUseCoreSubscriptionNaming(boolean amqpUseCoreSubscriptionNaming)
Sets if to use Core subscription naming for AMQP.
-
isAsyncConnectionExecutionEnabled
@Deprecated boolean isAsyncConnectionExecutionEnabled()
Deprecated.deprecated: we decide based on the semantic context when to make things async or not Returns whether code coming from connection is executed asynchronously or not.
Default value isActiveMQDefaultConfiguration.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.
-
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 acceptoruri- the URI of the acceptor- Returns:
- this
- Throws:
Exception- in case of Parsing errors on the URI- See Also:
- Configuring the Transport
-
clearAcceptorConfigurations
Configuration clearAcceptorConfigurations()
-
getConnectorConfigurations
Map<String,TransportConfiguration> getConnectorConfigurations()
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.
-
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.
-
setDiscoveryGroupConfigurations
Configuration setDiscoveryGroupConfigurations(Map<String,DiscoveryGroupConfiguration> configs)
Sets the discovery groups configured for this server.
-
addDiscoveryGroupConfiguration
Configuration addDiscoveryGroupConfiguration(String key, DiscoveryGroupConfiguration discoveryGroupConfiguration)
-
getGroupingHandlerConfiguration
GroupingHandlerConfiguration getGroupingHandlerConfiguration()
Returns the grouping handler configured for this server.
-
setGroupingHandlerConfiguration
Configuration setGroupingHandlerConfiguration(GroupingHandlerConfiguration groupingHandlerConfiguration)
Sets the grouping handler configured for this server.
-
getBridgeConfigurations
List<BridgeConfiguration> getBridgeConfigurations()
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.
-
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.
-
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
ClusterConnectionConfigurationused 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()
-
getQueueConfigurations
@Deprecated List<CoreQueueConfiguration> getQueueConfigurations()
Deprecated.Returns the queues configured for this server.
-
getQueueConfigs
List<QueueConfiguration> getQueueConfigs()
-
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.
-
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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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()
The max number of concurrent reads allowed on paging.Default value 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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.DEFAULT_JOURNAL_DIR.
-
getJournalLocation
File getJournalLocation()
The location of the journal related to artemis.instance.- Returns:
-
getNodeManagerLockLocation
File getNodeManagerLockLocation()
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()
the directory that contains the lock file- Returns:
- the directory
-
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()
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
JournalType getJournalType()
Returns the type of journal used by this server (NIO,ASYNCIOorMAPPED).
Default value is ASYNCIO.
-
setJournalType
Configuration setJournalType(JournalType type)
Sets the type of journal used by this server (eitherNIOorASYNCIO).
-
isJournalSyncTransactional
boolean isJournalSyncTransactional()
Returns whether the journal is synchronized when receiving transactional data.
Default value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.DEFAULT_JOURNAL_POOL_FILES.
-
setJournalPoolFiles
Configuration setJournalPoolFiles(int poolSize)
Number of files that would be acceptable to keep on a pool. Default value isActiveMQDefaultConfiguration.DEFAULT_JOURNAL_POOL_FILES.
-
getJournalCompactPercentage
int getJournalCompactPercentage()
Returns the percentage of live data before compacting the journal.
Default value isActiveMQDefaultConfiguration.DEFAULT_JOURNAL_COMPACT_PERCENTAGE.
-
getJournalFileOpenTimeout
int getJournalFileOpenTimeout()
- 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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isArtemisConstants.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 mans 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)
- See Also:
getJournalDeviceBlockSize()
-
getJournalBufferSize_AIO
int getJournalBufferSize_AIO()
Returns the buffer size (in bytes) for AIO.
Default value isArtemisConstants.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 value isActiveMQDefaultConfiguration.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 value isArtemisConstants.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 value isArtemisConstants.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 isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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 value isActiveMQDefaultConfiguration.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,AddressSettings> getAddressSettings()
- Returns:
- A list of AddressSettings per matching to be deployed to the address settings repository
-
setAddressSettings
Configuration setAddressSettings(Map<String,AddressSettings> addressSettings)
- Parameters:
addressSettings- list of AddressSettings per matching to be deployed to the address settings repository
-
addAddressSetting
Configuration addAddressSetting(String key, AddressSettings addressesSetting)
-
clearAddressSettings
Configuration clearAddressSettings()
-
getAddressesSettings
@Deprecated Map<String,AddressSettings> getAddressesSettings()
Deprecated.
-
setAddressesSettings
@Deprecated Configuration setAddressesSettings(Map<String,AddressSettings> addressesSettings)
Deprecated.
-
addAddressesSetting
@Deprecated Configuration addAddressesSetting(String key, AddressSettings addressesSetting)
Deprecated.
-
clearAddressesSettings
@Deprecated Configuration clearAddressesSettings()
Deprecated.
-
setSecurityRoles
Configuration setSecurityRoles(Map<String,Set<Role>> roles)
- Parameters:
roles- a list of roles per matching
-
addSecurityRoleNameMapping
Configuration addSecurityRoleNameMapping(String internalRole, Set<String> externalRoles)
-
putSecurityRoles
Configuration putSecurityRoles(String match, Set<Role> roles)
-
setConnectorServiceConfigurations
Configuration setConnectorServiceConfigurations(List<ConnectorServiceConfiguration> configs)
-
addConnectorServiceConfiguration
Configuration addConnectorServiceConfiguration(ConnectorServiceConfiguration config)
-
setSecuritySettingPlugins
Configuration setSecuritySettingPlugins(List<SecuritySettingPlugin> plugins)
-
addSecuritySettingPlugin
Configuration addSecuritySettingPlugin(SecuritySettingPlugin plugin)
-
setMetricsPlugin
@Deprecated Configuration setMetricsPlugin(ActiveMQMetricsPlugin plugin)
Deprecated.
-
setMetricsConfiguration
Configuration setMetricsConfiguration(MetricsConfiguration metricsConfiguration)
-
getConnectorServiceConfigurations
List<ConnectorServiceConfiguration> getConnectorServiceConfigurations()
- Returns:
- list of
ConnectorServiceConfiguration
-
getSecuritySettingPlugins
List<SecuritySettingPlugin> getSecuritySettingPlugins()
-
getMetricsPlugin
@Deprecated 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.enableda
-
setResolveProtocols
Configuration setResolveProtocols(boolean resolveProtocols)
-
getTransportConfigurations
TransportConfiguration[] getTransportConfigurations(String... connectorNames)
-
getTransportConfigurations
TransportConfiguration[] getTransportConfigurations(List<String> connectorNames)
-
isResolveProtocols
boolean isResolveProtocols()
-
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)
-
getGlobalMaxSize
long getGlobalMaxSize()
-
setGlobalMaxSize
Configuration setGlobalMaxSize(long globalMaxSize)
-
setGlobalMaxMessages
Configuration setGlobalMaxMessages(long globalMaxMessages)
-
getGlobalMaxMessages
long getGlobalMaxMessages()
-
getMaxDiskUsage
int getMaxDiskUsage()
-
setMaxDiskUsage
Configuration setMaxDiskUsage(int maxDiskUsage)
-
setInternalNamingPrefix
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 value isArtemisConstants.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)
- Parameters:
plugins-
-
registerBrokerPlugin
void registerBrokerPlugin(ActiveMQServerBasePlugin plugin)
- Parameters:
plugin-
-
unRegisterBrokerPlugin
void unRegisterBrokerPlugin(ActiveMQServerBasePlugin plugin)
- Parameters:
plugin-
-
getBrokerPlugins
List<ActiveMQServerBasePlugin> getBrokerPlugins()
- Returns:
-
getBrokerConnectionPlugins
List<ActiveMQServerConnectionPlugin> getBrokerConnectionPlugins()
- Returns:
-
getBrokerSessionPlugins
List<ActiveMQServerSessionPlugin> getBrokerSessionPlugins()
- Returns:
-
getBrokerConsumerPlugins
List<ActiveMQServerConsumerPlugin> getBrokerConsumerPlugins()
- Returns:
-
getBrokerAddressPlugins
List<ActiveMQServerAddressPlugin> getBrokerAddressPlugins()
- Returns:
-
getBrokerQueuePlugins
List<ActiveMQServerQueuePlugin> getBrokerQueuePlugins()
- Returns:
-
getBrokerBindingPlugins
List<ActiveMQServerBindingPlugin> getBrokerBindingPlugins()
- Returns:
-
getBrokerMessagePlugins
List<ActiveMQServerMessagePlugin> getBrokerMessagePlugins()
- Returns:
-
getBrokerBridgePlugins
List<ActiveMQServerBridgePlugin> getBrokerBridgePlugins()
- Returns:
-
getBrokerCriticalPlugins
List<ActiveMQServerCriticalPlugin> getBrokerCriticalPlugins()
- Returns:
-
getBrokerFederationPlugins
List<ActiveMQServerFederationPlugin> getBrokerFederationPlugins()
- Returns:
-
getFederationConfigurations
List<FederationConfiguration> getFederationConfigurations()
- Returns:
-
getBrokerResourcePlugins
List<ActiveMQServerResourcePlugin> getBrokerResourcePlugins()
- Returns:
-
getTemporaryQueueNamespace
String getTemporaryQueueNamespace()
-
setTemporaryQueueNamespace
Configuration setTemporaryQueueNamespace(String temporaryQueueNamespace)
-
setMqttSessionScanInterval
Configuration setMqttSessionScanInterval(long mqttSessionScanInterval)
This is specific to MQTT, and it's necessary because the session scan interval is a broker-wide setting and can't be set on a per-connector basis like the rest of the MQTT-specific settings.
-
getMqttSessionScanInterval
long getMqttSessionScanInterval()
- Returns:
- See Also:
setMqttSessionScanInterval(long)
-
isSuppressSessionNotifications
boolean isSuppressSessionNotifications()
Returns whether suppression of session-notifications is enabled for this server.
Default value isActiveMQDefaultConfiguration.DEFAULT_SUPPRESS_SESSION_NOTIFICATIONS.
-
setSuppressSessionNotifications
Configuration setSuppressSessionNotifications(boolean suppressSessionNotifications)
-
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.
-
-