This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-sshd.git
The following commit(s) were added to refs/heads/master by this push:
new f537f68f9 Fix Javadoc and add missing Javadoc
f537f68f9 is described below
commit f537f68f99d133eca892a1d2b213fcc895a45173
Author: Gary Gregory <[email protected]>
AuthorDate: Thu Jul 6 11:12:20 2023 -0400
Fix Javadoc and add missing Javadoc
---
.../org/apache/sshd/client/config/hosts/HostConfigEntry.java | 2 ++
.../java/org/apache/sshd/common/util/io/FileSnapshot.java | 3 ++-
.../java/org/apache/sshd/common/channel/LocalWindow.java | 2 --
.../org/apache/sshd/common/future/GlobalRequestFuture.java | 4 ++--
.../common/session/helpers/KeyExchangeMessageHandler.java | 2 +-
.../src/test/java/org/apache/sshd/util/test/JSchUtils.java | 4 ++--
.../java/org/apache/sshd/sftp/client/fs/SftpFileSystem.java | 4 ++--
.../org/apache/sshd/sftp/client/impl/AbstractSftpClient.java | 12 ++++++------
.../org/apache/sshd/sftp/server/SftpFileSystemAccessor.java | 1 +
9 files changed, 18 insertions(+), 16 deletions(-)
diff --git
a/sshd-common/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java
b/sshd-common/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java
index 23fe39d5c..bd65e437b 100644
---
a/sshd-common/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java
+++
b/sshd-common/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java
@@ -164,6 +164,8 @@ public class HostConfigEntry extends HostPatternsHolder
implements MutableUserHo
/**
* Merges that into this via underride. That is, any value present in this
entry takes precedence over the given
* entry. Only this object is modified. The given entry remains unchanged.
+ *
+ * @param that The HostConfigEntry to merge.
*/
public void collate(HostConfigEntry that) {
if (hostName == null || hostName.isEmpty()) {
diff --git
a/sshd-common/src/main/java/org/apache/sshd/common/util/io/FileSnapshot.java
b/sshd-common/src/main/java/org/apache/sshd/common/util/io/FileSnapshot.java
index 1c0abba62..29ec35d32 100644
--- a/sshd-common/src/main/java/org/apache/sshd/common/util/io/FileSnapshot.java
+++ b/sshd-common/src/main/java/org/apache/sshd/common/util/io/FileSnapshot.java
@@ -86,7 +86,6 @@ public class FileSnapshot {
* @param lastModified the "last modified" {@link FileTime}
* @param size the file size
* @param fileKey the file key
- * @return the {@link FileSnapshot}, never {@code null}
*/
protected FileSnapshot(Instant snapTime, FileTime lastModified, long size,
Object fileKey) {
this.snapTime = Objects.requireNonNull(snapTime);
@@ -137,6 +136,7 @@ public class FileSnapshot {
* @param file to take the snapshot of
* @param options {@link LinkOption}s to use
* @return the {@link FileSnapshot}, never {@code null}
+ * @throws IOException if an I/O error occurs
*/
public static FileSnapshot save(Path file, LinkOption... options) throws
IOException {
BasicFileAttributes attributes = null;
@@ -159,6 +159,7 @@ public class FileSnapshot {
* @param options {@link LinkOption}s to use
* @return a {@link FileSnapshot}, never {@code null}; if {@code
== this}, the file may be assumed
* unmodified
+ * @throws IOException if an I/O error occurs
*/
public FileSnapshot reload(Path file, LinkOption... options) throws
IOException {
FileSnapshot newSnapshot = save(file, options);
diff --git
a/sshd-core/src/main/java/org/apache/sshd/common/channel/LocalWindow.java
b/sshd-core/src/main/java/org/apache/sshd/common/channel/LocalWindow.java
index 90561e386..8e52bb633 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/channel/LocalWindow.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/channel/LocalWindow.java
@@ -56,8 +56,6 @@ public class LocalWindow extends Window {
/**
* Initializes the {@link LocalWindow} with the packet and window sizes
from the {@code resolver}.
*
- * @param size the initial window size
- * @param packetSize the peer's advertised maximum packet size
* @param resolver {@PropertyResolver} to access properties
*/
public void init(PropertyResolver resolver) {
diff --git
a/sshd-core/src/main/java/org/apache/sshd/common/future/GlobalRequestFuture.java
b/sshd-core/src/main/java/org/apache/sshd/common/future/GlobalRequestFuture.java
index 837224e8f..473ff650a 100644
---
a/sshd-core/src/main/java/org/apache/sshd/common/future/GlobalRequestFuture.java
+++
b/sshd-core/src/main/java/org/apache/sshd/common/future/GlobalRequestFuture.java
@@ -27,7 +27,7 @@ import org.apache.sshd.common.util.buffer.Buffer;
* A {@link DefaultSshFuture} that can be used to wait for the reply of an
SSH_MSG_GLOBAL_REQUEST sent with
* {@code want-reply = true}.
*
- * @see {@link org.apache.sshd.common.session.Session#request(Buffer, String,
ReplyHandler)}
+ * @see org.apache.sshd.common.session.Session#request(Buffer, String,
ReplyHandler)
*/
public class GlobalRequestFuture extends DefaultSshFuture<GlobalRequestFuture>
implements SshFutureListener<IoWriteFuture> {
@@ -35,7 +35,7 @@ public class GlobalRequestFuture extends
DefaultSshFuture<GlobalRequestFuture>
/**
* A {@code ReplyHandler} is invoked asynchronously when the reply for a
request with {@code want-reply = true} is
* received. It is <em>not</em> invoked if the request could not be sent;
to catch such cases
- * {@link DefaultSshFuture#await()} the {@link GlobalRequestFuture} and
check
+ * {@link DefaultSshFuture#await(CancelOption[])} the {@link
GlobalRequestFuture} and check
* {@link GlobalRequestFuture#getException()}.
*/
@FunctionalInterface
diff --git
a/sshd-core/src/main/java/org/apache/sshd/common/session/helpers/KeyExchangeMessageHandler.java
b/sshd-core/src/main/java/org/apache/sshd/common/session/helpers/KeyExchangeMessageHandler.java
index 11501ef77..3f7280de6 100644
---
a/sshd-core/src/main/java/org/apache/sshd/common/session/helpers/KeyExchangeMessageHandler.java
+++
b/sshd-core/src/main/java/org/apache/sshd/common/session/helpers/KeyExchangeMessageHandler.java
@@ -81,7 +81,7 @@ public class KeyExchangeMessageHandler {
/**
* An {@link ExecutorService} used to flush the queue asynchronously.
*
- * @see {@link #flushQueue(DefaultKeyExchangeFuture)}
+ * @see #flushQueue(DefaultKeyExchangeFuture)
*/
protected final ExecutorService flushRunner =
Executors.newSingleThreadExecutor();
diff --git a/sshd-core/src/test/java/org/apache/sshd/util/test/JSchUtils.java
b/sshd-core/src/test/java/org/apache/sshd/util/test/JSchUtils.java
index 4906a1abe..c09bb9105 100644
--- a/sshd-core/src/test/java/org/apache/sshd/util/test/JSchUtils.java
+++ b/sshd-core/src/test/java/org/apache/sshd/util/test/JSchUtils.java
@@ -68,7 +68,7 @@ public final class JSchUtils {
}
/**
- * Wraps {@link Session#setPortForwardingR(String, int, String, int) to
avoid that JSch's abuse of
+ * Wraps {@link Session#setPortForwardingR(String, int, String, int)} to
avoid that JSch's abuse of
* {@link Thread#interrupt()} leaks into client code.
*
* @param session JSch {@link Session} to request the port forwarding
on
@@ -82,7 +82,7 @@ public final class JSchUtils {
}
/**
- * Wraps {@link Session#setPortForwardingR(int, String, int) to avoid that
JSch's abuse of
+ * Wraps {@link Session#setPortForwardingR(int, String, int)} to avoid
that JSch's abuse of
* {@link Thread#interrupt()} leaks into client code.
*
* @param session JSch {@link Session} to request the port forwarding
on
diff --git
a/sshd-sftp/src/main/java/org/apache/sshd/sftp/client/fs/SftpFileSystem.java
b/sshd-sftp/src/main/java/org/apache/sshd/sftp/client/fs/SftpFileSystem.java
index a4bd87bec..5a347e5f1 100644
--- a/sshd-sftp/src/main/java/org/apache/sshd/sftp/client/fs/SftpFileSystem.java
+++ b/sshd-sftp/src/main/java/org/apache/sshd/sftp/client/fs/SftpFileSystem.java
@@ -80,7 +80,7 @@ public class SftpFileSystem
/**
* An {@link AttributeKey} that can be set to {@link Boolean#TRUE} on the
{@link ClientSession} to tell the
- * {@link SftpFileSystem} that it owns that session and should close it
when the {@link SftpFileSeystem} itself is
+ * {@link SftpFileSystem} that it owns that session and should close it
when the {@link SftpFileSystem} itself is
* closed.
*/
public static final AttributeKey<Boolean> OWNED_SESSION = new
AttributeKey<>();
@@ -804,7 +804,7 @@ public class SftpFileSystem
}
/**
- * The {@link SftpClientPool} stores {@link SftpClient)s not directly but
via handles in its channel pool. HAndles
+ * The {@link SftpClientPool} stores {@link SftpClient}s not directly but
via handles in its channel pool. HAndles
* remove themselves from the pool
*/
protected static class SftpClientHandle implements ChannelListener {
diff --git
a/sshd-sftp/src/main/java/org/apache/sshd/sftp/client/impl/AbstractSftpClient.java
b/sshd-sftp/src/main/java/org/apache/sshd/sftp/client/impl/AbstractSftpClient.java
index 2c3b8ea7f..1c7b24cf6 100644
---
a/sshd-sftp/src/main/java/org/apache/sshd/sftp/client/impl/AbstractSftpClient.java
+++
b/sshd-sftp/src/main/java/org/apache/sshd/sftp/client/impl/AbstractSftpClient.java
@@ -212,14 +212,14 @@ public abstract class AbstractSftpClient
}
/**
- * Sends the specified command, waits for the response and then invokes
{@link #checkResponseStatus(int, Buffer)}
+ * Sends the specified command, waits for the response and then invokes
{@link #checkResponseStatus(SftpResponse)}
*
* @param cmd The command to send
* @param request The request {@link Buffer}
* @throws IOException If failed to send, receive or check the returned
status
* @see #send(int, Buffer)
* @see #receive(int)
- * @see #checkResponseStatus(int, Buffer)
+ * @see #checkResponseStatus(SftpResponse)
*/
protected void checkCommandStatus(int cmd, Buffer request) throws
IOException {
checkResponseStatus(rpc(cmd, request));
@@ -231,7 +231,7 @@ public abstract class AbstractSftpClient
*
* @param response The received {@link SftpResponse}
* @throws IOException If response does not carry a status or carries a
bad status code
- * @see #checkResponseStatus(int, int, int, String, String)
+ * @see #checkResponseStatus(int, int, SftpStatus)
*/
protected void checkResponseStatus(SftpResponse response) throws
IOException {
if (response.getType() == SftpConstants.SSH_FXP_STATUS) {
@@ -276,7 +276,7 @@ public abstract class AbstractSftpClient
* @throws IOException If failed to send/receive or process the response
* @see #send(int, Buffer)
* @see #receive(int)
- * @see #checkHandleResponse(int, Buffer)
+ * @see #checkHandleResponse(SftpResponse)
*/
protected byte[] checkHandle(int cmd, Buffer request) throws IOException {
return checkHandleResponse(rpc(cmd, request));
@@ -311,7 +311,7 @@ public abstract class AbstractSftpClient
* @throws IOException If failed to send/receive or process the response
* @see #send(int, Buffer)
* @see #receive(int)
- * @see #checkAttributesResponse(int, Buffer)
+ * @see #checkAttributesResponse(SftpResponse)
*/
protected Attributes checkAttributes(int cmd, Buffer request) throws
IOException {
return checkAttributesResponse(rpc(cmd, request));
@@ -345,7 +345,7 @@ public abstract class AbstractSftpClient
* @throws IOException If failed to send/receive or process the response
* @see #send(int, Buffer)
* @see #receive(int)
- * @see #checkOneNameResponse(int, Buffer)
+ * @see #checkOneNameResponse(SftpResponse)
*/
protected String checkOneName(int cmd, Buffer request) throws IOException {
return checkOneNameResponse(rpc(cmd, request));
diff --git
a/sshd-sftp/src/main/java/org/apache/sshd/sftp/server/SftpFileSystemAccessor.java
b/sshd-sftp/src/main/java/org/apache/sshd/sftp/server/SftpFileSystemAccessor.java
index 2f6ab0553..f55cb3771 100644
---
a/sshd-sftp/src/main/java/org/apache/sshd/sftp/server/SftpFileSystemAccessor.java
+++
b/sshd-sftp/src/main/java/org/apache/sshd/sftp/server/SftpFileSystemAccessor.java
@@ -313,6 +313,7 @@ public interface SftpFileSystemAccessor {
* @param dir The requested <U>local</U> directory {@link Path} -
same one returned by
* {@link #resolveLocalFilePath(SftpSubsystemProxy,
Path, String) resolveLocalFilePath}
* @param handle The assigned directory handle through which the
remote peer references this directory
+ * @param linkOptions The {@link LinkOption}s - OK if {@code null}/empty.
* @return The opened {@link DirectoryStream}
* @throws IOException If failed to open
*/
