You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ta...@apache.org on 2021/06/18 21:34:33 UTC

[qpid-protonj2] branch main updated (1999564 -> aefdefc)

This is an automated email from the ASF dual-hosted git repository.

tabish pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-protonj2.git.


    from 1999564  PROTON-2393 Allow more AmqpValue payloads to be configured for send
     new 553ae9a  PROTON-2394 Add missing javadocs for client exception types.
     new f3e11c9  PROTON-2394 Fix some typos in the existing client docs
     new aefdefc  PROTON-2394 Fix some spelling errors in configuration constants

The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .../apache/qpid/protonj2/client/Connection.java    | 21 ++++++++++---
 .../org/apache/qpid/protonj2/client/Message.java   |  1 +
 .../qpid/protonj2/client/ReconnectOptions.java     |  8 ++---
 .../qpid/protonj2/client/SessionOptions.java       |  8 ++---
 .../org/apache/qpid/protonj2/client/Source.java    |  2 +-
 .../ClientConnectionRedirectedException.java       | 10 +++++++
 .../ClientConnectionRemotelyClosedException.java   | 32 ++++++++++++++++++++
 .../ClientConnectionSecurityException.java         | 32 ++++++++++++++++++++
 .../ClientConnectionSecuritySaslException.java     | 35 ++++++++++++++++++++++
 .../exceptions/ClientDeliveryAbortedException.java | 14 +++++++++
 .../ClientDeliveryIsPartialException.java          | 14 +++++++++
 .../exceptions/ClientDeliveryStateException.java   | 18 +++++++++++
 .../client/exceptions/ClientException.java         | 14 +++++++++
 .../client/exceptions/ClientIOException.java       | 14 +++++++++
 .../exceptions/ClientIdleTimeoutException.java     | 14 +++++++++
 .../exceptions/ClientIllegalStateException.java    | 14 +++++++++
 .../exceptions/ClientLinkRedirectedException.java  | 10 +++++++
 .../ClientLinkRemotelyClosedException.java         | 32 ++++++++++++++++++++
 .../ClientMessageFormatViolationException.java     | 14 +++++++++
 .../ClientOperationTimedOutException.java          | 14 +++++++++
 .../ClientResourceRemotelyClosedException.java     | 32 ++++++++++++++++++++
 .../exceptions/ClientSendTimedOutException.java    |  6 ++++
 .../ClientSessionRemotelyClosedException.java      | 32 ++++++++++++++++++++
 .../ClientTransactionDeclarationException.java     | 14 +++++++++
 .../ClientTransactionInDoubtException.java         | 14 +++++++++
 .../ClientTransactionNotActiveException.java       | 14 +++++++++
 .../ClientTransactionRolledBackException.java      | 14 +++++++++
 .../ClientUnsupportedOperationException.java       | 14 +++++++++
 28 files changed, 448 insertions(+), 13 deletions(-)

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org


[qpid-protonj2] 02/03: PROTON-2394 Fix some typos in the existing client docs

Posted by ta...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

tabish pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-protonj2.git

commit f3e11c9b841e542b3582dec80ca0eb97c9a85317
Author: Timothy Bish <ta...@gmail.com>
AuthorDate: Wed Jun 16 17:35:30 2021 -0400

    PROTON-2394 Fix some typos in the existing client docs
---
 .../org/apache/qpid/protonj2/client/Connection.java | 21 +++++++++++++++++----
 .../org/apache/qpid/protonj2/client/Message.java    |  1 +
 .../apache/qpid/protonj2/client/SessionOptions.java |  8 ++++----
 .../org/apache/qpid/protonj2/client/Source.java     |  2 +-
 4 files changed, 23 insertions(+), 9 deletions(-)

diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Connection.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Connection.java
index c129982..c8ffe35 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Connection.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Connection.java
@@ -122,7 +122,14 @@ public interface Connection extends AutoCloseable {
 
     /**
      * Creates a receiver used to consume messages from the given node address and configure it
-     * such that the remote create a durable node.
+     * such that the remote create a durable node.  The returned receiver will be configured using
+     * default options and will take its timeout configuration values from those specified in the
+     * parent {@link Connection}.
+     *
+     * The returned receiver may not have been opened on the remote when it is returned.  Some methods of the
+     * {@link Receiver} can block until the remote fully opens the receiver, the user can wait for the remote
+     * to respond to the open request by calling the {@link Receiver#openFuture()} method and using the
+     * {@link Future#get()} methods to wait for completion.
      *
      * @param address
      * 			The source address to attach the consumer to.
@@ -137,7 +144,13 @@ public interface Connection extends AutoCloseable {
 
     /**
      * Creates a receiver used to consume messages from the given node address and configure it
-     * such that the remote create a durable node.
+     * such that the remote create a durable node.  The returned receiver will be configured using
+     * provided options.
+     *
+     * The returned receiver may not have been opened on the remote when it is returned.  Some methods of the
+     * {@link Receiver} can block until the remote fully opens the receiver, the user can wait for the remote
+     * to respond to the open request by calling the {@link Receiver#openFuture()} method and using the
+     * {@link Future#get()} methods to wait for completion.
      *
      * @param address
      *            The source address to attach the consumer to.
@@ -169,7 +182,7 @@ public interface Connection extends AutoCloseable {
     Receiver openDynamicReceiver() throws ClientException;
 
     /**
-     * Creates a dynamic receiver used to consume messages from the given node address.
+     * Creates a dynamic receiver used to consume messages from a dynamically generated node on the remote..
      *
      * The returned receiver may not have been opened on the remote when it is returned.  Some methods of the
      * {@link Receiver} can block until the remote fully opens the receiver, the user can wait for the remote
@@ -186,7 +199,7 @@ public interface Connection extends AutoCloseable {
     Receiver openDynamicReceiver(Map<String, Object> dynamicNodeProperties) throws ClientException;
 
     /**
-     * Creates a dynamic receiver used to consume messages from the given node address.
+     * Creates a dynamic receiver used to consume messages from a dynamically generated node on the remote..
      *
      * The returned receiver may not have been opened on the remote when it is returned.  Some methods of the
      * {@link Receiver} can block until the remote fully opens the receiver, the user can wait for the remote
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Message.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Message.java
index c0f7b22..1d97a60 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Message.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Message.java
@@ -167,6 +167,7 @@ public interface Message<E> {
     /**
      * Sets the relative message priority.  Higher numbers indicate higher priority messages.
      * Messages with higher priorities MAY be delivered before those with lower priorities.
+     * For a received message this overwrites any value that was set by the remote sender.
      *
      * @param priority
      * 		The priority value to assign this message.
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SessionOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SessionOptions.java
index f13176c..a61221c 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SessionOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/SessionOptions.java
@@ -355,8 +355,8 @@ public class SessionOptions {
     }
 
     /**
-     * Sets the incoming capacity for a {@link Session} the created session.  The incoming capacity
-     * control how much buffering a session will allow before applying back pressure to the remote
+     * Sets the incoming capacity for a {@link Session} created with these options.  The incoming capacity
+     * controls how much buffering a session will allow before applying back pressure to the remote
      * thereby preventing excessive memory overhead.
      * <p>
      * This is an advanced option and in most cases the client defaults should be left in place unless
@@ -380,8 +380,8 @@ public class SessionOptions {
     }
 
     /**
-     * Sets the outgoing capacity for a {@link Session} the created session.  The outgoing capacity
-     * control how much buffering a session will allow before applying back pressure to the local
+     * Sets the outgoing capacity for a {@link Session} created with these options.  The outgoing capacity
+     * controls how much buffering a session will allow before applying back pressure to the local
      * thereby preventing excessive memory overhead while writing large amounts of data and the
      * client is experiencing back-pressure due to the remote not keeping pace.
      * <p>
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Source.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Source.java
index f99e0d0..fca0b60 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Source.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/Source.java
@@ -48,7 +48,7 @@ public interface Source {
     ExpiryPolicy expiryPolicy();
 
     /**
-     * @return true if the Source node dynamically on-demand
+     * @return true if the Source node was created dynamically on-demand
      */
     boolean dynamic();
 

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org


[qpid-protonj2] 01/03: PROTON-2394 Add missing javadocs for client exception types.

Posted by ta...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

tabish pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-protonj2.git

commit 553ae9a7f52c3123951e6aa77d7747a289dc9b8c
Author: Timothy Bish <ta...@gmail.com>
AuthorDate: Wed Jun 16 17:35:13 2021 -0400

    PROTON-2394 Add missing javadocs for client exception types.
---
 .../ClientConnectionRedirectedException.java       | 10 +++++++
 .../ClientConnectionRemotelyClosedException.java   | 32 ++++++++++++++++++++
 .../ClientConnectionSecurityException.java         | 32 ++++++++++++++++++++
 .../ClientConnectionSecuritySaslException.java     | 35 ++++++++++++++++++++++
 .../exceptions/ClientDeliveryAbortedException.java | 14 +++++++++
 .../ClientDeliveryIsPartialException.java          | 14 +++++++++
 .../exceptions/ClientDeliveryStateException.java   | 18 +++++++++++
 .../client/exceptions/ClientException.java         | 14 +++++++++
 .../client/exceptions/ClientIOException.java       | 14 +++++++++
 .../exceptions/ClientIdleTimeoutException.java     | 14 +++++++++
 .../exceptions/ClientIllegalStateException.java    | 14 +++++++++
 .../exceptions/ClientLinkRedirectedException.java  | 10 +++++++
 .../ClientLinkRemotelyClosedException.java         | 32 ++++++++++++++++++++
 .../ClientMessageFormatViolationException.java     | 14 +++++++++
 .../ClientOperationTimedOutException.java          | 14 +++++++++
 .../ClientResourceRemotelyClosedException.java     | 32 ++++++++++++++++++++
 .../exceptions/ClientSendTimedOutException.java    |  6 ++++
 .../ClientSessionRemotelyClosedException.java      | 32 ++++++++++++++++++++
 .../ClientTransactionDeclarationException.java     | 14 +++++++++
 .../ClientTransactionInDoubtException.java         | 14 +++++++++
 .../ClientTransactionNotActiveException.java       | 14 +++++++++
 .../ClientTransactionRolledBackException.java      | 14 +++++++++
 .../ClientUnsupportedOperationException.java       | 14 +++++++++
 23 files changed, 421 insertions(+)

diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionRedirectedException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionRedirectedException.java
index e393499..36f1583 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionRedirectedException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionRedirectedException.java
@@ -36,6 +36,16 @@ public class ClientConnectionRedirectedException extends ClientConnectionRemotel
 
     private final ClientRedirect redirect;
 
+    /**
+     * Creates a new connection redirect exception with the provided redirection infromation.
+     *
+     * @param reason
+     * 		The reason for the redirect
+     * @param redirect
+     * 		The {@link ClientRedirect} information object.
+     * @param condition
+     * 		The {@link ErrorCondition} that describes the redirection error.
+     */
     public ClientConnectionRedirectedException(String reason, ClientRedirect redirect, ErrorCondition condition) {
         super(reason, condition);
 
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionRemotelyClosedException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionRemotelyClosedException.java
index 5962fd8..4e77df8 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionRemotelyClosedException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionRemotelyClosedException.java
@@ -31,19 +31,51 @@ public class ClientConnectionRemotelyClosedException extends ClientIOException {
 
     private final ErrorCondition condition;
 
+    /**
+     * Creates a new connection remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     */
     public ClientConnectionRemotelyClosedException(String message) {
         this(message, (ErrorCondition) null);
     }
 
+    /**
+     * Creates a new connection remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     * @param cause
+     * 		An exception that further defines the remote close reason.
+     */
     public ClientConnectionRemotelyClosedException(String message, Throwable cause) {
         this(message, cause, null);
     }
 
+    /**
+     * Creates a new connection remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     * @param condition
+     * 		An {@link ErrorCondition} that provides additional information about the close reason.
+     */
     public ClientConnectionRemotelyClosedException(String message, ErrorCondition condition) {
         super(message);
         this.condition = condition;
     }
 
+    /**
+     * Creates a new connection remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     * @param cause
+     * 		An exception that further defines the remote close reason.
+     * @param condition
+     * 		An {@link ErrorCondition} that provides additional information about the close reason.
+     */
     public ClientConnectionRemotelyClosedException(String message, Throwable cause, ErrorCondition condition) {
         super(message, cause);
         this.condition = condition;
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionSecurityException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionSecurityException.java
index 695161b..81828dd 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionSecurityException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionSecurityException.java
@@ -25,18 +25,50 @@ public class ClientConnectionSecurityException extends ClientConnectionRemotelyC
 
     private static final long serialVersionUID = -1895132556606592253L;
 
+    /**
+     * Creates a new connection security exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the security error.
+     */
     public ClientConnectionSecurityException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new connection security exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the security error.
+     * @param cause
+     * 		An exception that further defines the reason for the security error.
+     */
     public ClientConnectionSecurityException(String message, Throwable cause) {
         super(message, cause);
     }
 
+    /**
+     * Creates a new connection security exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param errorCondition
+     * 		An {@link ErrorCondition} that provides additional information about the error.
+     */
     public ClientConnectionSecurityException(String message, ErrorCondition errorCondition) {
         super(message, errorCondition);
     }
 
+    /**
+     * Creates a new connection security exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the security error.
+     * @param errorCondition
+     * 		An {@link ErrorCondition} that provides additional information about the error.
+     */
     public ClientConnectionSecurityException(String message, Throwable cause, ErrorCondition errorCondition) {
         super(message, cause, errorCondition);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionSecuritySaslException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionSecuritySaslException.java
index 112e387..75fc368 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionSecuritySaslException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientConnectionSecuritySaslException.java
@@ -25,24 +25,59 @@ public class ClientConnectionSecuritySaslException extends ClientConnectionSecur
 
     private boolean temporary;
 
+    /**
+     * Create a new instance of the connection SASL security exception
+     *
+     * @param message
+     * 		The message that describes the error.
+     */
     public ClientConnectionSecuritySaslException(String message) {
         this(message,false, null);
     }
 
+    /**
+     * Create a new instance of the connection SASL security exception
+     *
+     * @param message
+     * 		The message that describes the error.
+     * @param cause
+     * 		The exception that initiated this error.
+     */
     public ClientConnectionSecuritySaslException(String message, Throwable cause) {
         this(message,false, cause);
     }
 
+    /**
+     * Create a new instance of the connection SASL security exception
+     *
+     * @param message
+     * 		The message that describes the error.
+     * @param temporary
+     * 		Boolean that indicates if the error is a temporary (true) or permanent error (false).
+     */
     public ClientConnectionSecuritySaslException(String message, boolean temporary) {
         this(message, temporary, null);
     }
 
+    /**
+     * Create a new instance of the connection SASL security exception
+     *
+     * @param message
+     * 		The message that describes the error.
+     * @param temporary
+     * 		Boolean that indicates if the error is a temporary (true) or permanent error (false).
+     * @param cause
+     * 		The exception that initiated this error.
+     */
     public ClientConnectionSecuritySaslException(String message, boolean temporary, Throwable cause) {
         super(message, cause);
 
         this.temporary = temporary;
     }
 
+    /**
+     * @return true if the error is temporary and reconection may be possible.
+     */
     public boolean isSysTempFailure() {
         return temporary;
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientDeliveryAbortedException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientDeliveryAbortedException.java
index e2c6b5a..888c949 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientDeliveryAbortedException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientDeliveryAbortedException.java
@@ -24,10 +24,24 @@ public class ClientDeliveryAbortedException extends ClientIllegalStateException
 
     private static final long serialVersionUID = 818288499075794863L;
 
+    /**
+     * Creates a new delivery aborted exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientDeliveryAbortedException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new delivery aborted exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientDeliveryAbortedException(String message, Throwable cause) {
         super(message, cause);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientDeliveryIsPartialException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientDeliveryIsPartialException.java
index b33b081..dc19245 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientDeliveryIsPartialException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientDeliveryIsPartialException.java
@@ -24,10 +24,24 @@ public class ClientDeliveryIsPartialException extends ClientIllegalStateExceptio
 
     private static final long serialVersionUID = 3354944204399500545L;
 
+    /**
+     * Creates a new delivery is partial exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientDeliveryIsPartialException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new delivery is partial exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientDeliveryIsPartialException(String message, Throwable cause) {
         super(message, cause);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientDeliveryStateException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientDeliveryStateException.java
index b4f17f8..621f4f2 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientDeliveryStateException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientDeliveryStateException.java
@@ -34,11 +34,29 @@ public class ClientDeliveryStateException extends ClientIllegalStateException {
 
     private final DeliveryState outcome;
 
+    /**
+     * Create a new instance of the client delivery state error.
+     *
+     * @param message
+     * 		The message that describes the cause of the error.
+     * @param outcome
+     * 		The {@link DeliveryState} that caused the error.
+     */
     public ClientDeliveryStateException(String message, DeliveryState outcome) {
         super(message);
         this.outcome = outcome;
     }
 
+    /**
+     * Create a new instance of the client delivery state error.
+     *
+     * @param message
+     * 		The message that describes the cause of the error.
+     * @param cause
+     * 		The exception that initially triggered this error.
+     * @param outcome
+     * 		The {@link DeliveryState} that caused the error.
+     */
     public ClientDeliveryStateException(String message, Throwable cause, DeliveryState outcome) {
         super(message, cause);
         this.outcome = outcome;
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientException.java
index 68ab958..06f901d 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientException.java
@@ -29,10 +29,24 @@ public class ClientException extends Exception {
 
     private static final long serialVersionUID = -5094579928657311571L;
 
+    /**
+     * Creates a new client exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new client exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientException(String message, Throwable cause) {
         super(message, cause);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientIOException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientIOException.java
index 2ff9b07..68cf099 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientIOException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientIOException.java
@@ -23,10 +23,24 @@ public class ClientIOException extends ClientException {
 
     private static final long serialVersionUID = 7022573614211991693L;
 
+    /**
+     * Creates a new connection I/O exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientIOException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new connection I/O exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientIOException(String message, Throwable cause) {
         super(message, cause);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientIdleTimeoutException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientIdleTimeoutException.java
index fae0fd4..2525ea0 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientIdleTimeoutException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientIdleTimeoutException.java
@@ -23,10 +23,24 @@ public class ClientIdleTimeoutException extends ClientIOException {
 
     private static final long serialVersionUID = 7925210908123213499L;
 
+    /**
+     * Creates a new connection idle timeout exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientIdleTimeoutException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new connection idle timeout exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientIdleTimeoutException(String message, Throwable cause) {
         super(message, cause);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientIllegalStateException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientIllegalStateException.java
index aff59d2..7abdc6d 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientIllegalStateException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientIllegalStateException.java
@@ -20,10 +20,24 @@ public class ClientIllegalStateException extends ClientException {
 
     private static final long serialVersionUID = -2188225056209312580L;
 
+    /**
+     * Creates a new connection illegal state exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientIllegalStateException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new connection illegal state exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientIllegalStateException(String message, Throwable cause) {
         super(message, cause);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientLinkRedirectedException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientLinkRedirectedException.java
index 5c49fc6..cd63f4f 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientLinkRedirectedException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientLinkRedirectedException.java
@@ -39,6 +39,16 @@ public class ClientLinkRedirectedException extends ClientLinkRemotelyClosedExcep
 
     private final ClientRedirect redirect;
 
+    /**
+     * Create a new instance of the link redirected exception
+     * 
+     * @param reason
+     * 		The reason for the link redirect
+     * @param redirect
+     * 		A ClientRedirect object with redirection information.
+     * @param condition
+     * 		The error condition that was provided from the remote peer.
+     */
     public ClientLinkRedirectedException(String reason, ClientRedirect redirect, ErrorCondition condition) {
         super(reason, condition);
 
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientLinkRemotelyClosedException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientLinkRemotelyClosedException.java
index 73b34a6..a53f3d9 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientLinkRemotelyClosedException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientLinkRemotelyClosedException.java
@@ -28,18 +28,50 @@ public class ClientLinkRemotelyClosedException extends ClientResourceRemotelyClo
 
     private static final long serialVersionUID = 5601827103553513599L;
 
+    /**
+     * Creates a new link remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     */
     public ClientLinkRemotelyClosedException(String message) {
         this(message, (ErrorCondition) null);
     }
 
+    /**
+     * Creates a new link remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     * @param cause
+     * 		An exception that further defines the remote close reason.
+     */
     public ClientLinkRemotelyClosedException(String message, Throwable cause) {
         this(message, cause, null);
     }
 
+    /**
+     * Creates a new link remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     * @param condition
+     * 		An {@link ErrorCondition} that provides additional information about the close reason.
+     */
     public ClientLinkRemotelyClosedException(String message, ErrorCondition condition) {
         super(message, condition);
     }
 
+    /**
+     * Creates a new link remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     * @param cause
+     * 		An exception that further defines the remote close reason.
+     * @param condition
+     * 		An {@link ErrorCondition} that provides additional information about the close reason.
+     */
     public ClientLinkRemotelyClosedException(String message, Throwable cause, ErrorCondition condition) {
         super(message, cause, condition);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientMessageFormatViolationException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientMessageFormatViolationException.java
index 1969637..343d7b3 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientMessageFormatViolationException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientMessageFormatViolationException.java
@@ -26,10 +26,24 @@ public class ClientMessageFormatViolationException extends ClientException {
 
     private static final long serialVersionUID = -7731216779946825581L;
 
+    /**
+     * Creates a new connection message format violation exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientMessageFormatViolationException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new connection message format violation exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientMessageFormatViolationException(String message, Throwable cause) {
         super(message, cause);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientOperationTimedOutException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientOperationTimedOutException.java
index 8daf89e..81260a6 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientOperationTimedOutException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientOperationTimedOutException.java
@@ -23,10 +23,24 @@ public class ClientOperationTimedOutException extends ClientException {
 
     private static final long serialVersionUID = 4182665270566847828L;
 
+    /**
+     * Creates a new connection operation timed out exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientOperationTimedOutException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new connection operation timed out exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientOperationTimedOutException(String message, Throwable cause) {
         super(message, cause);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientResourceRemotelyClosedException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientResourceRemotelyClosedException.java
index 5e91b16..734561d 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientResourceRemotelyClosedException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientResourceRemotelyClosedException.java
@@ -31,19 +31,51 @@ public class ClientResourceRemotelyClosedException extends ClientIllegalStateExc
 
     private final ErrorCondition condition;
 
+    /**
+     * Creates a new resource remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     */
     public ClientResourceRemotelyClosedException(String message) {
         this(message, (ErrorCondition) null);
     }
 
+    /**
+     * Creates a new resource remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     * @param cause
+     * 		An exception that further defines the remote close reason.
+     */
     public ClientResourceRemotelyClosedException(String message, Throwable cause) {
         this(message, cause, null);
     }
 
+    /**
+     * Creates a new resource remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     * @param condition
+     * 		An {@link ErrorCondition} that provides additional information about the close reason.
+     */
     public ClientResourceRemotelyClosedException(String message, ErrorCondition condition) {
         super(message);
         this.condition = condition;
     }
 
+    /**
+     * Creates a new resource remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     * @param cause
+     * 		An exception that further defines the remote close reason.
+     * @param condition
+     * 		An {@link ErrorCondition} that provides additional information about the close reason.
+     */
     public ClientResourceRemotelyClosedException(String message, Throwable cause, ErrorCondition condition) {
         super(message, cause);
         this.condition = condition;
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientSendTimedOutException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientSendTimedOutException.java
index bfeb84b..9de4a23 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientSendTimedOutException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientSendTimedOutException.java
@@ -23,6 +23,12 @@ public class ClientSendTimedOutException extends ClientOperationTimedOutExceptio
 
     private static final long serialVersionUID = 222325890763309867L;
 
+    /**
+     * Creates a new connection send timed out exception.
+     *
+     * @param reason
+     * 		The message that describes the reason for the error.
+     */
     public ClientSendTimedOutException(String reason) {
         super(reason);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientSessionRemotelyClosedException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientSessionRemotelyClosedException.java
index 01688a3..e8f741c 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientSessionRemotelyClosedException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientSessionRemotelyClosedException.java
@@ -26,18 +26,50 @@ public class ClientSessionRemotelyClosedException extends ClientResourceRemotely
 
     private static final long serialVersionUID = 5601827103553513599L;
 
+    /**
+     * Creates a new session remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     */
     public ClientSessionRemotelyClosedException(String message) {
         this(message, (ErrorCondition) null);
     }
 
+    /**
+     * Creates a new session remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     * @param cause
+     * 		An exception that further defines the remote close reason.
+     */
     public ClientSessionRemotelyClosedException(String message, Throwable cause) {
         this(message, cause, null);
     }
 
+    /**
+     * Creates a new session remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     * @param condition
+     * 		An {@link ErrorCondition} that provides additional information about the close reason.
+     */
     public ClientSessionRemotelyClosedException(String message, ErrorCondition condition) {
         super(message, condition);
     }
 
+    /**
+     * Creates a new session remotely closed exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the remote closure.
+     * @param cause
+     * 		An exception that further defines the remote close reason.
+     * @param condition
+     * 		An {@link ErrorCondition} that provides additional information about the close reason.
+     */
     public ClientSessionRemotelyClosedException(String message, Throwable cause, ErrorCondition condition) {
         super(message, cause, condition);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionDeclarationException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionDeclarationException.java
index 2d01e3f..7be9dfd 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionDeclarationException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionDeclarationException.java
@@ -23,10 +23,24 @@ public class ClientTransactionDeclarationException extends ClientIllegalStateExc
 
     private static final long serialVersionUID = -5532644122754198664L;
 
+    /**
+     * Creates a new transaction declaration exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientTransactionDeclarationException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new transaction declaration exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientTransactionDeclarationException(String message, Throwable cause) {
         super(message, cause);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionInDoubtException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionInDoubtException.java
index a55e6b0..f76b62d 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionInDoubtException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionInDoubtException.java
@@ -23,10 +23,24 @@ public class ClientTransactionInDoubtException extends ClientIllegalStateExcepti
 
     private static final long serialVersionUID = -5532644122754198664L;
 
+    /**
+     * Creates a new transaction in doubt exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientTransactionInDoubtException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new transaction in doubt exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientTransactionInDoubtException(String message, Throwable cause) {
         super(message, cause);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionNotActiveException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionNotActiveException.java
index 95067c9..5a0757c 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionNotActiveException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionNotActiveException.java
@@ -23,10 +23,24 @@ public class ClientTransactionNotActiveException extends ClientIllegalStateExcep
 
     private static final long serialVersionUID = 7854401747821768051L;
 
+    /**
+     * Creates a new transaction not active exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientTransactionNotActiveException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new transaction not active exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientTransactionNotActiveException(String message, Throwable cause) {
         super(message, cause);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionRolledBackException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionRolledBackException.java
index d876dbc..193961e 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionRolledBackException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientTransactionRolledBackException.java
@@ -23,10 +23,24 @@ public class ClientTransactionRolledBackException extends ClientIllegalStateExce
 
     private static final long serialVersionUID = 222325890763309867L;
 
+    /**
+     * Creates a new transaction rolled back exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientTransactionRolledBackException(String message) {
         super(message, null);
     }
 
+    /**
+     * Creates a new transaction rolled back exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientTransactionRolledBackException(String message, Throwable cause) {
         super(message, cause);
     }
diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientUnsupportedOperationException.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientUnsupportedOperationException.java
index 3d5206e..ae4a2f1 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientUnsupportedOperationException.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/exceptions/ClientUnsupportedOperationException.java
@@ -23,10 +23,24 @@ public class ClientUnsupportedOperationException extends ClientIllegalStateExcep
 
     private static final long serialVersionUID = -680156277783719903L;
 
+    /**
+     * Creates a new unsupported operation exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     */
     public ClientUnsupportedOperationException(String message) {
         super(message);
     }
 
+    /**
+     * Creates a new unsupported operation exception.
+     *
+     * @param message
+     * 		The message that describes the reason for the error.
+     * @param cause
+     * 		An exception that further defines the reason for the error.
+     */
     public ClientUnsupportedOperationException(String message, Throwable cause) {
         super(message, cause);
     }

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org


[qpid-protonj2] 03/03: PROTON-2394 Fix some spelling errors in configuration constants

Posted by ta...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

tabish pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-protonj2.git

commit aefdefc7762609633a407f2809512f8c55b3f1d6
Author: Timothy Bish <ta...@gmail.com>
AuthorDate: Wed Jun 16 18:04:16 2021 -0400

    PROTON-2394 Fix some spelling errors in configuration constants
---
 .../java/org/apache/qpid/protonj2/client/ReconnectOptions.java    | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ReconnectOptions.java b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ReconnectOptions.java
index 1896bbe..b21edf4 100644
--- a/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ReconnectOptions.java
+++ b/protonj2-client/src/main/java/org/apache/qpid/protonj2/client/ReconnectOptions.java
@@ -28,8 +28,8 @@ public class ReconnectOptions {
     public static final boolean DEFAULT_RECONNECT_ENABLED = false;
     public static final int INFINITE = -1;
     public static final int DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS = 10;
-    public static final int DEFAULT_RECONNECT_DEALY = 10;
-    public static final int DEFAULT_MAX_RECONNECT_DEALY = 30_000;
+    public static final int DEFAULT_RECONNECT_DELAY = 10;
+    public static final int DEFAULT_MAX_RECONNECT_DELAY = 30_000;
     public static final boolean DEFAULT_USE_RECONNECT_BACKOFF = true;
     public static final double DEFAULT_RECONNECT_BACKOFF_MULTIPLIER = 2.0d;
 
@@ -39,8 +39,8 @@ public class ReconnectOptions {
     private int warnAfterReconnectAttempts = DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS;
     private int maxInitialConnectionAttempts = INFINITE;
     private int maxReconnectAttempts = INFINITE;
-    private int reconnectDelay = DEFAULT_RECONNECT_DEALY;
-    private int maxReconnectDelay = DEFAULT_MAX_RECONNECT_DEALY;
+    private int reconnectDelay = DEFAULT_RECONNECT_DELAY;
+    private int maxReconnectDelay = DEFAULT_RECONNECT_DELAY;
     private boolean useReconnectBackOff = DEFAULT_USE_RECONNECT_BACKOFF;
     private double reconnectBackOffMultiplier = DEFAULT_RECONNECT_BACKOFF_MULTIPLIER;
 

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org