From 419a3cc213c290070310450be9053ddbd0ab3bb3 Mon Sep 17 00:00:00 2001 From: Daniel Kulp Date: Tue, 9 Jun 2015 15:29:58 -0400 Subject: [PATCH] Start working on trying to get the javadoc stuff to pass without the lint stuff. "mvn install" now works without the lint, but a "mvn install javadoc:jar" still fails. Since that is what the release plugin uses, need to keep the lint there for now. Still lots of failures. --- .../artemis/logs/AssertionLoggerHandler.java | 2 +- .../artemis/api/core/BroadcastEndpoint.java | 1 - .../api/core/JGroupsBroadcastEndpoint.java | 2 +- .../api/core/client/TopologyMember.java | 6 ++-- .../api/core/management/AcceptorControl.java | 4 --- .../api/core/management/NotificationType.java | 2 +- .../core/management/ObjectNameBuilder.java | 7 ----- .../api/core/management/QueueControl.java | 1 - .../core/client/impl/ClientSessionImpl.java | 2 +- .../artemis/core/cluster/DiscoveryGroup.java | 6 ++-- .../impl/ActiveMQClientProtocolManager.java | 8 ++--- .../protocol/core/impl/wireformat/Ping.java | 3 +- .../management/NotificationService.java | 2 +- .../spi/core/remoting/ConnectorFactory.java | 2 +- .../spi/core/remoting/SessionContext.java | 2 +- .../artemis/api/jms/ActiveMQJMSClient.java | 10 ++++--- .../api/jms/management/JMSQueueControl.java | 3 +- .../client/DefaultConnectionProperties.java | 2 +- .../artemis/jndi/ReadOnlyContext.java | 6 ++-- .../config/impl/FileJMSConfiguration.java | 1 - .../artemis/core/journal/Journal.java | 3 +- .../core/journal/impl/FileWrapperJournal.java | 2 +- .../core/journal/impl/JournalFile.java | 2 +- .../journal/impl/JournalFilesRepository.java | 6 ++-- .../core/journal/impl/JournalImpl.java | 30 +++++++++---------- .../artemis/core/journal/impl/Reclaimer.java | 6 ++-- .../selector/filter/ComparisonExpression.java | 4 +-- .../core/server/impl/ConnectorsService.java | 2 +- .../core/server/impl/ServerConsumerImpl.java | 2 +- .../artemis/spi/core/remoting/Acceptor.java | 2 +- .../spi/core/remoting/AcceptorFactory.java | 2 +- .../ServerConnectionLifeCycleListener.java | 3 +- artemis-website/pom.xml | 15 ++++++++++ pom.xml | 1 + 34 files changed, 78 insertions(+), 74 deletions(-) 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; *

  • Core messages to a notification address (default value is {@code activemq.notifications}) *
  • JMS messages * - * @see the ActiveMQ Artemis user manual section on "Management Notifications" + * see the ActiveMQ Artemis user manual section on "Management Notifications" */ public interface NotificationType { diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/ObjectNameBuilder.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/ObjectNameBuilder.java index d7e39ecdb0..867d87eb46 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/ObjectNameBuilder.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/ObjectNameBuilder.java @@ -150,8 +150,6 @@ public final class ObjectNameBuilder /** * Returns the ObjectName used by DiscoveryGroupControl. - * - * @see DiscoveryGroupControl */ public ObjectName getDiscoveryGroupObjectName(final String name) throws Exception { @@ -160,7 +158,6 @@ public final class ObjectNameBuilder /** * Returns the ObjectName used by JMSServerControl. - * @see org.apache.activemq.artemis.api.jms.management.JMSServerControl */ public ObjectName getJMSServerObjectName() throws Exception { @@ -169,7 +166,6 @@ public final class ObjectNameBuilder /** * Returns the ObjectName used by JMSQueueControl. - * @see org.apache.activemq.artemis.api.jms.management.JMSQueueControl */ public ObjectName getJMSQueueObjectName(final String name) throws Exception { @@ -178,8 +174,6 @@ public final class ObjectNameBuilder /** * Returns the ObjectName used by TopicControl. - * - * @see TopicControl */ public ObjectName getJMSTopicObjectName(final String name) throws Exception { @@ -188,7 +182,6 @@ public final class ObjectNameBuilder /** * Returns the ObjectName used by ConnectionFactoryControl. - * @see org.apache.activemq.artemis.api.jms.management.ConnectionFactoryControl */ public ObjectName getConnectionFactoryObjectName(final String name) throws Exception { diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/QueueControl.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/QueueControl.java index f690112eee..1813d841c0 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/QueueControl.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/api/core/management/QueueControl.java @@ -374,7 +374,6 @@ public interface QueueControl * 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(); diff --git a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/client/impl/ClientSessionImpl.java b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/client/impl/ClientSessionImpl.java index 2ab0d7ea28..1fcec4293d 100644 --- a/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/client/impl/ClientSessionImpl.java +++ b/artemis-core-client/src/main/java/org/apache/activemq/artemis/core/client/impl/ClientSessionImpl.java @@ -1857,7 +1857,7 @@ public final class ClientSessionImpl implements ClientSessionInternal, FailureLi * If you ever tried to debug XIDs you will know what this is about. * This will serialize and deserialize the XID to the same way it's going to be printed on server logs * or print-data. - *

    + *

    * 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 in props * - * @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. *
    - * The Map's key is a toString representation for the consumer. Each consumer will then return a Map[] same way is returned by {@link #listScheduledMessages()} + * The Map's key is a toString representation for the consumer. Each consumer will then return a {@code Map[]} same way is returned by {@link #listScheduledMessages()} */ @Operation(desc = "List all messages being delivered per consumer") Map[]> listDeliveringMessages() throws Exception; diff --git a/artemis-jms-client/src/main/java/org/apache/activemq/artemis/jms/client/DefaultConnectionProperties.java b/artemis-jms-client/src/main/java/org/apache/activemq/artemis/jms/client/DefaultConnectionProperties.java index 2a92372b83..fbe50dc637 100644 --- a/artemis-jms-client/src/main/java/org/apache/activemq/artemis/jms/client/DefaultConnectionProperties.java +++ b/artemis-jms-client/src/main/java/org/apache/activemq/artemis/jms/client/DefaultConnectionProperties.java @@ -23,7 +23,7 @@ import java.security.PrivilegedAction; /** *

    This class will provide default properties for constructors

    * - * + *
    * * * 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 + *

    + * 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 queues, final ArrayList topics, String domain) diff --git a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/Journal.java b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/Journal.java index 924b6bd398..f3335b0429 100644 --- a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/Journal.java +++ b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/Journal.java @@ -28,7 +28,6 @@ import org.apache.activemq.artemis.core.server.ActiveMQComponent; *

    * 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}. - *

    + * * Its main purpose is to store the data as a Journal would, but without verifying records. */ public final class FileWrapperJournal extends JournalBase diff --git a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalFile.java b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalFile.java index 13838425cd..e3b1624b44 100644 --- a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalFile.java +++ b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalFile.java @@ -53,7 +53,7 @@ public interface JournalFile boolean isCanReclaim(); /** This is a field to identify that records on this file actually belong to the current file. - * The possible implementation for this is fileID & Integer.MAX_VALUE */ + * The possible implementation for this is fileID & Integer.MAX_VALUE */ int getRecordID(); long getFileID(); diff --git a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalFilesRepository.java b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalFilesRepository.java index e9177ff05d..5cf68ebeb9 100644 --- a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalFilesRepository.java +++ b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalFilesRepository.java @@ -193,7 +193,7 @@ public class JournalFilesRepository /** * Set the {link #nextFileID} value to {@code targetUpdate} if the current value is less than * {@code targetUpdate}. - *

    + * * Notice that {@code nextFileID} is incremented before being used, see * {@link JournalFilesRepository#generateFileID()}. * @@ -542,7 +542,7 @@ public class JournalFilesRepository * * @return uninitialized JournalFile * @throws Exception - * @see {@link JournalImpl#initFileHeader(SequentialFileFactory, SequentialFile, int, long)} + * @see JournalImpl#initFileHeader(SequentialFileFactory, SequentialFile, int, long) */ public JournalFile takeFile(final boolean keepOpened, final boolean multiAIO, @@ -580,7 +580,7 @@ public class JournalFilesRepository /** * Creates files for journal synchronization of a replicated backup. - *

    + * * In order to simplify synchronization, the file IDs in the backup match those in the live * server. * diff --git a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalImpl.java b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalImpl.java index d6c7a8c012..a661f68dc0 100644 --- a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalImpl.java +++ b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/JournalImpl.java @@ -72,8 +72,8 @@ import org.apache.activemq.artemis.utils.ConcurrentHashSet; import org.apache.activemq.artemis.utils.DataConstants; /** - *

    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. - *

    + * * However we need to lock it while taking and updating snapshots */ private final ReadWriteLock journalLock = new ReentrantReadWriteLock(); @@ -1100,9 +1100,9 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal /** *

    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. - *

    + * * Note: only synchronized methods on journal are methods responsible for the life-cycle such as * stop, start records will still come as this is being executed */ @@ -1656,9 +1656,9 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal /** *

    Load data accordingly to the record layouts

    - *

    + *

    *

    Basic record layout:

    - *
    Name Default Value
    AMQ_HOST or org.apache.activemq.AMQ_HOST localhost
    AMQ_PORT or org.apache.activemq.AMQ_PORT 61616
    + *
    * * * @@ -1666,15 +1666,15 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal * * * - * * * *
    Field NameSize
    RecordTypeByte (1)
    FileIDInteger (4 bytes)
    TransactionID (if record is transactional)Long (8 bytes)
    RecordIDLong (8 bytes)
    BodySize(Add, update and delete)Integer (4 bytes)
    UserDefinedRecordType (If add/update only)Byte (1) + *
    UserDefinedRecordType (If add/update only)Byte (1)
    RecordBodyByte Array (size=BodySize)
    Check SizeInteger (4 bytes)
    - *

    + *

    *

    The check-size is used to validate if the record is valid and complete

    - *

    + *

    *

    Commit/Prepare record layout:

    - * + *
    * * * @@ -1685,9 +1685,9 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal * * * - * *
    Field NameSize
    RecordTypeByte (1)
    FileIDInteger (4 bytes)
    ExtraDataBytesBytes (sized by ExtraDataLength)
    * FileID(n)Integer (4 bytes)
    * NumberOfElements(n)Integer (4 bytes)
    CheckSizeInteger (4 bytes) + *
    CheckSizeInteger (4 bytes)
    - *

    + *

    *

    * FileID and NumberOfElements are the transaction summary, and they will be repeated (N)umberOfFiles times

    */ public JournalLoadInformation load(final LoaderCallback loadManager) throws Exception @@ -3074,7 +3074,7 @@ public class JournalImpl extends JournalBase implements TestableJournal, Journal /** * Returns Map with a {@link JournalFile} for all existing files. - *

    + * * These are the files needed to be sent to a backup in order to synchronize it. * * @param fileIds diff --git a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/Reclaimer.java b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/Reclaimer.java index 343f8c8fbf..2a3e268904 100644 --- a/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/Reclaimer.java +++ b/artemis-journal/src/main/java/org/apache/activemq/artemis/core/journal/impl/Reclaimer.java @@ -21,7 +21,7 @@ import org.apache.activemq.artemis.journal.ActiveMQJournalLogger; /** * - *

    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)

    * @@ -29,9 +29,9 @@ import org.apache.activemq.artemis.journal.ActiveMQJournalLogger; * *

    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.

    */ public class Reclaimer diff --git a/artemis-selector/src/main/java/org/apache/activemq/artemis/selector/filter/ComparisonExpression.java b/artemis-selector/src/main/java/org/apache/activemq/artemis/selector/filter/ComparisonExpression.java index 0244f96df6..e1fc014d73 100755 --- a/artemis-selector/src/main/java/org/apache/activemq/artemis/selector/filter/ComparisonExpression.java +++ b/artemis-selector/src/main/java/org/apache/activemq/artemis/selector/filter/ComparisonExpression.java @@ -348,7 +348,7 @@ public abstract class ComparisonExpression extends BinaryExpression implements B } /** - * Only Numeric expressions can be used in >, >=, < or <= expressions.s + * Only Numeric expressions can be used in {@code >}, {@code >=}, {@code <} or {@code <=} expressions. * * @param expr */ @@ -372,7 +372,7 @@ public abstract class ComparisonExpression extends BinaryExpression implements B } /** - * Validates that the expression can be used in == or <> expression. Cannot + * Validates that the expression can be used in {@code ==} or {@code <>} expression. Cannot * not be NULL TRUE or FALSE litterals. * * @param expr diff --git a/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/impl/ConnectorsService.java b/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/impl/ConnectorsService.java index dcb3811405..e1157ac26e 100644 --- a/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/impl/ConnectorsService.java +++ b/artemis-server/src/main/java/org/apache/activemq/artemis/core/server/impl/ConnectorsService.java @@ -37,7 +37,7 @@ import org.apache.activemq.artemis.utils.ConfigurationHelper; /** * ConnectorsService will pool some resource for updates, e.g. Twitter, then the changes are picked * and converted into a ServerMessage for a given destination (queue). - *

    + *

    * 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 @@ artemis-selector ${project.version} + + + + org.jboss.logging + jboss-logging-processor + provided + true + + + xalan + xalan + 2.7.2 + true + provided + diff --git a/pom.xml b/pom.xml index fd608b21f7..5e566ac6ab 100644 --- a/pom.xml +++ b/pom.xml @@ -859,6 +859,7 @@ org.apache.maven.plugins maven-javadoc-plugin + -Xdoclint:none