fixing javadoc options on the server project

This commit is contained in:
Clebert Suconic 2015-06-09 17:04:10 -04:00
parent 419a3cc213
commit f31fb2c8f9
37 changed files with 121 additions and 133 deletions

View File

@ -54,7 +54,7 @@ public interface Configuration
/**
* Returns whether delivery count is persisted before messages are delivered to the consumers. <br>
* Default value is
* {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_PERSIST_DELIVERY_COUNT_BEFORE_DELIVERY}.
* {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_PERSIST_DELIVERY_COUNT_BEFORE_DELIVERY}
*/
boolean isPersistDeliveryCountBeforeDelivery();
@ -65,7 +65,7 @@ public interface Configuration
/**
* Returns whether this server is using persistence and store data. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_PERSISTENCE_ENABLED}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_PERSISTENCE_ENABLED}.
*/
boolean isPersistenceEnabled();
@ -91,7 +91,7 @@ public interface Configuration
/**
* Returns the period (in milliseconds) to scan configuration files used by deployment. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_FILE_DEPLOYER_SCAN_PERIOD}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_FILE_DEPLOYER_SCAN_PERIOD}.
*/
long getFileDeployerScanPeriod();
@ -102,7 +102,7 @@ public interface Configuration
/**
* Returns the maximum number of threads in the thread pool of this server. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_THREAD_POOL_MAX_SIZE}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_THREAD_POOL_MAX_SIZE}.
*/
int getThreadPoolMaxSize();
@ -113,7 +113,7 @@ public interface Configuration
/**
* Returns the maximum number of threads in the <em>scheduled</em> thread pool of this server. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_SCHEDULED_THREAD_POOL_MAX_SIZE}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_SCHEDULED_THREAD_POOL_MAX_SIZE}.
*/
int getScheduledThreadPoolMaxSize();
@ -124,7 +124,7 @@ public interface Configuration
/**
* Returns the interval time (in milliseconds) to invalidate security credentials. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_SECURITY_INVALIDATION_INTERVAL}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_SECURITY_INVALIDATION_INTERVAL}.
*/
long getSecurityInvalidationInterval();
@ -135,7 +135,7 @@ public interface Configuration
/**
* Returns whether security is enabled for this server. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_SECURITY_ENABLED}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_SECURITY_ENABLED}.
*/
boolean isSecurityEnabled();
@ -146,7 +146,7 @@ public interface Configuration
/**
* Returns whether graceful shutdown is enabled for this server. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_SECURITY_ENABLED}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_SECURITY_ENABLED}.
*/
boolean isGracefulShutdownEnabled();
@ -157,7 +157,7 @@ public interface Configuration
/**
* Returns the graceful shutdown timeout for this server. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT}.
*/
long getGracefulShutdownTimeout();
@ -168,25 +168,25 @@ public interface Configuration
/**
* Returns whether this server is manageable using JMX or not. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JMX_MANAGEMENT_ENABLED}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JMX_MANAGEMENT_ENABLED}.
*/
boolean isJMXManagementEnabled();
/**
* Sets whether this server is manageable using JMX or not. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JMX_MANAGEMENT_ENABLED}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JMX_MANAGEMENT_ENABLED}.
*/
Configuration setJMXManagementEnabled(boolean enabled);
/**
* Returns the domain used by JMX MBeans (provided JMX management is enabled). <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JMX_DOMAIN}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JMX_DOMAIN}.
*/
String getJMXDomain();
/**
* Sets the domain used by JMX MBeans (provided JMX management is enabled).
* <p/>
* <p>
* 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.
*/
@ -207,7 +207,7 @@ public interface Configuration
/**
* Sets the list of interceptors classes used by this server for incoming messages (i.e. those being delivered to
* the server from clients).
* <br />
* <br>
* Classes must implement {@link org.apache.activemq.artemis.api.core.Interceptor}.
*/
Configuration setIncomingInterceptorClassNames(List<String> interceptors);
@ -215,7 +215,7 @@ public interface Configuration
/**
* Sets the list of interceptors classes used by this server for outgoing messages (i.e. those being delivered to
* clients from the server).
* <br />
* <br>
* Classes must implement {@link org.apache.activemq.artemis.api.core.Interceptor}.
*/
Configuration setOutgoingInterceptorClassNames(List<String> interceptors);
@ -223,7 +223,7 @@ public interface Configuration
/**
* Returns the connection time to live. <br>
* This value overrides the connection time to live <em>sent by the client</em>. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_CONNECTION_TTL_OVERRIDE}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_CONNECTION_TTL_OVERRIDE}.
*/
long getConnectionTTLOverride();
@ -235,7 +235,7 @@ public interface Configuration
/**
* Returns whether code coming from connection is executed asynchronously or not. <br>
* Default value is
* {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_ASYNC_CONNECTION_EXECUTION_ENABLED}.
* {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_ASYNC_CONNECTION_EXECUTION_ENABLED}.
*/
boolean isAsyncConnectionExecutionEnabled();
@ -330,7 +330,7 @@ public interface Configuration
/**
* Returns the cluster connections configured for this server.
* <p/>
* <p>
* Modifying the returned list will modify the list of {@link ClusterConnectionConfiguration}
* used by this configuration.
*/
@ -384,7 +384,7 @@ public interface Configuration
/**
* Returns the cluster user for this server. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_CLUSTER_USER}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_CLUSTER_USER}.
*/
String getClusterUser();
@ -395,7 +395,7 @@ public interface Configuration
/**
* Returns the cluster password for this server. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_CLUSTER_PASSWORD}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_CLUSTER_PASSWORD}.
*/
String getClusterPassword();
@ -406,7 +406,7 @@ public interface Configuration
/**
* Returns the size of the cache for pre-creating message IDs. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_ID_CACHE_SIZE}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_ID_CACHE_SIZE}.
*/
int getIDCacheSize();
@ -417,7 +417,7 @@ public interface Configuration
/**
* Returns whether message ID cache is persisted. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_PERSIST_ID_CACHE}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_PERSIST_ID_CACHE}.
*/
boolean isPersistIDCache();
@ -430,7 +430,7 @@ public interface Configuration
/**
* Returns the file system directory used to store bindings. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_BINDINGS_DIRECTORY}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_BINDINGS_DIRECTORY}.
*/
String getBindingsDirectory();
@ -441,21 +441,21 @@ public interface Configuration
/**
* The max number of concurrent reads allowed on paging.
* <p/>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_MAX_CONCURRENT_PAGE_IO}.
* <p>
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_MAX_CONCURRENT_PAGE_IO}.
*/
int getPageMaxConcurrentIO();
/**
* The max number of concurrent reads allowed on paging.
* <p/>
* <p>
* Default = 5
*/
Configuration setPageMaxConcurrentIO(int maxIO);
/**
* Returns the file system directory used to store journal log. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_DIR}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_DIR}.
*/
String getJournalDirectory();
@ -478,7 +478,7 @@ public interface Configuration
/**
* Returns whether the journal is synchronized when receiving transactional data. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_SYNC_TRANSACTIONAL}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_SYNC_TRANSACTIONAL}.
*/
boolean isJournalSyncTransactional();
@ -489,7 +489,7 @@ public interface Configuration
/**
* Returns whether the journal is synchronized when receiving non-transactional data. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_SYNC_NON_TRANSACTIONAL}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_SYNC_NON_TRANSACTIONAL}.
*/
boolean isJournalSyncNonTransactional();
@ -500,7 +500,7 @@ public interface Configuration
/**
* Returns the size (in bytes) of each journal files. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_FILE_SIZE}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_FILE_SIZE}.
*/
int getJournalFileSize();
@ -511,7 +511,7 @@ public interface Configuration
/**
* Returns the minimal number of journal files before compacting. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_COMPACT_MIN_FILES}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_COMPACT_MIN_FILES}.
*/
int getJournalCompactMinFiles();
@ -522,7 +522,7 @@ public interface Configuration
/**
* Returns the percentage of live data before compacting the journal. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_COMPACT_PERCENTAGE}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_COMPACT_PERCENTAGE}.
*/
int getJournalCompactPercentage();
@ -533,7 +533,7 @@ public interface Configuration
/**
* Returns the number of journal files to pre-create. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_MIN_FILES}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_MIN_FILES}.
*/
int getJournalMinFiles();
@ -546,7 +546,7 @@ public interface Configuration
/**
* Returns the maximum number of write requests that can be in the AIO queue at any given time. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_MAX_IO_AIO}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_MAX_IO_AIO}.
*/
int getJournalMaxIO_AIO();
@ -558,7 +558,7 @@ public interface Configuration
/**
* Returns the timeout (in nanoseconds) used to flush buffers in the AIO queue.
* <br>
* Default value is {@value org.apache.activemq.artemis.core.journal.impl.JournalConstants#DEFAULT_JOURNAL_BUFFER_TIMEOUT_AIO}.
* Default value is {@link org.apache.activemq.artemis.core.journal.impl.JournalConstants#DEFAULT_JOURNAL_BUFFER_TIMEOUT_AIO}.
*/
int getJournalBufferTimeout_AIO();
@ -570,7 +570,7 @@ public interface Configuration
/**
* Returns the buffer size (in bytes) for AIO.
* <br>
* Default value is {@value org.apache.activemq.artemis.core.journal.impl.JournalConstants#DEFAULT_JOURNAL_BUFFER_SIZE_AIO}.
* Default value is {@link org.apache.activemq.artemis.core.journal.impl.JournalConstants#DEFAULT_JOURNAL_BUFFER_SIZE_AIO}.
*/
int getJournalBufferSize_AIO();
@ -581,7 +581,7 @@ public interface Configuration
/**
* Returns the maximum number of write requests for NIO journal. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_MAX_IO_NIO}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_JOURNAL_MAX_IO_NIO}.
*/
int getJournalMaxIO_NIO();
@ -593,7 +593,7 @@ public interface Configuration
/**
* Returns the timeout (in nanoseconds) used to flush buffers in the NIO.
* <br>
* Default value is {@value org.apache.activemq.artemis.core.journal.impl.JournalConstants#DEFAULT_JOURNAL_BUFFER_TIMEOUT_NIO}.
* Default value is {@link org.apache.activemq.artemis.core.journal.impl.JournalConstants#DEFAULT_JOURNAL_BUFFER_TIMEOUT_NIO}.
*/
int getJournalBufferTimeout_NIO();
@ -605,7 +605,7 @@ public interface Configuration
/**
* Returns the buffer size (in bytes) for NIO.
* <br>
* Default value is {@value org.apache.activemq.artemis.core.journal.impl.JournalConstants#DEFAULT_JOURNAL_BUFFER_SIZE_NIO}.
* Default value is {@link org.apache.activemq.artemis.core.journal.impl.JournalConstants#DEFAULT_JOURNAL_BUFFER_SIZE_NIO}.
*/
int getJournalBufferSize_NIO();
@ -616,7 +616,7 @@ public interface Configuration
/**
* Returns whether the bindings directory is created on this server startup. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_CREATE_BINDINGS_DIR}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_CREATE_BINDINGS_DIR}.
*/
boolean isCreateBindingsDir();
@ -627,7 +627,7 @@ public interface Configuration
/**
* Returns whether the journal directory is created on this server startup. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_CREATE_JOURNAL_DIR}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_CREATE_JOURNAL_DIR}.
*/
boolean isCreateJournalDir();
@ -666,7 +666,7 @@ public interface Configuration
/**
* Returns the file system directory used to store paging files. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_PAGING_DIR}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_PAGING_DIR}.
*/
String getPagingDirectory();
@ -679,7 +679,7 @@ public interface Configuration
/**
* Returns the file system directory used to store large messages. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_LARGE_MESSAGES_DIR}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_LARGE_MESSAGES_DIR}.
*/
String getLargeMessagesDirectory();
@ -692,7 +692,7 @@ public interface Configuration
/**
* Returns whether wildcard routing is supported by this server. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_WILDCARD_ROUTING_ENABLED}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_WILDCARD_ROUTING_ENABLED}.
*/
boolean isWildcardRoutingEnabled();
@ -704,7 +704,7 @@ public interface Configuration
/**
* Returns the timeout (in milliseconds) after which transactions is removed from the resource
* manager after it was created. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_TRANSACTION_TIMEOUT}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_TRANSACTION_TIMEOUT}.
*/
long getTransactionTimeout();
@ -716,7 +716,7 @@ public interface Configuration
/**
* Returns whether message counter is enabled for this server. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_MESSAGE_COUNTER_ENABLED}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_MESSAGE_COUNTER_ENABLED}.
*/
boolean isMessageCounterEnabled();
@ -727,7 +727,7 @@ public interface Configuration
/**
* Returns the sample period (in milliseconds) to take message counter snapshot. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_MESSAGE_COUNTER_SAMPLE_PERIOD}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_MESSAGE_COUNTER_SAMPLE_PERIOD}.
*/
long getMessageCounterSamplePeriod();
@ -740,7 +740,7 @@ public interface Configuration
/**
* Returns the maximum number of days kept in memory for message counter. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_MESSAGE_COUNTER_MAX_DAY_HISTORY}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_MESSAGE_COUNTER_MAX_DAY_HISTORY}.
*/
int getMessageCounterMaxDayHistory();
@ -754,7 +754,7 @@ public interface Configuration
/**
* Returns the frequency (in milliseconds) to scan transactions to detect which transactions have
* timed out. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_TRANSACTION_TIMEOUT_SCAN_PERIOD}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_TRANSACTION_TIMEOUT_SCAN_PERIOD}.
*/
long getTransactionTimeoutScanPeriod();
@ -767,7 +767,7 @@ public interface Configuration
/**
* Returns the frequency (in milliseconds) to scan messages to detect which messages have
* expired. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_MESSAGE_EXPIRY_SCAN_PERIOD}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_MESSAGE_EXPIRY_SCAN_PERIOD}.
*/
long getMessageExpiryScanPeriod();
@ -779,7 +779,7 @@ public interface Configuration
/**
* Returns the priority of the thread used to scan message expiration. <br>
* Default value is {@value org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_MESSAGE_EXPIRY_THREAD_PRIORITY}.
* Default value is {@link org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_MESSAGE_EXPIRY_THREAD_PRIORITY}.
*/
int getMessageExpiryThreadPriority();
@ -851,7 +851,7 @@ public interface Configuration
/*
* @see #setResolveProtocols()
* @return whether ActiveMQ Artemis should resolve and use any Protocols available on the classpath
* Default value is {@value org.apache.activemq.artemis.api.config.org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_RESOLVE_PROTOCOLS}.
* Default value is {@link org.apache.activemq.artemis.api.config.org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration#DEFAULT_RESOLVE_PROTOCOLS}.
* */
boolean isResolveProtocols();

View File

@ -1086,7 +1086,7 @@ public class ActiveMQServerControlImpl extends AbstractControl implements Active
html.append("<td colspan=\"3\">" + propstr.toString() + "</td></tr>");
}
html.append("</table></td></tr>");
html.append("</table><br/>");
html.append("</table><br>");
}
return html.toString();

View File

@ -557,7 +557,7 @@ public class MessageCounter
}
/**
* Return day counter data as string with format<br/>
* Return day counter data as string with format<br>
* "Date, hour counter 0, hour counter 1, ..., hour counter 23".
* @return String day counter data
*/

View File

@ -156,7 +156,7 @@ public interface PagingStore extends ActiveMQComponent
/**
* Sends the pages with given IDs to the {@link ReplicationManager}.
* <p/>
* <p>
* Sending is done here to avoid exposing the internal {@link org.apache.activemq.artemis.core.journal.SequentialFile}s.
*
* @param replicator

View File

@ -105,7 +105,6 @@ public class PageSubscriptionCounterImpl implements PageSubscriptionCounter
* This is used only on non transactional paging
* @param page
* @param increment
* @param context
* @throws Exception
*/
@Override

View File

@ -189,7 +189,7 @@ final class PageSubscriptionImpl implements PageSubscription
/**
* A page marked as complete will be ignored until it's cleared.
* <p/>
* <p>
* Usually paging is a stream of messages but in certain scenarios (such as a pending prepared
* TX) we may have big holes on the page streaming, and we will need to ignore such pages on the
* cursor/subscription.
@ -989,7 +989,7 @@ final class PageSubscriptionImpl implements PageSubscription
/**
* This will hold information about the pending ACKs towards a page.
* <p/>
* <p>
* This instance will be released as soon as the entire page is consumed, releasing the memory at
* that point The ref counts are increased also when a message is ignored for any reason.
*/

View File

@ -349,7 +349,7 @@ public interface StorageManager extends IDGenerator, ActiveMQComponent
/**
* Write message to page if we are paging.
* <p/>
* <p>
* This is primarily a {@link PagingStore} call, but as with any other call writing persistent
* data, it must go through here. Both for the sake of replication, and also to ensure that it
* takes the locks (storage manager and pagingStore) in the right order. Avoiding thus the
@ -363,7 +363,7 @@ public interface StorageManager extends IDGenerator, ActiveMQComponent
/**
* Stops the replication of data from the live to the backup.
* <p/>
* <p>
* Typical scenario is a broken connection.
*/
void stopReplication();
@ -393,7 +393,7 @@ public interface StorageManager extends IDGenerator, ActiveMQComponent
/**
* Read lock the StorageManager. USE WITH CARE!
* <p/>
* <p>
* The main lock is used to write lock the whole manager when starting replication. Sub-systems,
* say Paging classes, that use locks of their own AND also write through the StorageManager MUST
* first read lock the storageManager before taking their own locks. Otherwise, we may dead-lock
@ -410,7 +410,7 @@ public interface StorageManager extends IDGenerator, ActiveMQComponent
/**
* Closes the {@link IDGenerator} persisting the current record ID.
* <p/>
* <p>
* Effectively a "pre-stop" method. Necessary due to the "stop"-order at
* {@link org.apache.activemq.artemis.core.server.impl.ActiveMQServerImpl}
*/

View File

@ -54,7 +54,6 @@ public class PersistedRoles implements EncodingSupport
}
/**
* @param address
* @param addressMatch
* @param sendRoles
* @param consumeRoles

View File

@ -80,7 +80,7 @@ import static org.apache.activemq.artemis.core.persistence.impl.journal.JournalR
/**
* Outputs a String description of the Journals contents.
* <p/>
* <p>
* Meant to be used in debugging.
*/
public final class DescribeJournal

View File

@ -130,14 +130,14 @@ import static org.apache.activemq.artemis.core.persistence.impl.journal.JournalR
* Controls access to the journals and other storage files such as the ones used to store pages and
* large messages. This class must control writing of any non-transient data, as it is the key point
* for synchronizing a replicating backup server.
* <p/>
* <p>
* Using this class also ensures that locks are acquired in the right order, avoiding dead-locks.
* <p/>
* <p>
* Notice that, turning on and off replication (on the live server side) is _mostly_ a matter of
* using {@link ReplicatedJournal}s instead of regular {@link JournalImpl}, and sync the existing
* data. For details see the Javadoc of
* {@link #startReplication(ReplicationManager, PagingManager, String, boolean)}.
* <p/>
* <p>
*/
public class JournalStorageManager implements StorageManager
{
@ -342,17 +342,17 @@ public class JournalStorageManager implements StorageManager
/**
* Starts replication at the live-server side.
* <p/>
* In practice that means 2 things:<br/>
* (1) all currently existing data must be sent to the backup.<br/>
* <p>
* In practice that means 2 things:<br>
* (1) all currently existing data must be sent to the backup.<br>
* (2) every new persistent information is replicated (sent) to the backup.
* <p/>
* <p>
* To achieve (1), we lock the entire journal while collecting the list of files to send to the
* backup. The journal does not remain locked during actual synchronization.
* <p/>
* <p>
* To achieve (2), instead of writing directly to instances of {@link JournalImpl}, we write to
* instances of {@link ReplicatedJournal}.
* <p/>
* <p>
* At the backup-side replication is handled by {@link org.apache.activemq.artemis.core.replication.ReplicationEndpoint}.
*
* @param replicationManager
@ -606,9 +606,9 @@ public class JournalStorageManager implements StorageManager
/**
* Sets a list of large message files into the replicationManager for synchronization.
* <p/>
* <p>
* Collects a list of existing large messages and their current size, passing re.
* <p/>
* <p>
* So we know how much of a given message to sync with the backup. Further data appends to the
* messages will be replicated normally.
*
@ -3569,7 +3569,7 @@ public class JournalStorageManager implements StorageManager
/**
* This is only used when loading a transaction.
* <p/>
* <p>
* it might be possible to merge the functionality of this class with
* {@link org.apache.activemq.artemis.core.persistence.impl.journal.JournalStorageManager.FinishPageMessageOperation}
*/

View File

@ -55,8 +55,8 @@ public interface Binding extends UnproposalListener
/**
* This method will create a string representation meant for management operations.
* <p/>
* This is different from the {@link #toString()} method that is meant for debugging and will
* <p>
* This is different from the toString() method that is meant for debugging and will
* contain information that regular users won't understand well.
*
* @return

View File

@ -358,8 +358,8 @@ public final class BindingsImpl implements Bindings
/**
* This code has a race on the assigned value to routing names.
* <p/>
* This is not that much of an issue because<br/>
* <p>
* This is not that much of an issue because<br>
* Say you have the same queue name bound into two servers. The routing will load balance between
* these two servers. This will eventually send more messages to one server than the other
* (depending if you are using multi-thread), and not lose messages.

View File

@ -16,17 +16,16 @@
*/
package org.apache.activemq.artemis.core.protocol.core.impl.wireformat;
import org.apache.activemq.artemis.api.core.ActiveMQBuffer;
import org.apache.activemq.artemis.core.protocol.core.impl.PacketImpl;
import java.util.Collections;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.Map;
import org.apache.activemq.artemis.api.core.ActiveMQBuffer;
import org.apache.activemq.artemis.core.protocol.core.impl.PacketImpl;
/**
* Informs the Backup trying to start replicating of an error.
* @see org.apache.activemq.artemis.core.server.impl.ReplicationError
*/
public final class BackupReplicationStartFailedMessage extends PacketImpl
{

View File

@ -155,7 +155,6 @@ public class ReplicationStartSyncMessage extends PacketImpl
/**
* @return whether the server is configured to allow for fail-back
* @see Configuration#isAllowAutoFailBack()
*/
public boolean isServerToFailBack()
{

View File

@ -433,7 +433,6 @@ public class ReplicatedJournal implements Journal
/**
* @param pages
* @throws Exception
* @see org.apache.activemq.artemis.core.journal.Journal#perfBlast(int)
*/
public void perfBlast(final int pages)

View File

@ -20,7 +20,7 @@ import org.apache.activemq.artemis.api.core.Message;
/**
* {@link org.apache.activemq.artemis.core.server.LargeServerMessage} methods used by the {@link ReplicationEndpoint}.
* <p/>
* <p>
* In practice a subset of the methods necessary to have a {@link org.apache.activemq.artemis.core.server.LargeServerMessage}
*
* @see org.apache.activemq.artemis.core.persistence.impl.journal.LargeServerMessageInSync
@ -48,7 +48,7 @@ public interface ReplicatedLargeMessage
void deleteFile() throws Exception;
/**
* @see LargeServerMessage#addBytes(byte[])
* @see org.apache.activemq.artemis.core.server.LargeServerMessage#addBytes(byte[])
*/
void addBytes(byte[] body) throws Exception;

View File

@ -68,7 +68,7 @@ import org.apache.activemq.artemis.utils.ExecutorFactory;
/**
* Manages replication tasks on the live server (that is the live server side of a "remote backup"
* use case).
* <p/>
* <p>
* Its equivalent in the backup server is {@link ReplicationEndpoint}.
*
* @see ReplicationEndpoint
@ -309,7 +309,7 @@ public final class ReplicationManager implements ActiveMQComponent
/**
* Completes any pending operations.
* <p/>
* <p>
* This can be necessary in case the live loses connection to the backup (network failure, or
* backup crashing).
*/
@ -607,7 +607,7 @@ public final class ReplicationManager implements ActiveMQComponent
/**
* Informs backup that data synchronization is done.
* <p/>
* <p>
* So if 'live' fails, the (up-to-date) backup now may take over its duties. To do so, it must
* know which is the live's {@code nodeID}.
*
@ -624,7 +624,7 @@ public final class ReplicationManager implements ActiveMQComponent
/**
* Reserves several LargeMessage IDs in the backup.
* <p/>
* <p>
* Doing this before hand removes the need of synchronizing large-message deletes with the
* largeMessageSyncList.
*
@ -641,7 +641,7 @@ public final class ReplicationManager implements ActiveMQComponent
/**
* Notifies the backup that the live server is stopping.
* <p/>
* <p>
* This notification allows the backup to skip quorum voting (or any other measure to avoid
* 'split-brain') and do a faster fail-over.
*

View File

@ -45,10 +45,10 @@ import java.io.File;
/**
* Logger Code 11
* <p/>
* <p>
* Each message id must be 6 digits long starting with 10, the 3rd digit should be 9. So the range
* is from 119000 to 119999.
* <p/>
* <p>
* Once released, methods should not be deleted as they may be referenced by knowledge base
* articles. Unused methods should be marked as deprecated.
*/

View File

@ -16,10 +16,12 @@
*/
package org.apache.activemq.artemis.core.server;
import javax.management.MBeanServer;
import java.util.List;
import java.util.Set;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import org.apache.activemq.artemis.api.core.SimpleString;
import org.apache.activemq.artemis.core.config.BridgeConfiguration;
import org.apache.activemq.artemis.core.config.Configuration;
@ -48,8 +50,6 @@ import org.apache.activemq.artemis.spi.core.protocol.SessionCallback;
import org.apache.activemq.artemis.spi.core.security.ActiveMQSecurityManager;
import org.apache.activemq.artemis.utils.ExecutorFactory;
import javax.management.MBeanServer;
/**
* This interface defines the internal interface of the ActiveMQ Artemis Server exposed to other components
* of the server.
@ -152,9 +152,7 @@ public interface ActiveMQServer extends ActiveMQComponent
void setJMSQueueCreator(QueueCreator queueCreator);
/**
* @see {@link org.apache.activemq.artemis.core.server.ActiveMQServer#setJMSQueueCreator(QueueCreator)} *
* *
* @return
* @see org.apache.activemq.artemis.core.server.ActiveMQServer#setJMSQueueCreator(QueueCreator)
*/
QueueCreator getJMSQueueCreator();
@ -162,10 +160,11 @@ public interface ActiveMQServer extends ActiveMQComponent
* Wait for server initialization.
* @param timeout
* @param unit
* @see CountDownLatch#await(long, TimeUnit)
* @return {@code true} if the server was already initialized or if it was initialized within the
* timeout period, {@code false} otherwise.
* @throws InterruptedException
* @see java.util.concurrent.CountDownLatch#await(long, java.util.concurrent.TimeUnit)
*/
boolean waitForActivation(long timeout, TimeUnit unit) throws InterruptedException;

View File

@ -23,7 +23,7 @@ import org.apache.activemq.artemis.core.filter.Filter;
public interface Consumer
{
/**
* There was a change on semantic during 2.3 here.<br/>
* There was a change on semantic during 2.3 here.<br>
* We now first accept the message, and the actual deliver is done as part of
* {@link #proceedDeliver(MessageReference)}. This is to avoid holding a lock on the queues while
* the delivery is being accomplished To avoid a lock on the queue in case of misbehaving
@ -48,8 +48,7 @@ public interface Consumer
Filter getFilter();
/**
* Add the in-deliver mode messages to the ref-list passed as parameter
* @param refList the placeholder for where the output messages will be placed
* @return the list of messages being delivered
*/
List<MessageReference> getDeliveringMessages();

View File

@ -94,7 +94,7 @@ public abstract class NodeManager implements ActiveMQComponent
/**
* Sets the nodeID.
* <p/>
* <p>
* Only used by replicating backups.
*
* @param nodeID
@ -146,7 +146,7 @@ public abstract class NodeManager implements ActiveMQComponent
/**
* Ensures existence of persistent information about the server's nodeID.
* <p/>
* <p>
* Roughly the different use cases are:
* <ol>
* <li>old live server restarts: a server.lock file already exists and contains a nodeID.
@ -155,9 +155,6 @@ public abstract class NodeManager implements ActiveMQComponent
* <li>replicated backup received its nodeID from its live: no file exists, we need to persist
* the *current* nodeID
* </ol>
*
* @throws Exception
* @throws IOException
*/
protected final synchronized void setUpServerLockFile() throws IOException
{

View File

@ -69,7 +69,7 @@ import org.apache.activemq.artemis.utils.FutureLatch;
/**
* A ClusterManager manages {@link ClusterConnection}s, {@link BroadcastGroup}s and {@link Bridge}s.
* <p/>
* <p>
* Note that {@link org.apache.activemq.artemis.core.server.cluster.impl.ClusterConnectionBridge}s extend Bridges but are controlled over through
* {@link ClusterConnectionImpl}. As a node is discovered a new {@link org.apache.activemq.artemis.core.server.cluster.impl.ClusterConnectionBridge} is
* deployed.
@ -128,7 +128,7 @@ public final class ClusterManager implements ActiveMQComponent
/**
* Deployed means {@link ClusterManager#deploy()} was called but
* {@link ClusterManager#start()} was not called.
* <p/>
* <p>
* We need the distinction if {@link ClusterManager#stop()} is called before 'start'. As
* otherwise we would leak locators.
*/

View File

@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* <p/>
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p/>
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

View File

@ -57,7 +57,7 @@ public class SharedNothingBackupQuorum implements Quorum, FailureListener
* This is a safety net in case the live sends the first {@link ReplicationLiveIsStoppingMessage}
* with code {@link org.apache.activemq.artemis.core.protocol.core.impl.wireformat.ReplicationLiveIsStoppingMessage.LiveStopping#STOP_CALLED} and crashes before sending the second with
* {@link org.apache.activemq.artemis.core.protocol.core.impl.wireformat.ReplicationLiveIsStoppingMessage.LiveStopping#FAIL_OVER}.
* <p/>
* <p>
* If the second message does come within this dead line, we fail over anyway.
*/
public static final int WAIT_TIME_AFTER_FIRST_LIVE_STOPPING_MSG = 60;
@ -186,7 +186,7 @@ public class SharedNothingBackupQuorum implements Quorum, FailureListener
/**
* Releases the latch, causing the backup activation thread to fail-over.
* <p/>
* <p>
* The use case is for when the 'live' has an orderly shutdown, in which case it informs the
* backup that it should fail-over.
*/

View File

@ -40,7 +40,7 @@ import org.apache.activemq.artemis.utils.TypedProperties;
/**
* A remote Grouping handler.
* <p/>
* <p>
* This will use management notifications to communicate with the node that has the Local Grouping
* handler to make proposals.
*/

View File

@ -26,10 +26,10 @@ import org.apache.activemq.artemis.core.asyncio.impl.AsynchronousFileImpl;
* This is using the ActiveMQ Artemis Libaio Native to perform calls to flock on a Linux system. At the
* current version of RHEL there's a bug on GFS2 and because of that fctl is not functional what
* will cause issues on Failover over Shared Storage.
* <p/>
* <p>
* This will provide an alternative to perform locks through our native module until fctl is fixed
* on Linux.
* <p/>
* <p>
* https://bugzilla.redhat.com/show_bug.cgi?id=678585
*/
public final class AIOFileLockNodeManager extends FileLockNodeManager

View File

@ -814,7 +814,7 @@ public class ActiveMQServerImpl implements ActiveMQServer
/**
* Freeze all connections.
* <p/>
* <p>
* If replicating, avoid freezing the replication connection. Helper method for
* {@link #stop(boolean, boolean, boolean)}.
*/
@ -1314,7 +1314,7 @@ public class ActiveMQServerImpl implements ActiveMQServer
/**
* Creates a transient queue. A queue that will exist as long as there are consumers.
* The queue will be deleted as soon as all the consumers are removed.
* <p/>
* <p>
* Notice: the queue won't be deleted until the first consumer arrives.
*
* @param address
@ -1708,7 +1708,7 @@ public class ActiveMQServerImpl implements ActiveMQServer
/**
* Starts everything apart from RemotingService and loading the data.
* <p/>
* <p>
* After optional intermediary steps, Part 1 is meant to be followed by part 2
* {@link #initialisePart2(boolean)}.
* @param scalingDown
@ -2350,7 +2350,7 @@ public class ActiveMQServerImpl implements ActiveMQServer
/**
* Move data away before starting data synchronization for fail-back.
* <p/>
* <p>
* Use case is a server, upon restarting, finding a former backup running in its place. It will
* move any older data away and log a warning about it.
*/

View File

@ -113,7 +113,7 @@ public class AnyLiveNodeLocatorForReplication extends LiveNodeLocator
/**
* if a node goes down we try all the connectors again as one may now be available for
* replication
* <p/>
* <p>
* TODO: there will be a better way to do this by finding which nodes backup has gone down.
*/
@Override

View File

@ -31,7 +31,7 @@ import org.apache.activemq.artemis.utils.UUIDGenerator;
/**
* NodeManager used to run multiple servers in the same VM.
* <p/>
* <p>
* We use the {@link org.apache.activemq.artemis.core.server.impl.InVMNodeManager} instead of {@link org.apache.activemq.artemis.core.server.impl.FileLockNodeManager} when
* multiple servers are run inside the same VM and File Locks can not be shared in the
* same VM (it would cause a shared lock violation).

View File

@ -31,7 +31,7 @@ import org.apache.activemq.artemis.core.server.cluster.qourum.SharedNothingBacku
/**
* NamedLiveNodeLocatorForReplication looks for a live server in the cluster with a specific backupGroupName
*
* @see org.apache.activemq.artemis.core.server.cluster.ha.HAPolicy#getGroupName()
* @see org.apache.activemq.artemis.core.server.cluster.ha.HAPolicy#getScaleDownGroupName()
*/
public class NamedLiveNodeLocatorForReplication extends LiveNodeLocator
{

View File

@ -33,8 +33,6 @@ import org.apache.activemq.artemis.core.server.LiveNodeLocator;
/**
* NamedLiveNodeLocatorForScaleDown looks for a live server in the cluster with a specific scaleDownGroupName
*
* @see org.apache.activemq.artemis.core.config.Configuration#getScaleDownGroupName()
*/
public class NamedLiveNodeLocatorForScaleDown extends LiveNodeLocator
{

View File

@ -90,7 +90,7 @@ import org.apache.activemq.artemis.utils.TypedProperties;
/**
* Implementation of a Queue
* <p/>
* <p>
* Completely non blocking between adding to queue and delivering to consumers.
*/
public class QueueImpl implements Queue

View File

@ -412,7 +412,7 @@ public final class SharedNothingBackupActivation extends Activation
/**
* Whether a remote backup server was in sync with its live server. If it was not in sync, it may
* not take over the live's functions.
* <p/>
* <p>
* A local backup server or a live server should always return {@code true}
*
* @return whether the backup is up-to-date, if the server is not a backup it always returns

View File

@ -305,7 +305,7 @@ public class SharedNothingLiveActivation extends LiveActivation
}
/**
* Determines whether there is another server already running with this server's nodeID.
* <p/>
* <p>
* This can happen in case of a successful fail-over followed by the live's restart
* (attempting a fail-back).
*

View File

@ -76,7 +76,7 @@ public class HierarchicalObjectRepository<T> implements HierarchicalRepository<T
* <p>
* We could have a race between the state of {@link #matches} and {@link #cache}:
* <p>
* Thread1: calls {@link #addMatch(String , T)}: i. cleans cache; ii. adds match to Map.<br/>
* Thread1: calls {@link #addMatch(String , T)}: i. cleans cache; ii. adds match to Map.<br>
* Thread2: could add an (out-dated) entry to the cache between 'i. clean cache' and 'ii. add
* match to Map'.
* <p>

View File

@ -34,7 +34,7 @@ public class FileConfigurationParserTest extends ActiveMQTestBase
/**
* These "InvalidConfigurationTest*.xml" files are modified copies of {@value
* ConfigurationTest-full-config.xml}, so just diff it for changes, e.g.
* <p/>
* <p>
* <pre>
* diff ConfigurationTest-full-config.xml InvalidConfigurationTest4.xml
* </pre>

View File

@ -3006,7 +3006,7 @@ public abstract class ActiveMQTestBase extends Assert
/**
* Asserts that latch completes within a (rather large interval).
* <p/>
* <p>
* Use this instead of just calling {@code latch.await()}. Otherwise your test may hang the whole
* test run if it fails to count-down the latch.
*