Configuration (JBoss Application Server: Build 7.1.2.Final API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

ConfigurationImpl, FileConfiguration
```
public interface Configuration
extends Serializable
```
A Configuration is used to configure HornetQ servers.

Author:

Tim Fox

Method Summary

Methods
Modifier and Type	Method and Description
`Set<TransportConfiguration>`	`getAcceptorConfigurations()` Returns the acceptors configured for this server.
`Map<String,AddressSettings>`	`getAddressesSettings()`
`String`	`getBindingsDirectory()` Returns the file system directory used to store bindings.
`List<BridgeConfiguration>`	`getBridgeConfigurations()` Returns the bridges configured for this server.
`List<BroadcastGroupConfiguration>`	`getBroadcastGroupConfigurations()` Returns the broadcast groups configured for this server.
`List<ClusterConnectionConfiguration>`	`getClusterConfigurations()` Returns the cluster connections configured for this server.
`String`	`getClusterPassword()` Returns the cluster password for this server.
`String`	`getClusterUser()` Returns the cluster user for this server.
`long`	`getConnectionTTLOverride()` Returns the connection time to live.
`Map<String,TransportConfiguration>`	`getConnectorConfigurations()` Returns the connectors configured for this server.
`List<ConnectorServiceConfiguration>`	`getConnectorServiceConfigurations()`
`Map<String,DiscoveryGroupConfiguration>`	`getDiscoveryGroupConfigurations()` Returns the discovery groups configured for this server.
`List<DivertConfiguration>`	`getDivertConfigurations()` Returns the diverts configured for this server.
`long`	`getFailbackDelay()`
`long`	`getFileDeployerScanPeriod()` Returns the period (in milliseconds) to scan configuration files used by deployment.
`GroupingHandlerConfiguration`	`getGroupingHandlerConfiguration()` Returns the grouping handler configured for this server.
`int`	`getIDCacheSize()` Returns the size of the cache for pre-creating message IDs.
`List<String>`	`getInterceptorClassNames()` Returns the list of interceptors classes used by this server.
`String`	`getJMXDomain()` Returns the domain used by JMX MBeans (provided JMX management is enabled).
`int`	`getJournalBufferSize_AIO()` Returns the buffer size (in bytes) for AIO.
`int`	`getJournalBufferSize_NIO()` Returns the buffer size (in bytes) for NIO.
`int`	`getJournalBufferTimeout_AIO()` Returns the timeout (in nanoseconds) used to flush buffers in the AIO queue.
`int`	`getJournalBufferTimeout_NIO()` Returns the timeout (in nanoseconds) used to flush buffers in the NIO.
`int`	`getJournalCompactMinFiles()` Returns the minimal number of journal files before compacting.
`int`	`getJournalCompactPercentage()` Returns the percentage of live data before compacting the journal.
`String`	`getJournalDirectory()` Returns the file system directory used to store journal log.
`int`	`getJournalFileSize()` Returns the size (in bytes) of each journal files.
`int`	`getJournalMaxIO_AIO()` Returns the maximum number of write requests that can be in the AIO queue at any given time.
`int`	`getJournalMaxIO_NIO()` Returns the maximum number of write requests for NIO journal.
`int`	`getJournalMinFiles()` Returns the number of journal files to pre-create.
`int`	`getJournalPerfBlastPages()`
`JournalType`	`getJournalType()` Returns the type of journal used by this server (either `NIO` or `ASYNCIO`).
`String`	`getLargeMessagesDirectory()` Returns the file system directory used to store large messages.
`String`	`getLiveConnectorName()` Returns the name of the connector used to connect to the live node - only used when using shared nothing (shared store = false).
`String`	`getLogDelegateFactoryClassName()` Returns the name of the `LogDelegateFactory` implementation used by this server for logging.
`SimpleString`	`getManagementAddress()` Returns the management address of this server.
`SimpleString`	`getManagementNotificationAddress()` Returns the management notification address of this server.
`long`	`getMemoryMeasureInterval()`
`int`	`getMemoryWarningThreshold()`
`int`	`getMessageCounterMaxDayHistory()` Returns the maximum number of days kept in memory for message counter.
`long`	`getMessageCounterSamplePeriod()` Returns the sample period (in milliseconds) to take message counter snapshot.
`long`	`getMessageExpiryScanPeriod()` Returns the frequency (in milliseconds) to scan messages to detect which messages have expired.
`int`	`getMessageExpiryThreadPriority()` Returns the priority of the thread used to scan message expiration.
`String`	`getName()` To be used on dependency management on the application server
`int`	`getPageMaxConcurrentIO()` The max number of concurrent reads allowed on paging.
`String`	`getPagingDirectory()` Returns the file system directory used to store paging files.
`List<CoreQueueConfiguration>`	`getQueueConfigurations()` Returns the queues configured for this server.
`int`	`getScheduledThreadPoolMaxSize()` Returns the maximum number of threads in the scheduled thread pool of this server.
`long`	`getSecurityInvalidationInterval()` Returns the interval time (in milliseconds) to invalidate security credentials.
`Map<String,Set<Role>>`	`getSecurityRoles()`
`long`	`getServerDumpInterval()`
`int`	`getThreadPoolMaxSize()` Returns the maximum number of threads in the thread pool of this server.
`long`	`getTransactionTimeout()` Returns the timeout (in milliseconds) after which transactions is removed from the resource manager after it was created.
`long`	`getTransactionTimeoutScanPeriod()` Returns the frequency (in milliseconds) to scan transactions to detect which transactions have timed out.
`boolean`	`isAllowAutoFailBack()` returns whether a backup will auto die when a live server is failing back
`boolean`	`isAsyncConnectionExecutionEnabled()` Returns whether code coming from connection is executed asynchronously or not.
`boolean`	`isBackup()` Returns `true` if this server is a backup, `false` if it is a live server.
`boolean`	`isClustered()` Returns whether this server is clustered.
`boolean`	`isCreateBindingsDir()` Returns whether the bindings directory is created on this server startup.
`boolean`	`isCreateJournalDir()` Returns whether the journal directory is created on this server startup.
`boolean`	`isFailoverOnServerShutdown()` should we notify any clients on close that they should failover
`boolean`	`isFileDeploymentEnabled()` Returns whether this server will use files to configure and deploy its resources.
`boolean`	`isJMXManagementEnabled()` Returns whether this server is manageable using JMX or not.
`boolean`	`isJournalSyncNonTransactional()` Returns whether the journal is synchronized when receiving non-transactional data.
`boolean`	`isJournalSyncTransactional()` Returns whether the journal is synchronized when receiving transactional data.
`boolean`	`isLogJournalWriteRate()`
`boolean`	`isMessageCounterEnabled()` Returns whether message counter is enabled for this server.
`boolean`	`isPersistDeliveryCountBeforeDelivery()` Returns whether delivery count is persisted before messages are delivered to the consumers.
`boolean`	`isPersistenceEnabled()` Returns whether this server is using persistence and store data.
`boolean`	`isPersistIDCache()` Returns whether message ID cache is persisted.
`boolean`	`isRunSyncSpeedTest()`
`boolean`	`isSecurityEnabled()` Returns whether security is enabled for this server.
`boolean`	`isSharedStore()` Returns whether this server shares its data store with a corresponding live or backup server.
`boolean`	`isWildcardRoutingEnabled()` Returns whether wildcard routing is supported by this server.
`void`	`setAcceptorConfigurations(Set<TransportConfiguration> infos)` Sets the acceptors configured for this server.
`void`	`setAddressesSettings(Map<String,AddressSettings> addressesSettings)`
`void`	`setAllowAutoFailBack(boolean allowAutoFailBack)` whether a backup will auto die when a live server is failing back
`void`	`setBackup(boolean backup)` Sets whether this server is a backup or not.
`void`	`setBindingsDirectory(String dir)` Sets the file system directory used to store bindings.
`void`	`setBridgeConfigurations(List<BridgeConfiguration> configs)` Sets the bridges configured for this server.
`void`	`setBroadcastGroupConfigurations(List<BroadcastGroupConfiguration> configs)` Sets the broadcast groups configured for this server.
`void`	`setClusterConfigurations(List<ClusterConnectionConfiguration> configs)` Sets the cluster connections configured for this server.
`void`	`setClustered(boolean clustered)` Sets whether this server is clustered or not.
`void`	`setClusterPassword(String password)` Sets the cluster password for this server.
`void`	`setClusterUser(String user)` Sets the cluster user for this server.
`void`	`setConnectionTTLOverride(long ttl)` Sets the connection time to live.
`void`	`setConnectorConfigurations(Map<String,TransportConfiguration> infos)` Sets the connectors configured for this server.
`void`	`setConnectorServiceConfigurations(List<ConnectorServiceConfiguration> configs)`
`void`	`setCreateBindingsDir(boolean create)` Sets whether the bindings directory is created on this server startup.
`void`	`setCreateJournalDir(boolean create)` Sets whether the journal directory is created on this server startup.
`void`	`setDiscoveryGroupConfigurations(Map<String,DiscoveryGroupConfiguration> configs)` Sets the discovery groups configured for this server.
`void`	`setDivertConfigurations(List<DivertConfiguration> configs)` Sets the diverts configured for this server.
`void`	`setEnabledAsyncConnectionExecution(boolean enabled)` Sets whether code coming from connection is executed asynchronously or not.
`void`	`setFailbackDelay(long delay)`
`void`	`setFailoverOnServerShutdown(boolean failoverOnServerShutdown)`
`void`	`setFileDeployerScanPeriod(long period)` Sets the period to scan configuration files used by deployment.
`void`	`setFileDeploymentEnabled(boolean enable)` Sets whether this server will use files to configure and deploy its resources.
`void`	`setGroupingHandlerConfiguration(GroupingHandlerConfiguration groupingHandlerConfiguration)` Sets the grouping handler configured for this server.
`void`	`setIDCacheSize(int idCacheSize)` Sets the size of the cache for pre-creating message IDs.
`void`	`setInterceptorClassNames(List<String> interceptors)` Sets the list of interceptors classes used by this server.
`void`	`setJMXDomain(String domain)` Sets the domain used by JMX MBeans (provided JMX management is enabled).
`void`	`setJMXManagementEnabled(boolean enabled)` Sets whether this server is manageable using JMX or not.
`void`	`setJournalBufferSize_AIO(int journalBufferSize)` Sets the buffer size (in bytes) for AIO.
`void`	`setJournalBufferSize_NIO(int journalBufferSize)` Sets the buffer size (in bytes) for NIO.
`void`	`setJournalBufferTimeout_AIO(int journalBufferTimeout)` Sets the timeout (in nanoseconds) used to flush buffers in the AIO queue.
`void`	`setJournalBufferTimeout_NIO(int journalBufferTimeout)` Sets the timeout (in nanoseconds) used to flush buffers in the NIO.
`void`	`setJournalCompactMinFiles(int minFiles)` Sets the minimal number of journal files before compacting.
`void`	`setJournalCompactPercentage(int percentage)` Sets the percentage of live data before compacting the journal.
`void`	`setJournalDirectory(String dir)` Sets the file system directory used to store journal log.
`void`	`setJournalFileSize(int size)` Sets the size (in bytes) of each journal files.
`void`	`setJournalMaxIO_AIO(int journalMaxIO)` Sets the maximum number of write requests that can be in the AIO queue at any given time.
`void`	`setJournalMaxIO_NIO(int journalMaxIO)` Sets the maximum number of write requests for NIO journal.
`void`	`setJournalMinFiles(int files)` Sets the number of journal files to pre-create.
`void`	`setJournalPerfBlastPages(int pages)`
`void`	`setJournalSyncNonTransactional(boolean sync)` Sets whether the journal is synchronized when receiving non-transactional data.
`void`	`setJournalSyncTransactional(boolean sync)` Sets whether the journal is synchronized when receiving transactional data.
`void`	`setJournalType(JournalType type)` Sets the type of journal used by this server (either `NIO` or `ASYNCIO`).
`void`	`setLargeMessagesDirectory(String directory)` Sets the file system directory used to store large messages.
`void`	`setLiveConnectorName(String name)` Sets the name of the connector used to connect to the live node - only used when using shared nothing (shared store = false).
`void`	`setLogDelegateFactoryClassName(String className)` Sets the name of the `LogDelegateFactory` implementation used by this server for logging.
`void`	`setLogJournalWriteRate(boolean rate)`
`void`	`setManagementAddress(SimpleString address)` Sets the management address of this server.
`void`	`setManagementNotificationAddress(SimpleString address)` Sets the management notification address of this server.
`void`	`setMemoryMeasureInterval(long memoryMeasureInterval)`
`void`	`setMemoryWarningThreshold(int memoryWarningThreshold)`
`void`	`setMessageCounterEnabled(boolean enabled)` Sets whether message counter is enabled for this server.
`void`	`setMessageCounterMaxDayHistory(int maxDayHistory)` Sets the maximum number of days kept in memory for message counter.
`void`	`setMessageCounterSamplePeriod(long period)` Sets the sample period to take message counter snapshot.
`void`	`setMessageExpiryScanPeriod(long messageExpiryScanPeriod)` Sets the frequency (in milliseconds) to scan messages to detect which messages have expired.
`void`	`setMessageExpiryThreadPriority(int messageExpiryThreadPriority)` Sets the priority of the thread used to scan message expiration.
`void`	`setName(String name)` To be used on dependency management on the application server
`void`	`setPageMaxConcurrentIO(int maxIO)` The max number of concurrent reads allowed on paging.
`void`	`setPagingDirectory(String dir)` Sets the file system directory used to store paging files.
`void`	`setPersistDeliveryCountBeforeDelivery(boolean persistDeliveryCountBeforeDelivery)` Sets whether delivery count is persisted before messages are delivered to consumers.
`void`	`setPersistenceEnabled(boolean enable)` Sets whether this server is using persistence and store data.
`void`	`setPersistIDCache(boolean persist)` Sets whether message ID cache is persisted.
`void`	`setQueueConfigurations(List<CoreQueueConfiguration> configs)` Sets the queues configured for this server.
`void`	`setRunSyncSpeedTest(boolean run)`
`void`	`setScheduledThreadPoolMaxSize(int maxSize)` Sets the maximum number of threads in the scheduled thread pool of this server.
`void`	`setSecurityEnabled(boolean enabled)` Sets whether security is enabled for this server.
`void`	`setSecurityInvalidationInterval(long interval)` Sets the interval time (in milliseconds) to invalidate security credentials.
`void`	`setSecurityRoles(Map<String,Set<Role>> roles)`
`void`	`setServerDumpInterval(long interval)`
`void`	`setSharedStore(boolean sharedStore)` Sets whether this server shares its data store with a backup or live server.
`void`	`setThreadPoolMaxSize(int maxSize)` Sets the maximum number of threads in the thread pool of this server.
`void`	`setTransactionTimeout(long timeout)` Sets the timeout (in milliseconds) after which transactions is removed from the resource manager after it was created.
`void`	`setTransactionTimeoutScanPeriod(long period)` Sets the frequency (in milliseconds) to scan transactions to detect which transactions have timed out.
`void`	`setWildcardRoutingEnabled(boolean enabled)` Sets whether wildcard routing is supported by this server.

- Method Detail
  - getName
```
String getName()
```
    To be used on dependency management on the application server
  - setName
```
void setName(String name)
```
    To be used on dependency management on the application server
  - isClustered
```
boolean isClustered()
```
    Returns whether this server is clustered.
    Default value is false.
  - setClustered
```
void setClustered(boolean clustered)
```
    Sets whether this server is clustered or not.
  - isAllowAutoFailBack
```
boolean isAllowAutoFailBack()
```
    returns whether a backup will auto die when a live server is failing back
    
    Returns:
  - setAllowAutoFailBack
```
void setAllowAutoFailBack(boolean allowAutoFailBack)
```
    whether a backup will auto die when a live server is failing back
    
    Parameters:
    allowAutoFailBack - true if allowed
  - isPersistDeliveryCountBeforeDelivery
```
boolean isPersistDeliveryCountBeforeDelivery()
```
    Returns whether delivery count is persisted before messages are delivered to the consumers.
    Default value is false.
  - setPersistDeliveryCountBeforeDelivery
```
void setPersistDeliveryCountBeforeDelivery(boolean persistDeliveryCountBeforeDelivery)
```
    Sets whether delivery count is persisted before messages are delivered to consumers.
  - isBackup
```
boolean isBackup()
```
    Returns true if this server is a backup, false if it is a live server.
    If a backup server has been activated, returns false.
    Default value is false.
  - setBackup
```
void setBackup(boolean backup)
```
    Sets whether this server is a backup or not.
  - isSharedStore
```
boolean isSharedStore()
```
    Returns whether this server shares its data store with a corresponding live or backup server.
    Default value is true.
  - setSharedStore
```
void setSharedStore(boolean sharedStore)
```
    Sets whether this server shares its data store with a backup or live server.
  - isFileDeploymentEnabled
```
boolean isFileDeploymentEnabled()
```
    Returns whether this server will use files to configure and deploy its resources.
    Default value is false.
  - setFileDeploymentEnabled
```
void setFileDeploymentEnabled(boolean enable)
```
    Sets whether this server will use files to configure and deploy its resources.
  - isPersistenceEnabled
```
boolean isPersistenceEnabled()
```
    Returns whether this server is using persistence and store data.
    Default value is true.
  - setPersistenceEnabled
```
void setPersistenceEnabled(boolean enable)
```
    Sets whether this server is using persistence and store data.
  - getFileDeployerScanPeriod
```
long getFileDeployerScanPeriod()
```
    Returns the period (in milliseconds) to scan configuration files used by deployment.
    Default value is 5000L.
  - setFileDeployerScanPeriod
```
void 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 is 30.
  - setThreadPoolMaxSize
```
void 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 is 5.
  - setScheduledThreadPoolMaxSize
```
void 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 is 10000L.
  - setSecurityInvalidationInterval
```
void setSecurityInvalidationInterval(long interval)
```
    Sets the interval time (in milliseconds) to invalidate security credentials.
  - isSecurityEnabled
```
boolean isSecurityEnabled()
```
    Returns whether security is enabled for this server.
    Default value is true.
  - setSecurityEnabled
```
void setSecurityEnabled(boolean enabled)
```
    Sets whether security is enabled for this server.
  - isJMXManagementEnabled
```
boolean isJMXManagementEnabled()
```
    Returns whether this server is manageable using JMX or not.
    Default value is true.
  - setJMXManagementEnabled
```
void setJMXManagementEnabled(boolean enabled)
```
    Sets whether this server is manageable using JMX or not.
  - getJMXDomain
```
String getJMXDomain()
```
    Returns the domain used by JMX MBeans (provided JMX management is enabled).
    Default value is "org.hornetq".
  - setJMXDomain
```
void setJMXDomain(String domain)
```
    Sets the domain used by JMX MBeans (provided JMX management is enabled). Changing this JMX domain is required if multiple HornetQ servers are run inside the same JVM and all servers are using the same MBeanServer.
  - getInterceptorClassNames
```
List<String> getInterceptorClassNames()
```
    Returns the list of interceptors classes used by this server.
  - setInterceptorClassNames
```
void setInterceptorClassNames(List<String> interceptors)
```
    Sets the list of interceptors classes used by this 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 value is -1L.
  - setConnectionTTLOverride
```
void setConnectionTTLOverride(long ttl)
```
    Sets the connection time to live.
  - isAsyncConnectionExecutionEnabled
```
boolean isAsyncConnectionExecutionEnabled()
```
    Returns whether code coming from connection is executed asynchronously or not.
    Default value is true.
  - setEnabledAsyncConnectionExecution
```
void setEnabledAsyncConnectionExecution(boolean enabled)
```
    Sets whether code coming from connection is executed asynchronously or not.
  - getAcceptorConfigurations
```
Set<TransportConfiguration> getAcceptorConfigurations()
```
    Returns the acceptors configured for this server.
  - setAcceptorConfigurations
```
void setAcceptorConfigurations(Set<TransportConfiguration> infos)
```
    Sets the acceptors configured for this server.
  - getConnectorConfigurations
```
Map<String,TransportConfiguration> getConnectorConfigurations()
```
    Returns the connectors configured for this server.
  - setConnectorConfigurations
```
void setConnectorConfigurations(Map<String,TransportConfiguration> infos)
```
    Sets the connectors configured for this server.
  - getLiveConnectorName
```
String getLiveConnectorName()
```
    Returns the name of the connector used to connect to the live node - only used when using shared nothing (shared store = false).
  - setLiveConnectorName
```
void setLiveConnectorName(String name)
```
    Sets the name of the connector used to connect to the live node - only used when using shared nothing (shared store = false).
  - getBroadcastGroupConfigurations
```
List<BroadcastGroupConfiguration> getBroadcastGroupConfigurations()
```
    Returns the broadcast groups configured for this server.
  - setBroadcastGroupConfigurations
```
void setBroadcastGroupConfigurations(List<BroadcastGroupConfiguration> configs)
```
    Sets the broadcast groups configured for this server.
  - getDiscoveryGroupConfigurations
```
Map<String,DiscoveryGroupConfiguration> getDiscoveryGroupConfigurations()
```
    Returns the discovery groups configured for this server.
  - setDiscoveryGroupConfigurations
```
void setDiscoveryGroupConfigurations(Map<String,DiscoveryGroupConfiguration> configs)
```
    Sets the discovery groups configured for this server.
  - getGroupingHandlerConfiguration
```
GroupingHandlerConfiguration getGroupingHandlerConfiguration()
```
    Returns the grouping handler configured for this server.
  - setGroupingHandlerConfiguration
```
void setGroupingHandlerConfiguration(GroupingHandlerConfiguration groupingHandlerConfiguration)
```
    Sets the grouping handler configured for this server.
  - getBridgeConfigurations
```
List<BridgeConfiguration> getBridgeConfigurations()
```
    Returns the bridges configured for this server.
  - setBridgeConfigurations
```
void setBridgeConfigurations(List<BridgeConfiguration> configs)
```
    Sets the bridges configured for this server.
  - getDivertConfigurations
```
List<DivertConfiguration> getDivertConfigurations()
```
    Returns the diverts configured for this server.
  - setDivertConfigurations
```
void setDivertConfigurations(List<DivertConfiguration> configs)
```
    Sets the diverts configured for this server.
  - getClusterConfigurations
```
List<ClusterConnectionConfiguration> getClusterConfigurations()
```
    Returns the cluster connections configured for this server.
  - setClusterConfigurations
```
void setClusterConfigurations(List<ClusterConnectionConfiguration> configs)
```
    Sets the cluster connections configured for this server.
  - getQueueConfigurations
```
List<CoreQueueConfiguration> getQueueConfigurations()
```
    Returns the queues configured for this server.
  - setQueueConfigurations
```
void setQueueConfigurations(List<CoreQueueConfiguration> configs)
```
    Sets the queues configured for this server.
  - getManagementAddress
```
SimpleString getManagementAddress()
```
    Returns the management address of this server.
    Clients can send management messages to this address to manage this server.
    Default value is "hornetq.management".
  - setManagementAddress
```
void 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 is "hornetq.notifications".
  - setManagementNotificationAddress
```
void setManagementNotificationAddress(SimpleString address)
```
    Sets the management notification address of this server.
  - getClusterUser
```
String getClusterUser()
```
    Returns the cluster user for this server.
    Default value is "HORNETQ.CLUSTER.ADMIN.USER".
  - setClusterUser
```
void setClusterUser(String user)
```
    Sets the cluster user for this server.
  - getClusterPassword
```
String getClusterPassword()
```
    Returns the cluster password for this server.
    Default value is "CHANGE ME!!".
  - isFailoverOnServerShutdown
```
boolean isFailoverOnServerShutdown()
```
    should we notify any clients on close that they should failover
    
    Returns:
    true if clients should failover
  - setFailoverOnServerShutdown
```
void setFailoverOnServerShutdown(boolean failoverOnServerShutdown)
```
  - setClusterPassword
```
void 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 is 2000.
  - setIDCacheSize
```
void 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 is true.
  - setPersistIDCache
```
void setPersistIDCache(boolean persist)
```
    Sets whether message ID cache is persisted.
  - getLogDelegateFactoryClassName
```
String getLogDelegateFactoryClassName()
```
    Returns the name of the LogDelegateFactory implementation used by this server for logging.
    Default value is "org.hornetq.core.logging.impl.JULLogDelegateFactory"
  - setLogDelegateFactoryClassName
```
void setLogDelegateFactoryClassName(String className)
```
    Sets the name of the LogDelegateFactory implementation used by this server for logging.
  - getBindingsDirectory
```
String getBindingsDirectory()
```
    Returns the file system directory used to store bindings.
    Default value is "data/bindings".
  - setBindingsDirectory
```
void 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 = 5
  - setPageMaxConcurrentIO
```
void setPageMaxConcurrentIO(int maxIO)
```
    The max number of concurrent reads allowed on paging. Default = 5
  - getJournalDirectory
```
String getJournalDirectory()
```
    Returns the file system directory used to store journal log.
    Default value is "data/journal".
  - setJournalDirectory
```
void setJournalDirectory(String dir)
```
    Sets the file system directory used to store journal log.
  - getJournalType
```
JournalType getJournalType()
```
    Returns the type of journal used by this server (either NIO or ASYNCIO).
    Default value is ASYNCIO.
  - setJournalType
```
void setJournalType(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 value is true.
  - setJournalSyncTransactional
```
void 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 is true.
  - setJournalSyncNonTransactional
```
void 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 is 10485760.
  - setJournalFileSize
```
void 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 is 10.
  - setJournalCompactMinFiles
```
void setJournalCompactMinFiles(int minFiles)
```
    Sets the minimal number of journal files before compacting.
  - getJournalCompactPercentage
```
int getJournalCompactPercentage()
```
    Returns the percentage of live data before compacting the journal.
    Default value is 30.
  - setJournalCompactPercentage
```
void 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 is 2.
  - setJournalMinFiles
```
void 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 is 500.
  - setJournalMaxIO_AIO
```
void 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 is 500000.
  - setJournalBufferTimeout_AIO
```
void setJournalBufferTimeout_AIO(int journalBufferTimeout)
```
    Sets the timeout (in nanoseconds) used to flush buffers in the AIO queue.
  - getJournalBufferSize_AIO
```
int getJournalBufferSize_AIO()
```
    Returns the buffer size (in bytes) for AIO.
    Default value is 501760.
  - setJournalBufferSize_AIO
```
void 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 is 1.
  - setJournalMaxIO_NIO
```
void 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 is 3333333.
  - setJournalBufferTimeout_NIO
```
void 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 is 501760.
  - setJournalBufferSize_NIO
```
void setJournalBufferSize_NIO(int journalBufferSize)
```
    Sets the buffer size (in bytes) for NIO.
  - isCreateBindingsDir
```
boolean isCreateBindingsDir()
```
    Returns whether the bindings directory is created on this server startup.
    Default value is true.
  - setCreateBindingsDir
```
void 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 is true.
  - setCreateJournalDir
```
void setCreateJournalDir(boolean create)
```
    Sets whether the journal directory is created on this server startup.
  - isLogJournalWriteRate
```
boolean isLogJournalWriteRate()
```
  - setLogJournalWriteRate
```
void setLogJournalWriteRate(boolean rate)
```
  - getJournalPerfBlastPages
```
int getJournalPerfBlastPages()
```
  - setJournalPerfBlastPages
```
void setJournalPerfBlastPages(int pages)
```
  - getServerDumpInterval
```
long getServerDumpInterval()
```
  - setServerDumpInterval
```
void setServerDumpInterval(long interval)
```
  - getMemoryWarningThreshold
```
int getMemoryWarningThreshold()
```
  - setMemoryWarningThreshold
```
void setMemoryWarningThreshold(int memoryWarningThreshold)
```
  - getMemoryMeasureInterval
```
long getMemoryMeasureInterval()
```
  - setMemoryMeasureInterval
```
void setMemoryMeasureInterval(long memoryMeasureInterval)
```
  - isRunSyncSpeedTest
```
boolean isRunSyncSpeedTest()
```
  - setRunSyncSpeedTest
```
void setRunSyncSpeedTest(boolean run)
```
  - getPagingDirectory
```
String getPagingDirectory()
```
    Returns the file system directory used to store paging files.
    Default value is "data/paging".
  - setPagingDirectory
```
void setPagingDirectory(String dir)
```
    Sets the file system directory used to store paging files.
  - getLargeMessagesDirectory
```
String getLargeMessagesDirectory()
```
    Returns the file system directory used to store large messages.
    Default value is "data/largemessages".
  - setLargeMessagesDirectory
```
void 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 is true.
  - setWildcardRoutingEnabled
```
void setWildcardRoutingEnabled(boolean enabled)
```
    Sets whether wildcard routing is supported by this server.
  - getTransactionTimeout
```
long getTransactionTimeout()
```
    Returns the timeout (in milliseconds) after which transactions is removed from the resource manager after it was created.
    Default value is 300000L.
  - setTransactionTimeout
```
void 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 is false.
  - setMessageCounterEnabled
```
void 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 is 10000L.
  - setMessageCounterSamplePeriod
```
void 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 is 10.
  - setMessageCounterMaxDayHistory
```
void 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 is 1000L.
  - setTransactionTimeoutScanPeriod
```
void 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 is 30000L.
  - setMessageExpiryScanPeriod
```
void setMessageExpiryScanPeriod(long messageExpiryScanPeriod)
```
    Sets the frequency (in milliseconds) to scan messages to detect which messages have expired.
  - getMessageExpiryThreadPriority
```
int getMessageExpiryThreadPriority()
```
    Returns the priority of the thread used to scan message expiration.
    Default value is 3.
  - setMessageExpiryThreadPriority
```
void setMessageExpiryThreadPriority(int messageExpiryThreadPriority)
```
    Sets the priority of the thread used to scan message expiration.
  - getAddressesSettings
```
Map<String,AddressSettings> getAddressesSettings()
```
    Returns:
    A list of AddressSettings per matching to be deployed to the address settings repository
  - setAddressesSettings
```
void setAddressesSettings(Map<String,AddressSettings> addressesSettings)
```
    Parameters:
    A - list of AddressSettings per matching to be deployed to the address settings repository
  - setSecurityRoles
```
void setSecurityRoles(Map<String,Set<Role>> roles)
```
    Parameters:
    roles - a list of roles per matching
  - getSecurityRoles
```
Map<String,Set<Role>> getSecurityRoles()
```
    Returns:
    a list of roles per matching
  - setConnectorServiceConfigurations
```
void setConnectorServiceConfigurations(List<ConnectorServiceConfiguration> configs)
```
    Parameters:
    -
  - getConnectorServiceConfigurations
```
List<ConnectorServiceConfiguration> getConnectorServiceConfigurations()
```
    Returns:
  - getFailbackDelay
```
long getFailbackDelay()
```
  - setFailbackDelay
```
void setFailbackDelay(long delay)
```

Interface Configuration

Method Summary

Method Detail

getName

setName

isClustered

setClustered

isAllowAutoFailBack

setAllowAutoFailBack

isPersistDeliveryCountBeforeDelivery

setPersistDeliveryCountBeforeDelivery

isBackup

setBackup

isSharedStore

setSharedStore

isFileDeploymentEnabled

setFileDeploymentEnabled

isPersistenceEnabled

setPersistenceEnabled

getFileDeployerScanPeriod

setFileDeployerScanPeriod

getThreadPoolMaxSize

setThreadPoolMaxSize

getScheduledThreadPoolMaxSize

setScheduledThreadPoolMaxSize

getSecurityInvalidationInterval

setSecurityInvalidationInterval

isSecurityEnabled

setSecurityEnabled

isJMXManagementEnabled

setJMXManagementEnabled

getJMXDomain

setJMXDomain

getInterceptorClassNames

setInterceptorClassNames

getConnectionTTLOverride

setConnectionTTLOverride

isAsyncConnectionExecutionEnabled

setEnabledAsyncConnectionExecution

getAcceptorConfigurations

setAcceptorConfigurations

getConnectorConfigurations

setConnectorConfigurations

getLiveConnectorName

setLiveConnectorName

getBroadcastGroupConfigurations

setBroadcastGroupConfigurations

getDiscoveryGroupConfigurations

setDiscoveryGroupConfigurations

getGroupingHandlerConfiguration

setGroupingHandlerConfiguration

getBridgeConfigurations

setBridgeConfigurations

getDivertConfigurations

setDivertConfigurations

getClusterConfigurations

setClusterConfigurations

getQueueConfigurations

setQueueConfigurations

getManagementAddress

setManagementAddress

getManagementNotificationAddress

setManagementNotificationAddress

getClusterUser

setClusterUser

getClusterPassword

isFailoverOnServerShutdown

setFailoverOnServerShutdown

setClusterPassword

getIDCacheSize

setIDCacheSize

isPersistIDCache

setPersistIDCache

getLogDelegateFactoryClassName

setLogDelegateFactoryClassName

getBindingsDirectory

setBindingsDirectory

getPageMaxConcurrentIO

setPageMaxConcurrentIO

getJournalDirectory