From 9d67cc147702172afbe8c93b88311cd2e5eb6bab Mon Sep 17 00:00:00 2001 From: Robert Gemmell Date: Fri, 8 Aug 2014 15:08:08 +0000 Subject: QPID-5980: yet more javadoc fixups git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1616796 13f79535-47bb-0310-9956-ffa450edef68 --- .../apache/qpid/server/security/access/config/Action.java | 4 ++-- .../apache/qpid/server/security/access/config/RuleSet.java | 3 --- .../server/protocol/v0_8/AMQNoMethodHandlerException.java | 12 ++++-------- .../apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java | 10 ++++------ .../qpid/server/protocol/v0_8/state/AMQStateManager.java | 5 +++-- 5 files changed, 13 insertions(+), 21 deletions(-) (limited to 'qpid/java/broker-plugins') diff --git a/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/Action.java b/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/Action.java index 4fff0bebf5..e09935cf5c 100644 --- a/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/Action.java +++ b/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/Action.java @@ -33,8 +33,8 @@ import org.apache.qpid.server.security.access.Operation; * * An action consists of an {@link Operation} on an {@link ObjectType} with certain properties, stored in a {@link java.util.Map}. * The operation and object should be an allowable combination, based on the {@link ObjectType#isAllowed(Operation)} - * method of the object, which is exposed as the {@link #isAllowed()} method here. The internal {@link #propertiesMatch(Map)} - * and {@link #valueMatches(String, String)} methods are used to determine wildcarded matching of properties, with + * method of the object, which is exposed as the {@link #isAllowed()} method here. The internal #propertiesMatch(Map) + * and #valueMatches(String, String) methods are used to determine wildcarded matching of properties, with * the empty string or "*" matching all values, and "*" at the end of a rule value indicating prefix matching. *

* The {@link #matches(Action)} method is intended to be used when determining precedence of rules, and diff --git a/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/RuleSet.java b/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/RuleSet.java index 7bf5626197..fd122ef8d2 100644 --- a/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/RuleSet.java +++ b/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/RuleSet.java @@ -49,9 +49,6 @@ import org.apache.qpid.server.security.access.Permission; /** * Models the rule configuration for the access control plugin. - * - * The access control rule definitions are loaded from an external configuration file, passed in as the - * target to the {@link load(ConfigurationFile)} method. The file specified */ public class RuleSet implements EventLoggerProvider { diff --git a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/AMQNoMethodHandlerException.java b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/AMQNoMethodHandlerException.java index 8faf1a7c65..42250190b4 100644 --- a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/AMQNoMethodHandlerException.java +++ b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/AMQNoMethodHandlerException.java @@ -27,14 +27,10 @@ import org.apache.qpid.protocol.AMQMethodEvent; /** * AMQNoMethodHandlerException represents the case where no method handler exists to handle an AQMP method. * - *

- *
CRC Card
Responsibilities Collaborations - *
Represents failure to handle an AMQP method. - *
- * - * @todo Not an AMQP exception as no status code. - * - * @todo Missing method handler. Unlikely to ever happen, and if it does its a coding error. Consider replacing with a + *

+ * TODO Not an AMQP exception as no status code. + *

+ * TODO Missing method handler. Unlikely to ever happen, and if it does its a coding error. Consider replacing with a * Runtime. */ public class AMQNoMethodHandlerException extends AMQException diff --git a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java index 7303ef30da..7c2efe64e6 100644 --- a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java +++ b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java @@ -44,8 +44,10 @@ import org.apache.qpid.server.txn.ServerTransaction; import org.apache.qpid.server.util.StateChangeListener; /** - * Encapsulation of a subscription to a queue.

Ties together the protocol session of a subscriber, the consumer tag - * that was given out by the broker and the channel id.

+ * Encapsulation of a subscription to a queue. + *

+ * Ties together the protocol session of a subscriber, the consumer tag + * that was given out by the broker and the channel id. */ public abstract class ConsumerTarget_0_8 extends AbstractConsumerTarget implements FlowCreditManager.FlowCreditManagerListener { @@ -171,10 +173,8 @@ public abstract class ConsumerTarget_0_8 extends AbstractConsumerTarget implemen * This method can be called by each of the publisher threads. As a result all changes to the channel object must be * thread safe. * - * * @param entry The message to send * @param batch - * @throws org.apache.qpid.AMQException */ @Override public void send(MessageInstance entry, boolean batch) @@ -287,10 +287,8 @@ public abstract class ConsumerTarget_0_8 extends AbstractConsumerTarget implemen * This method can be called by each of the publisher threads. As a result all changes to the channel object must be * thread safe. * - * * @param entry The message to send * @param batch - * @throws org.apache.qpid.AMQException */ @Override public void send(MessageInstance entry, boolean batch) diff --git a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/state/AMQStateManager.java b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/state/AMQStateManager.java index 328064b6dc..cb9295ac49 100644 --- a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/state/AMQStateManager.java +++ b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/state/AMQStateManager.java @@ -43,8 +43,9 @@ import org.apache.qpid.server.security.SubjectCreator; import org.apache.qpid.server.util.ServerScopedRuntimeException; /** - * The state manager is responsible for managing the state of the protocol session.

For each AMQProtocolHandler - * there is a separate state manager. + * The state manager is responsible for managing the state of the protocol session. + *

+ * For each AMQProtocolHandler there is a separate state manager. */ public class AMQStateManager implements AMQMethodListener { -- cgit v1.2.1