diff --git a/artemis-commons/src/main/java/org/apache/activemq/artemis/logs/AssertionLoggerHandler.java b/artemis-commons/src/main/java/org/apache/activemq/artemis/logs/AssertionLoggerHandler.java index 036fd430d4..b366b61f03 100644 --- a/artemis-commons/src/main/java/org/apache/activemq/artemis/logs/AssertionLoggerHandler.java +++ b/artemis-commons/src/main/java/org/apache/activemq/artemis/logs/AssertionLoggerHandler.java @@ -26,7 +26,7 @@ import org.jboss.logmanager.ExtLogRecord; /** * This class contains a tool where programs could intercept for LogMessage given an interval of time between {@link #startCapture()} * and {@link #stopCapture()} - *
+ * * Be careful with this use as this is intended for testing only (such as testcases) */ public class AssertionLoggerHandler extends ExtHandler diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/BroadcastEndpoint.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/BroadcastEndpoint.java index 44656c986a..7d1a6a8f0b 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/BroadcastEndpoint.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/BroadcastEndpoint.java @@ -35,7 +35,6 @@ import java.util.concurrent.TimeUnit; * JGroups channels. * * @see JGroupsBroadcastEndpoint - * @see UDPBroadcastEndpoint */ public interface BroadcastEndpoint { diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/JGroupsBroadcastEndpoint.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/JGroupsBroadcastEndpoint.java index c508f5b003..d1af49282e 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/JGroupsBroadcastEndpoint.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/JGroupsBroadcastEndpoint.java @@ -240,7 +240,7 @@ public abstract class JGroupsBroadcastEndpoint implements BroadcastEndpoint /** * This class maintain a global Map of JChannels wrapped in JChannelWrapper for * the purpose of reference counting. - * + * * Wherever a JChannel is needed it should only get it by calling the getChannel() * method of this class. The real disconnect of channels are also done here only. */ diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/client/TopologyMember.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/client/TopologyMember.java index 137e48f1f7..84d67218f3 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/client/TopologyMember.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/client/TopologyMember.java @@ -21,7 +21,7 @@ import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection; /** * A member of the topology. - *+ * * Each TopologyMember represents a single server and possibly any backup server that may take over * its duties (using the nodeId of the original server). */ @@ -42,10 +42,10 @@ public interface TopologyMember /** * Returns the {@code scale-down-group-name} of the live server with this Topology entry. - *
+ ** This is a server configuration value. a live server will only send its messages to another live server * with matching {@code scale-down-group-name}. - *
+ ** * @return the {@code scale-down-group-name} */ diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/AcceptorControl.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/AcceptorControl.java index d44e1f772d..28061823e0 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/AcceptorControl.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/AcceptorControl.java @@ -20,8 +20,6 @@ import java.util.Map; /** * An AcceptorControl is used to manage Acceptors. - * - * @see Acceptor */ public interface AcceptorControl extends ActiveMQComponentControl { @@ -33,8 +31,6 @@ public interface AcceptorControl extends ActiveMQComponentControl /** * Returns the class name of the AcceptorFactory implementation * used by this acceptor. - * - * @see AcceptorFactory */ String getFactoryClassName(); diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/NotificationType.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/NotificationType.java index fd7e0a91ef..07fa2804b9 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/NotificationType.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/NotificationType.java @@ -25,7 +25,7 @@ package org.apache.activemq.artemis.api.core.management; *
* This will convert to the same XID deserialized on the Server, hence we will be able to debug eventual stuff * * @param xid diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/cluster/DiscoveryGroup.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/cluster/DiscoveryGroup.java index 1f33986275..bb4ea6d1a6 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/cluster/DiscoveryGroup.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/cluster/DiscoveryGroup.java @@ -39,12 +39,12 @@ import org.apache.activemq.artemis.utils.TypedProperties; /** * This class is used to search for members on the cluster through the opaque interface {@link BroadcastEndpoint}. - *
+ * * There are two current implementations, and that's probably all we will ever need. - * + * * We will probably keep both interfaces for a while as UDP is a simple solution requiring no extra dependencies which * is suitable for users looking for embedded solutions. - * + * */ public final class DiscoveryGroup implements ActiveMQComponent { diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/protocol/core/impl/ActiveMQClientProtocolManager.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/protocol/core/impl/ActiveMQClientProtocolManager.java index 92e2ecdbda..d938b85670 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/protocol/core/impl/ActiveMQClientProtocolManager.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/protocol/core/impl/ActiveMQClientProtocolManager.java @@ -62,13 +62,13 @@ import org.apache.activemq.artemis.utils.VersionLoader; /** * This class will return specific packets for different types of actions happening on a messaging protocol. - * + * * This is trying to unify the Core client into multiple protocols. - * + * * Returning null in certain packets means no action is taken on this specific protocol. - * + * * Semantic properties could also be added to this implementation. - * + * * Implementations of this class need to be stateless. */ diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/protocol/core/impl/wireformat/Ping.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/protocol/core/impl/wireformat/Ping.java index fc48318b49..7113d5ad89 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/protocol/core/impl/wireformat/Ping.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/protocol/core/impl/wireformat/Ping.java @@ -21,8 +21,7 @@ import org.apache.activemq.artemis.core.protocol.core.impl.PacketImpl; /** * Ping is sent on the client side by {@link org.apache.activemq.artemis.core.client.impl.ClientSessionFactoryImpl}. At the server's - * side it is handled by {@link org.apache.activemq.artemis.core.remoting.server.impl.RemotingServiceImpl} - * @see org.apache.activemq.artemis.spi.core.protocol.RemotingConnection#checkDataReceived() + * side it is handled by org.apache.activemq.artemis.core.remoting.server.impl.RemotingServiceImpl */ public final class Ping extends PacketImpl { diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/server/management/NotificationService.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/server/management/NotificationService.java index cb22437b9f..d6625a6ce1 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/server/management/NotificationService.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/server/management/NotificationService.java @@ -27,7 +27,7 @@ public interface NotificationService * * in addition to the properties defined inprops
*
- * @see ManagementHelper
+ * @see org.apache.activemq.artemis.api.core.management.ManagementHelper
*/
void sendNotification(Notification notification) throws Exception;
diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/spi/core/remoting/ConnectorFactory.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/spi/core/remoting/ConnectorFactory.java
index 09adeded39..a1ad5f90e5 100644
--- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/spi/core/remoting/ConnectorFactory.java
+++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/spi/core/remoting/ConnectorFactory.java
@@ -25,7 +25,7 @@ import org.apache.activemq.artemis.api.core.TransportConfigurationHelper;
/**
* A ConnectorFactory is used by the client for creating connectors.
* - * A Connector is used to connect to an {@link org.apache.activemq.artemis.spi.core.remoting.Acceptor}. + * A Connector is used to connect to an org.apache.activemq.artemis.spi.core.remoting.Acceptor. */ public interface ConnectorFactory extends TransportConfigurationHelper { diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/spi/core/remoting/SessionContext.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/spi/core/remoting/SessionContext.java index 3b690d92d0..2bbbece4f4 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/spi/core/remoting/SessionContext.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/spi/core/remoting/SessionContext.java @@ -173,7 +173,7 @@ public abstract class SessionContext /** * If we are doing a simple rollback on the RA, we need to ack the last message sent to the consumer, * otherwise DLQ won't work. - *
+ ** this is because we only ACK after on the RA, We may review this if we always acked earlier. * * @param lastMessageAsDelivered diff --git a/artemis-jms-client/src/main/java/org/apache/activemq/artemis/api/jms/ActiveMQJMSClient.java b/artemis-jms-client/src/main/java/org/apache/activemq/artemis/api/jms/ActiveMQJMSClient.java index 306129e1b2..32e1769bf5 100644 --- a/artemis-jms-client/src/main/java/org/apache/activemq/artemis/api/jms/ActiveMQJMSClient.java +++ b/artemis-jms-client/src/main/java/org/apache/activemq/artemis/api/jms/ActiveMQJMSClient.java @@ -58,8 +58,8 @@ public class ActiveMQJMSClient * updated whenever the cluster topology changes. If the topology includes backup servers that * information is also propagated to the client so that it can know which server to failover onto * in case of live server failure. - * @param discoveryAddress The UDP group address to listen for updates - * @param discoveryPort the UDP port to listen for updates + * @param groupConfiguration + * @param jmsFactoryType * @return the ActiveMQConnectionFactory */ public static ActiveMQConnectionFactory createConnectionFactoryWithHA(final DiscoveryGroupConfiguration groupConfiguration, JMSFactoryType jmsFactoryType) @@ -98,8 +98,8 @@ public class ActiveMQJMSClient * * The UDP address and port are used to listen for live servers in the cluster * - * @param discoveryAddress The UDP group address to listen for updates - * @param discoveryPort the UDP port to listen for updates + * @param groupConfiguration + * @param jmsFactoryType * @return the ActiveMQConnectionFactory */ public static ActiveMQConnectionFactory createConnectionFactoryWithoutHA(final DiscoveryGroupConfiguration groupConfiguration, JMSFactoryType jmsFactoryType) @@ -142,6 +142,7 @@ public class ActiveMQJMSClient * downloaded and automatically updated whenever the cluster topology changes. If the topology * includes backup servers that information is also propagated to the client so that it can know * which server to failover onto in case of live server failure. + * @param jmsFactoryType * @param initialServers The initial set of servers used to make a connection to the cluster. * Each one is tried in turn until a successful connection is made. Once a connection * is made, the cluster topology is downloaded and the rest of the list is ignored. @@ -184,6 +185,7 @@ public class ActiveMQJMSClient *
* The ActiveMQConnectionFactory is not updated automatically as the cluster topology changes, and
* no HA backup information is propagated to the client
+ * @param jmsFactoryType
* @param transportConfigurations
* @return the ActiveMQConnectionFactory
*/
diff --git a/artemis-jms-client/src/main/java/org/apache/activemq/artemis/api/jms/management/JMSQueueControl.java b/artemis-jms-client/src/main/java/org/apache/activemq/artemis/api/jms/management/JMSQueueControl.java
index adb1d376fc..d12372f493 100644
--- a/artemis-jms-client/src/main/java/org/apache/activemq/artemis/api/jms/management/JMSQueueControl.java
+++ b/artemis-jms-client/src/main/java/org/apache/activemq/artemis/api/jms/management/JMSQueueControl.java
@@ -284,7 +284,6 @@ public interface JMSQueueControl extends DestinationControl
* it will flush one cycle on internal executors, so you would be sure that any pending tasks are done before you call
* any other measure.
* It is useful if you need the exact number of counts on a message
- * @throws Exception
*/
void flushExecutor();
@@ -305,7 +304,7 @@ public interface JMSQueueControl extends DestinationControl
/**
* Lists all the messages being deliver per consumer.
* This class will provide default properties for constructors
+ * This version assumes it and all its subcontext are
* read-only and any attempt to modify (e.g. through bind) will result in an
* OperationNotSupportedException. Each Context in the tree builds a cache of
* the entries in all sub-contexts to optimise the performance of lookup.
- *
*
* This implementation is intended to optimise the performance of lookup(String)
* to about the level of a HashMap get. It has been observed that the scheme
diff --git a/artemis-jms-server/src/main/java/org/apache/activemq/artemis/jms/server/config/impl/FileJMSConfiguration.java b/artemis-jms-server/src/main/java/org/apache/activemq/artemis/jms/server/config/impl/FileJMSConfiguration.java
index c37abbbc8b..8fad9d6e27 100644
--- a/artemis-jms-server/src/main/java/org/apache/activemq/artemis/jms/server/config/impl/FileJMSConfiguration.java
+++ b/artemis-jms-server/src/main/java/org/apache/activemq/artemis/jms/server/config/impl/FileJMSConfiguration.java
@@ -204,7 +204,6 @@ public class FileJMSConfiguration extends JMSConfigurationImpl implements Deploy
* @param queues
* @param topics
* @param domain
- * @return
*/
protected void newConfig(final ArrayList
* Notice also that even on the callback methods it's possible to pass the sync mode. That will only
* make sense on the NIO operations.
- * @see org.apache.activemq.artemis.utils.IDGenerator
*/
public interface Journal extends ActiveMQComponent
{
@@ -206,7 +205,7 @@ public interface Journal extends ActiveMQComponent
/**
* This method will start compact using the compactorExecutor and block up to timeout seconds
- * @param timeout the timeout in seconds or block forever if <= 0
+ * @param timeout the timeout in seconds or block forever if {@code <= 0}
* @throws Exception
*/
void scheduleCompactAndBlock(int timeout) throws Exception;
diff --git a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/FileWrapperJournal.java b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/FileWrapperJournal.java
index 74152b7576..a41e72f12e 100644
--- a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/FileWrapperJournal.java
+++ b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/FileWrapperJournal.java
@@ -45,7 +45,7 @@ import org.apache.activemq.artemis.core.journal.impl.dataformat.JournalInternalR
/**
* Journal used at a replicating backup server during the synchronization of data with the 'live'
* server. It just wraps a single {@link JournalFile}.
- * A circular log implementation. A circular log implementation. Look at {@link JournalImpl#load(LoaderCallback)} for the file layout
*/
public class JournalImpl extends JournalBase implements TestableJournal, JournalRecordProvider
@@ -202,7 +202,7 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal
* We don't lock the journal during the whole compacting operation. During compacting we only
* lock it (i) when gathering the initial structure, and (ii) when replicating the structures
* after finished compacting.
- * If the system crashed after a prepare was called, it should store information that is required to bring the transaction
* back to a state it could be committed. transactionData allows you to store any other supporting user-data related to the transaction This method also uses the same logic applied on {@link JournalImpl#appendCommitRecord(long, boolean)}
*
* @param txID
@@ -1448,7 +1448,7 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal
/**
* Note: This method can't be called from the main executor, as it will invoke other methods
* depending on it.
- * Load data accordingly to the record layouts Basic record layout: The check-size is used to validate if the record is valid and complete Commit/Prepare record layout: * FileID and NumberOfElements are the transaction summary, and they will be repeated (N)umberOfFiles times The journal consists of an ordered list of journal files Fn where 0 <= n <= N The journal consists of an ordered list of journal files Fn where {@code 0 <= n <= N} A journal file can contain either positives (pos) or negatives (neg) A file Fn can be deleted if, and only if the following criteria are satisified 1) All pos in a file Fn, must have corresponding neg in any file Fm where m >= n. 1) All pos in a file Fn, must have corresponding neg in any file Fm where {@code m >= n}. 2) All pos that correspond to any neg in file Fn, must all live in any file Fm where 0 <= m <= n
+ * 2) All pos that correspond to any neg in file Fn, must all live in any file Fm where {@code 0 <= m <= n}
* which are also marked for deletion in the same pass of the algorithm.
* It may also listen to a queue, and forward them (e.g. messages arriving at the queue are picked
* and tweeted to some Twitter account).
*/
diff --git a/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/impl/ServerConsumerImpl.java b/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/impl/ServerConsumerImpl.java
index 0a8b521c99..cd4a59ff11 100644
--- a/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/impl/ServerConsumerImpl.java
+++ b/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/impl/ServerConsumerImpl.java
@@ -506,7 +506,7 @@ public class ServerConsumerImpl implements ServerConsumer, ReadyListener
/**
* Prompt delivery and send a "forced delivery" message to the consumer.
- *
* When the consumer receives such a "forced delivery" message, it discards it and knows that
* there are no other messages to be delivered.
*/
diff --git a/artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/remoting/Acceptor.java b/artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/remoting/Acceptor.java
index 8aa1c5add0..6a85135da8 100644
--- a/artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/remoting/Acceptor.java
+++ b/artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/remoting/Acceptor.java
@@ -55,7 +55,7 @@ public interface Acceptor extends ActiveMQComponent
/**
* Whether this acceptor allows insecure connections.
- * @throws java.lang.IllegalStatException if false @setDefaultActiveMQPrincipal
+ * @throws java.lang.IllegalStateException if false @setDefaultActiveMQPrincipal
*/
boolean isUnsecurable();
}
diff --git a/artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/remoting/AcceptorFactory.java b/artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/remoting/AcceptorFactory.java
index 2cb47aa8d8..b1926340e9 100644
--- a/artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/remoting/AcceptorFactory.java
+++ b/artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/remoting/AcceptorFactory.java
@@ -25,7 +25,7 @@ import org.apache.activemq.artemis.spi.core.protocol.ProtocolManager;
/**
* A factory for creating acceptors.
- *
* An Acceptor is an endpoint that a {@link org.apache.activemq.artemis.spi.core.remoting.Connector} will connect to and is used by the remoting service.
*/
public interface AcceptorFactory
diff --git a/artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/remoting/ServerConnectionLifeCycleListener.java b/artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/remoting/ServerConnectionLifeCycleListener.java
index 3f64c95a7b..43f92ef4fe 100644
--- a/artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/remoting/ServerConnectionLifeCycleListener.java
+++ b/artemis-server/src/main/java/org/apache/activemq/artemis/spi/core/remoting/ServerConnectionLifeCycleListener.java
@@ -22,8 +22,9 @@ public interface ServerConnectionLifeCycleListener extends ConnectionLifeCycleLi
* This method is used both by client connector creation and server connection creation through acceptors.
* the acceptor will be set to null on client operations
*
- * @param The acceptor here will be always null on a client connection created event.
+ * @param acceptor The acceptor here will be always null on a client connection created event.
* @param connection the connection that has been created
+ * @param protocol the protocol to use
*/
void connectionCreated(Acceptor acceptor, Connection connection, String protocol);
}
diff --git a/artemis-website/pom.xml b/artemis-website/pom.xml
index bcd7340547..479a7272a1 100644
--- a/artemis-website/pom.xml
+++ b/artemis-website/pom.xml
@@ -58,6 +58,21 @@
- * The Map's key is a toString representation for the consumer. Each consumer will then return a Map
+ *
*
* Name Default Value
* AMQ_HOST or org.apache.activemq.AMQ_HOST localhost
diff --git a/artemis-jms-client/src/main/java/org/apache/activemq/artemis/jndi/ReadOnlyContext.java b/artemis-jms-client/src/main/java/org/apache/activemq/artemis/jndi/ReadOnlyContext.java
index 6041d43752..69f5e9c3ab 100644
--- a/artemis-jms-client/src/main/java/org/apache/activemq/artemis/jndi/ReadOnlyContext.java
+++ b/artemis-jms-client/src/main/java/org/apache/activemq/artemis/jndi/ReadOnlyContext.java
@@ -40,11 +40,13 @@ import javax.naming.spi.NamingManager;
import org.apache.activemq.artemis.core.client.ActiveMQClientLogger;
/**
- * A read-only Context This version assumes it and all its subcontext are
+ * A read-only Context
+ * AMQ_PORT or org.apache.activemq.AMQ_PORT 61616
+ *
*
- *
+ *
*
* Field Name Size
* RecordType Byte (1)
@@ -1666,15 +1666,15 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal
* FileID Integer (4 bytes)
* TransactionID (if record is transactional) Long (8 bytes)
* RecordID Long (8 bytes)
- * BodySize(Add, update and delete) Integer (4 bytes) UserDefinedRecordType (If add/update only) Byte (1)
+ *
* UserDefinedRecordType (If add/update only) Byte (1)
* RecordBody Byte Array (size=BodySize)
* Check Size Integer (4 bytes)
+ *
*
- *
+ *
*
* Field Name Size
* RecordType Byte (1)
@@ -1685,9 +1685,9 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal
* FileID Integer (4 bytes)
* ExtraDataBytes Bytes (sized by ExtraDataLength)
* * FileID(n) Integer (4 bytes)
- * * NumberOfElements(n) Integer (4 bytes) CheckSize Integer (4 bytes)
+ *
* CheckSize Integer (4 bytes)