You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by lg...@apache.org on 2019/07/31 04:45:01 UTC
[mina-sshd] 01/02: Fixed Javadoc of some classes
This is an automated email from the ASF dual-hosted git repository.
lgoldstein pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-sshd.git
commit c6ac1aee55fb491c4ebf6ca5a933b70aa655f4e5
Author: Lyor Goldstein <lg...@apache.org>
AuthorDate: Tue Jul 30 10:25:51 2019 +0300
Fixed Javadoc of some classes
---
.../java/org/apache/sshd/common/config/keys/KeyEntryResolver.java | 2 +-
.../java/org/apache/sshd/common/config/keys/PublicKeyEntry.java | 4 ++--
.../apache/sshd/common/config/keys/PublicKeyRawDataDecoder.java | 1 +
.../apache/sshd/common/config/keys/PublicKeyRawDataReader.java | 1 +
.../apache/sshd/common/config/keys/loader/openssh/kdf/BCrypt.java | 8 ++++++++
sshd-core/src/main/java/org/apache/sshd/common/io/IoSession.java | 1 +
.../org/apache/sshd/server/subsystem/sftp/SftpEventListener.java | 2 +-
7 files changed, 15 insertions(+), 4 deletions(-)
diff --git a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/KeyEntryResolver.java b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/KeyEntryResolver.java
index a10322a..b00b3d6 100644
--- a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/KeyEntryResolver.java
+++ b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/KeyEntryResolver.java
@@ -247,7 +247,7 @@ public interface KeyEntryResolver<PUB extends PublicKey, PRV extends PrivateKey>
* @param buf The buffer with the data bytes
* @param offset The offset in the buffer to decode the array
* @param available The max. available data starting from the offset
- * @param maxChars Max. allowed data in decoded buffer - if more than
+ * @param maxAllowed Max. allowed data in decoded buffer - if more than
* that is encoded then an {@link IndexOutOfBoundsException} will be thrown
* @return The decoded data buffer + the offset of the next byte after it
*/
diff --git a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/PublicKeyEntry.java b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/PublicKeyEntry.java
index 1c6dfbd..652ecb4 100644
--- a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/PublicKeyEntry.java
+++ b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/PublicKeyEntry.java
@@ -155,7 +155,7 @@ public class PublicKeyEntry implements Serializable, KeyTypeIndicator {
* @return The {@link PublicKey} or {@code null} if could not resolve it
* @throws IOException If failed to decode/encode the key
* @throws GeneralSecurityException If failed to generate the key
- * @see #resolvePublicKey(SessionContext, PublicKeyEntryResolver)
+ * @see #resolvePublicKey(SessionContext, Map, PublicKeyEntryResolver)
*/
public PublicKey appendPublicKey(
SessionContext session, Appendable sb, PublicKeyEntryResolver fallbackResolver)
@@ -216,7 +216,7 @@ public class PublicKeyEntry implements Serializable, KeyTypeIndicator {
* @throws IOException If failed to decode the key data
* @throws GeneralSecurityException If failed to generate the {@link PublicKey}
* from the decoded data
- * @see #resolvePublicKey(SessionContext, PublicKeyEntryResolver)
+ * @see #resolvePublicKey(SessionContext, Map, PublicKeyEntryResolver)
*/
public static List<PublicKey> resolvePublicKeyEntries(
SessionContext session, Collection<? extends PublicKeyEntry> entries, PublicKeyEntryResolver fallbackResolver)
diff --git a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/PublicKeyRawDataDecoder.java b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/PublicKeyRawDataDecoder.java
index d1e345b..81ceefa 100644
--- a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/PublicKeyRawDataDecoder.java
+++ b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/PublicKeyRawDataDecoder.java
@@ -30,6 +30,7 @@ import org.apache.sshd.common.session.SessionContext;
import org.apache.sshd.common.util.NumberUtils;
/**
+ * @param <PUB> Generic {@link PublicKey} type
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public interface PublicKeyRawDataDecoder<PUB extends PublicKey> {
diff --git a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/PublicKeyRawDataReader.java b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/PublicKeyRawDataReader.java
index 3567439..2836ab2 100644
--- a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/PublicKeyRawDataReader.java
+++ b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/PublicKeyRawDataReader.java
@@ -42,6 +42,7 @@ import org.apache.sshd.common.util.io.resource.PathResource;
import org.apache.sshd.common.util.io.resource.URLResource;
/**
+ * @param <PUB> The generic {@link PublicKey} type
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public interface PublicKeyRawDataReader<PUB extends PublicKey> {
diff --git a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/loader/openssh/kdf/BCrypt.java b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/loader/openssh/kdf/BCrypt.java
index 28a773c..bd430c1 100644
--- a/sshd-common/src/main/java/org/apache/sshd/common/config/keys/loader/openssh/kdf/BCrypt.java
+++ b/sshd-common/src/main/java/org/apache/sshd/common/config/keys/loader/openssh/kdf/BCrypt.java
@@ -614,6 +614,9 @@ public class BCrypt {
/**
* Compatibility with new OpenBSD function.
+ * @param hpass The hash password bytes
+ * @param hsalt The hash salt bytes
+ * @param output Target hash output buffer
*/
public void hash(byte[] hpass, byte[] hsalt, byte[] output) {
init_key();
@@ -642,6 +645,11 @@ public class BCrypt {
/**
* Compatibility with new OpenBSD function.
+ *
+ * @param password The password bytes
+ * @param salt The salt bytes
+ * @param rounds Number of hash rounds
+ * @param output Hash output buffer
*/
public void pbkdf(byte[] password, byte[] salt, int rounds, byte[] output) {
try {
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/io/IoSession.java b/sshd-core/src/main/java/org/apache/sshd/common/io/IoSession.java
index 6046541..9e6dcfc 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/io/IoSession.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/io/IoSession.java
@@ -88,6 +88,7 @@ public interface IoSession extends ConnectionEndpointsIndicator, PacketWriter, C
/**
* Handle received EOF.
+ * @throws IOException If failed to shutdown the stream
*/
void shudownOutputStream() throws IOException;
}
diff --git a/sshd-sftp/src/main/java/org/apache/sshd/server/subsystem/sftp/SftpEventListener.java b/sshd-sftp/src/main/java/org/apache/sshd/server/subsystem/sftp/SftpEventListener.java
index 8c2b3da..27528c3 100644
--- a/sshd-sftp/src/main/java/org/apache/sshd/server/subsystem/sftp/SftpEventListener.java
+++ b/sshd-sftp/src/main/java/org/apache/sshd/server/subsystem/sftp/SftpEventListener.java
@@ -376,7 +376,7 @@ public interface SftpEventListener extends SshdEventListener {
* @param path The {@link Path} about to be removed
* @param isDirectory Whether this is a folder or a file
* @throws IOException If failed to handle the call
- * @see #removedFile(ServerSession, Path, Throwable)
+ * @see #removed(ServerSession, Path, boolean, Throwable)
*/
default void removing(ServerSession session, Path path, boolean isDirectory) throws IOException {
// ignored