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 2015/10/21 09:03:32 UTC
[1/2] mina-sshd git commit: Updated some missing / malformed Javadoc
tags
Repository: mina-sshd
Updated Branches:
refs/heads/master 2f95f7b9d -> e1b8bc40c
Updated some missing / malformed Javadoc tags
Project: http://git-wip-us.apache.org/repos/asf/mina-sshd/repo
Commit: http://git-wip-us.apache.org/repos/asf/mina-sshd/commit/d9f51085
Tree: http://git-wip-us.apache.org/repos/asf/mina-sshd/tree/d9f51085
Diff: http://git-wip-us.apache.org/repos/asf/mina-sshd/diff/d9f51085
Branch: refs/heads/master
Commit: d9f51085cc13e7ccc770e89f9c0387f7381c1f07
Parents: 2f95f7b
Author: Lyor Goldstein <lg...@vmware.com>
Authored: Wed Oct 21 09:46:24 2015 +0300
Committer: Lyor Goldstein <lg...@vmware.com>
Committed: Wed Oct 21 09:46:24 2015 +0300
----------------------------------------------------------------------
pom.xml | 13 +++++++++++++
.../sshd/client/config/hosts/HostConfigEntry.java | 8 ++++----
.../sshd/client/session/ClientSessionCreator.java | 2 +-
.../main/java/org/apache/sshd/common/BaseBuilder.java | 2 ++
.../common/auth/AbstractUserAuthMethodFactory.java | 1 +
.../sshd/common/channel/AbstractRequestHandler.java | 1 +
.../apache/sshd/common/channel/RequestHandler.java | 7 ++++---
.../sshd/common/config/FactoriesListParseResult.java | 2 ++
.../apache/sshd/common/config/ListParseResult.java | 1 +
.../common/config/NamedFactoriesListParseResult.java | 2 ++
.../common/config/NamedResourceListParseResult.java | 1 +
.../config/keys/AbstractPublicKeyEntryDecoder.java | 4 ++++
.../common/config/keys/PublicKeyEntryDecoder.java | 2 ++
.../apache/sshd/common/future/AbstractSshFuture.java | 1 +
.../apache/sshd/common/future/DefaultSshFuture.java | 1 +
.../common/future/DefaultVerifiableSshFuture.java | 1 +
.../java/org/apache/sshd/common/future/SshFuture.java | 1 +
.../apache/sshd/common/future/SshFutureListener.java | 1 +
.../apache/sshd/common/future/VerifiableFuture.java | 1 +
.../sshd/common/io/nio2/Nio2CompletionHandler.java | 3 +++
.../keyprovider/AbstractResourceKeyPairProvider.java | 1 +
.../sshd/common/session/AbstractSessionFactory.java | 2 ++
.../subsystem/sftp/extensions/AbstractParser.java | 1 +
.../subsystem/sftp/extensions/ExtensionParser.java | 1 +
.../org/apache/sshd/common/util/ObjectBuilder.java | 1 +
.../main/java/org/apache/sshd/common/util/Pair.java | 14 ++++++++------
.../java/org/apache/sshd/common/util/Predicate.java | 1 +
.../java/org/apache/sshd/common/util/Transformer.java | 2 ++
.../sshd/common/util/closeable/FuturesCloseable.java | 1 +
.../apache/sshd/common/util/io/FileInfoExtractor.java | 5 +++--
.../test/java/org/apache/sshd/server/ServerTest.java | 2 +-
.../sshd/server/channel/ChannelSessionTest.java | 2 +-
.../org/apache/sshd/util/test/BaseTestSupport.java | 2 +-
.../org/apache/sshd/git/transport/GitSshdSession.java | 2 +-
34 files changed, 72 insertions(+), 20 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 9ccb397..f38108b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -370,6 +370,19 @@
<execute />
</action>
</pluginExecution>
+ <pluginExecution>
+ <pluginExecutionFilter>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-bundle-plugin</artifactId>
+ <versionRange>[1.0,)</versionRange>
+ <goals>
+ <goal>manifest</goal>
+ </goals>
+ </pluginExecutionFilter>
+ <action>
+ <execute />
+ </action>
+ </pluginExecution>
</pluginExecutions>
</lifecycleMappingMetadata>
</configuration>
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java b/sshd-core/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java
index 7593ae8..7485d4e 100644
--- a/sshd-core/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java
+++ b/sshd-core/src/main/java/org/apache/sshd/client/config/hosts/HostConfigEntry.java
@@ -248,7 +248,7 @@ public class HostConfigEntry implements Cloneable, UsernameHolder {
}
/**
- * @param path A {@link File{ that contains an identity key - never {@code null}
+ * @param file A {@link File} that contains an identity key - never {@code null}
*/
public void addIdentity(File file) {
addIdentity(ValidateUtils.checkNotNull(file, "No file").toPath());
@@ -265,7 +265,7 @@ public class HostConfigEntry implements Cloneable, UsernameHolder {
/**
* Adds a path to an identity file
*
- * @param id The identity path to add - never {@code null{
+ * @param id The identity path to add - never {@code null}
*/
public void addIdentity(String id) {
String path = ValidateUtils.checkNotNullAndNotEmpty(id, "No identity provided");
@@ -302,7 +302,7 @@ public class HostConfigEntry implements Cloneable, UsernameHolder {
/**
* @param name Property name - never {@code null}/empty
- * @param value Property value - {@code null} if no such property
+ * @return Property value or {@code null} if no such property
* @see #getProperty(String, String)
*/
public String getProperty(String name) {
@@ -413,7 +413,7 @@ public class HostConfigEntry implements Cloneable, UsernameHolder {
}
/**
- * @param name The global user name - ignored if {@code null}/empty or
+ * @param user The global user name - ignored if {@code null}/empty or
* already have a configured user
* @return {@code true} if updated the username
*/
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/client/session/ClientSessionCreator.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/client/session/ClientSessionCreator.java b/sshd-core/src/main/java/org/apache/sshd/client/session/ClientSessionCreator.java
index 4a07512..c3d46e5 100644
--- a/sshd-core/src/main/java/org/apache/sshd/client/session/ClientSessionCreator.java
+++ b/sshd-core/src/main/java/org/apache/sshd/client/session/ClientSessionCreator.java
@@ -45,7 +45,7 @@ public interface ClientSessionCreator {
* Resolves the <U>effective</U> {@link HostConfigEntry} and connects to it
*
* @param username The intended username
- * @param address The intended {@link SocketAddress] - never {@code null}. If
+ * @param address The intended {@link SocketAddress} - never {@code null}. If
* this is an {@link java.net.InetSocketAddress} then the <U>effective</U> {@link HostConfigEntry}
* is resolved and used.
* @return A {@link ConnectFuture}
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/BaseBuilder.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/BaseBuilder.java b/sshd-core/src/main/java/org/apache/sshd/common/BaseBuilder.java
index 2851149..a47f6e5 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/BaseBuilder.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/BaseBuilder.java
@@ -50,6 +50,8 @@ import org.apache.sshd.server.forward.RejectAllForwardingFilter;
/**
* Base class for dedicated client/server instance builders
*
+ * @param <T> Type of {@link AbstractFactoryManager} being built
+ * @param <S> Type of builder
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public class BaseBuilder<T extends AbstractFactoryManager, S extends BaseBuilder<T, S>> implements ObjectBuilder<T> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/auth/AbstractUserAuthMethodFactory.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/auth/AbstractUserAuthMethodFactory.java b/sshd-core/src/main/java/org/apache/sshd/common/auth/AbstractUserAuthMethodFactory.java
index 25c4b94..cb9cefe 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/auth/AbstractUserAuthMethodFactory.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/auth/AbstractUserAuthMethodFactory.java
@@ -23,6 +23,7 @@ import org.apache.sshd.common.util.ValidateUtils;
import org.apache.sshd.common.util.logging.AbstractLoggingBean;
/**
+ * @param <M> Type of user authentication method
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class AbstractUserAuthMethodFactory<M> extends AbstractLoggingBean implements UserAuthMethodFactory<M> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/channel/AbstractRequestHandler.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/channel/AbstractRequestHandler.java b/sshd-core/src/main/java/org/apache/sshd/common/channel/AbstractRequestHandler.java
index 25b4415..c7cceef 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/channel/AbstractRequestHandler.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/channel/AbstractRequestHandler.java
@@ -22,6 +22,7 @@ package org.apache.sshd.common.channel;
import org.apache.sshd.common.util.logging.AbstractLoggingBean;
/**
+ * @param <T> Request type
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class AbstractRequestHandler<T> extends AbstractLoggingBean implements RequestHandler<T> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/channel/RequestHandler.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/channel/RequestHandler.java b/sshd-core/src/main/java/org/apache/sshd/common/channel/RequestHandler.java
index 013aee0..7883e7b 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/channel/RequestHandler.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/channel/RequestHandler.java
@@ -28,6 +28,7 @@ import org.apache.sshd.common.util.buffer.Buffer;
/**
* A global request handler.
*
+ * @param <T> Request type
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public interface RequestHandler<T> {
@@ -37,7 +38,7 @@ public interface RequestHandler<T> {
Replied,
ReplySuccess,
ReplyFailure;
-
+
public static final Set<Result> VALUES =
Collections.unmodifiableSet(EnumSet.allOf(Result.class));
@@ -50,13 +51,13 @@ public interface RequestHandler<T> {
if (GenericUtils.isEmpty(name)) {
return null;
}
-
+
for (Result r : VALUES) {
if (name.equalsIgnoreCase(r.name())) {
return r;
}
}
-
+
return null;
}
}
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/config/FactoriesListParseResult.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/config/FactoriesListParseResult.java b/sshd-core/src/main/java/org/apache/sshd/common/config/FactoriesListParseResult.java
index 3d1eb88..7a1cee1 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/config/FactoriesListParseResult.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/config/FactoriesListParseResult.java
@@ -24,6 +24,8 @@ import java.util.List;
import org.apache.sshd.common.Factory;
/**
+ * @param <T> Result type
+ * @param <F> Factory type
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class FactoriesListParseResult<T, F extends Factory<T>> extends ListParseResult<F> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/config/ListParseResult.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/config/ListParseResult.java b/sshd-core/src/main/java/org/apache/sshd/common/config/ListParseResult.java
index d3afc71..97590cb 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/config/ListParseResult.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/config/ListParseResult.java
@@ -30,6 +30,7 @@ import org.apache.sshd.common.util.GenericUtils;
* be un-modifiable, so it is recommended to avoid attempting changing the, returned
* list(s)
*
+ * @param <E> Type of list item
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class ListParseResult<E> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/config/NamedFactoriesListParseResult.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/config/NamedFactoriesListParseResult.java b/sshd-core/src/main/java/org/apache/sshd/common/config/NamedFactoriesListParseResult.java
index af2a188..4031a74 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/config/NamedFactoriesListParseResult.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/config/NamedFactoriesListParseResult.java
@@ -28,6 +28,8 @@ import org.apache.sshd.common.util.GenericUtils;
/**
* Holds the result of parsing a list of {@link NamedFactory}ies
*
+ * @param <T> Result type
+ * @param <F> Factory type
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class NamedFactoriesListParseResult<T, F extends NamedFactory<T>>
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/config/NamedResourceListParseResult.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/config/NamedResourceListParseResult.java b/sshd-core/src/main/java/org/apache/sshd/common/config/NamedResourceListParseResult.java
index 46719f8..3559d64 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/config/NamedResourceListParseResult.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/config/NamedResourceListParseResult.java
@@ -25,6 +25,7 @@ import org.apache.sshd.common.NamedResource;
import org.apache.sshd.common.util.GenericUtils;
/**
+ * @param <R> Type of result {@link NamedResource}
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class NamedResourceListParseResult<R extends NamedResource> extends ListParseResult<R> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/config/keys/AbstractPublicKeyEntryDecoder.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/config/keys/AbstractPublicKeyEntryDecoder.java b/sshd-core/src/main/java/org/apache/sshd/common/config/keys/AbstractPublicKeyEntryDecoder.java
index 77391d5..15d7ae0 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/config/keys/AbstractPublicKeyEntryDecoder.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/config/keys/AbstractPublicKeyEntryDecoder.java
@@ -43,6 +43,10 @@ import org.apache.sshd.common.util.ValidateUtils;
import org.apache.sshd.common.util.io.IoUtils;
/**
+ * Useful base class implementation for a decoder of an {@code OpenSSH} encoded key data
+ *
+ * @param <PUB> Type of {@link PublicKey}
+ * @param <PRV> Type of {@link PrivateKey}
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class AbstractPublicKeyEntryDecoder<PUB extends PublicKey, PRV extends PrivateKey>
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/config/keys/PublicKeyEntryDecoder.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/config/keys/PublicKeyEntryDecoder.java b/sshd-core/src/main/java/org/apache/sshd/common/config/keys/PublicKeyEntryDecoder.java
index ebc74f7..ed8c8a4 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/config/keys/PublicKeyEntryDecoder.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/config/keys/PublicKeyEntryDecoder.java
@@ -33,6 +33,8 @@ import java.util.Collection;
/**
* Represents a decoder of an {@code OpenSSH} encoded key data
*
+ * @param <PUB> Type of {@link PublicKey}
+ * @param <PRV> Type of {@link PrivateKey}
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public interface PublicKeyEntryDecoder<PUB extends PublicKey, PRV extends PrivateKey> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/future/AbstractSshFuture.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/future/AbstractSshFuture.java b/sshd-core/src/main/java/org/apache/sshd/common/future/AbstractSshFuture.java
index 68a0214..2f179e7 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/future/AbstractSshFuture.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/future/AbstractSshFuture.java
@@ -29,6 +29,7 @@ import org.apache.sshd.common.util.GenericUtils;
import org.apache.sshd.common.util.logging.AbstractLoggingBean;
/**
+ * @param <T> Type of future
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class AbstractSshFuture<T extends SshFuture> extends AbstractLoggingBean implements SshFuture<T> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/future/DefaultSshFuture.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/future/DefaultSshFuture.java b/sshd-core/src/main/java/org/apache/sshd/common/future/DefaultSshFuture.java
index 89d5768..9e25bcc 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/future/DefaultSshFuture.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/future/DefaultSshFuture.java
@@ -26,6 +26,7 @@ import org.apache.sshd.common.util.ValidateUtils;
/**
* A default implementation of {@link SshFuture}.
*
+ * @param <T> Type of future
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public class DefaultSshFuture<T extends SshFuture> extends AbstractSshFuture<T> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/future/DefaultVerifiableSshFuture.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/future/DefaultVerifiableSshFuture.java b/sshd-core/src/main/java/org/apache/sshd/common/future/DefaultVerifiableSshFuture.java
index 142457e..c073d0f 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/future/DefaultVerifiableSshFuture.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/future/DefaultVerifiableSshFuture.java
@@ -23,6 +23,7 @@ import java.io.IOException;
import java.util.concurrent.TimeUnit;
/**
+ * @param <T> Type of future
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class DefaultVerifiableSshFuture<T extends SshFuture> extends DefaultSshFuture<T>implements VerifiableFuture<T> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/future/SshFuture.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/future/SshFuture.java b/sshd-core/src/main/java/org/apache/sshd/common/future/SshFuture.java
index 27e2a9e..b0d8e3c 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/future/SshFuture.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/future/SshFuture.java
@@ -23,6 +23,7 @@ package org.apache.sshd.common.future;
* (it may be an SSH session or an SSH channel).
* Can be listened for completion using a {@link SshFutureListener}.
*
+ * @param <T> Type of future
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public interface SshFuture<T extends SshFuture> extends WaitableFuture {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/future/SshFutureListener.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/future/SshFutureListener.java b/sshd-core/src/main/java/org/apache/sshd/common/future/SshFutureListener.java
index 44dc8d4..ede2fcf 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/future/SshFutureListener.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/future/SshFutureListener.java
@@ -24,6 +24,7 @@ import java.util.EventListener;
* Something interested in being notified when the completion
* of an asynchronous SSH operation : {@link SshFuture}.
*
+ * @param <T> type of future
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
@SuppressWarnings("rawtypes")
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/future/VerifiableFuture.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/future/VerifiableFuture.java b/sshd-core/src/main/java/org/apache/sshd/common/future/VerifiableFuture.java
index d903d5b..4bd5b00 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/future/VerifiableFuture.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/future/VerifiableFuture.java
@@ -28,6 +28,7 @@ import java.util.concurrent.TimeUnit;
* method returns without an exception then the operation was completed
* <U>successfully</U>
*
+ * @param <T> Type of verification result
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public interface VerifiableFuture<T> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/io/nio2/Nio2CompletionHandler.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/io/nio2/Nio2CompletionHandler.java b/sshd-core/src/main/java/org/apache/sshd/common/io/nio2/Nio2CompletionHandler.java
index 46fc0f0..0171d34 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/io/nio2/Nio2CompletionHandler.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/io/nio2/Nio2CompletionHandler.java
@@ -23,6 +23,9 @@ import java.security.AccessController;
import java.security.PrivilegedAction;
/**
+ * @param <V> Result type
+ * @param <A> Attachment type
+ * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class Nio2CompletionHandler<V, A> implements CompletionHandler<V, A> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/keyprovider/AbstractResourceKeyPairProvider.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/keyprovider/AbstractResourceKeyPairProvider.java b/sshd-core/src/main/java/org/apache/sshd/common/keyprovider/AbstractResourceKeyPairProvider.java
index c954166..b05c06f 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/keyprovider/AbstractResourceKeyPairProvider.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/keyprovider/AbstractResourceKeyPairProvider.java
@@ -37,6 +37,7 @@ import org.apache.sshd.common.util.GenericUtils;
import org.apache.sshd.common.util.ValidateUtils;
/**
+ * @param <R> Type of resource from which the {@link KeyPair} is generated
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class AbstractResourceKeyPairProvider<R> extends AbstractKeyPairProvider {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/session/AbstractSessionFactory.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/session/AbstractSessionFactory.java b/sshd-core/src/main/java/org/apache/sshd/common/session/AbstractSessionFactory.java
index 37fa761..c4afdfd 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/session/AbstractSessionFactory.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/session/AbstractSessionFactory.java
@@ -25,6 +25,8 @@ import org.apache.sshd.common.util.ValidateUtils;
/**
* An abstract base factory of sessions.
*
+ * @param <M> Type of {@link FactoryManager}
+ * @param <S> Type of {@link AbstractSession}
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class AbstractSessionFactory<M extends FactoryManager, S extends AbstractSession> extends AbstractSessionIoHandler {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/subsystem/sftp/extensions/AbstractParser.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/subsystem/sftp/extensions/AbstractParser.java b/sshd-core/src/main/java/org/apache/sshd/common/subsystem/sftp/extensions/AbstractParser.java
index 2d03e2b..41eba37 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/subsystem/sftp/extensions/AbstractParser.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/subsystem/sftp/extensions/AbstractParser.java
@@ -23,6 +23,7 @@ import org.apache.sshd.common.util.GenericUtils;
import org.apache.sshd.common.util.ValidateUtils;
/**
+ * @param <T> Parse result type
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public abstract class AbstractParser<T> implements ExtensionParser<T> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/subsystem/sftp/extensions/ExtensionParser.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/subsystem/sftp/extensions/ExtensionParser.java b/sshd-core/src/main/java/org/apache/sshd/common/subsystem/sftp/extensions/ExtensionParser.java
index 4b55715..cb3a3cb 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/subsystem/sftp/extensions/ExtensionParser.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/subsystem/sftp/extensions/ExtensionParser.java
@@ -23,6 +23,7 @@ import org.apache.sshd.common.NamedResource;
import org.apache.sshd.common.util.Transformer;
/**
+ * @param <T> Result type
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public interface ExtensionParser<T> extends NamedResource, Transformer<byte[], T> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/util/ObjectBuilder.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/util/ObjectBuilder.java b/sshd-core/src/main/java/org/apache/sshd/common/util/ObjectBuilder.java
index 4612674..a02324e 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/util/ObjectBuilder.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/util/ObjectBuilder.java
@@ -22,6 +22,7 @@ package org.apache.sshd.common.util;
/**
* A generic builder interface
*
+ * @param <T> Type of object being built
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public interface ObjectBuilder<T> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/util/Pair.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/util/Pair.java b/sshd-core/src/main/java/org/apache/sshd/common/util/Pair.java
index b05b82b..b1e76b9 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/util/Pair.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/util/Pair.java
@@ -23,22 +23,24 @@ import java.util.Objects;
/**
* Represents a pair of values
*
+ * @param <F> First value type
+ * @param <S> Second value type
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
-public class Pair<U, V> {
- private final U first;
- private final V second;
+public class Pair<F, S> {
+ private final F first;
+ private final S second;
- public Pair(U first, V second) {
+ public Pair(F first, S second) {
this.first = first;
this.second = second;
}
- public U getFirst() {
+ public F getFirst() {
return first;
}
- public V getSecond() {
+ public S getSecond() {
return second;
}
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/util/Predicate.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/util/Predicate.java b/sshd-core/src/main/java/org/apache/sshd/common/util/Predicate.java
index 03a4066..70a310a 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/util/Predicate.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/util/Predicate.java
@@ -20,6 +20,7 @@
package org.apache.sshd.common.util;
/**
+ * @param <T> Evaluation input type
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public interface Predicate<T> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/util/Transformer.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/util/Transformer.java b/sshd-core/src/main/java/org/apache/sshd/common/util/Transformer.java
index d91ab6b..88528f5 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/util/Transformer.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/util/Transformer.java
@@ -22,6 +22,8 @@ package org.apache.sshd.common.util;
import java.util.Objects;
/**
+ * @param <I> Input type
+ * @param <O> Output type
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public interface Transformer<I, O> {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/util/closeable/FuturesCloseable.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/util/closeable/FuturesCloseable.java b/sshd-core/src/main/java/org/apache/sshd/common/util/closeable/FuturesCloseable.java
index 62c427d..265e740 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/util/closeable/FuturesCloseable.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/util/closeable/FuturesCloseable.java
@@ -27,6 +27,7 @@ import org.apache.sshd.common.future.SshFuture;
import org.apache.sshd.common.future.SshFutureListener;
/**
+ * @param <T> Type of future
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public class FuturesCloseable<T extends SshFuture> extends SimpleCloseable {
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/main/java/org/apache/sshd/common/util/io/FileInfoExtractor.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/util/io/FileInfoExtractor.java b/sshd-core/src/main/java/org/apache/sshd/common/util/io/FileInfoExtractor.java
index a5e53d0..4693dd6 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/util/io/FileInfoExtractor.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/util/io/FileInfoExtractor.java
@@ -28,6 +28,7 @@ import java.nio.file.attribute.PosixFilePermission;
import java.util.Set;
/**
+ * @param <T> Type of information being extracted
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public interface FileInfoExtractor<T> {
@@ -38,7 +39,7 @@ public interface FileInfoExtractor<T> {
return Files.exists(file, options);
}
};
-
+
FileInfoExtractor<Boolean> ISDIR = new FileInfoExtractor<Boolean>() {
@Override
public Boolean infoOf(Path file, LinkOption... options) throws IOException {
@@ -79,7 +80,7 @@ public interface FileInfoExtractor<T> {
public FileTime infoOf(Path file, LinkOption... options) throws IOException {
return Files.getLastModifiedTime(file, options);
}
-
+
};
T infoOf(Path file, LinkOption ... options) throws IOException;
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/test/java/org/apache/sshd/server/ServerTest.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/test/java/org/apache/sshd/server/ServerTest.java b/sshd-core/src/test/java/org/apache/sshd/server/ServerTest.java
index 957ef5f..bc35530 100644
--- a/sshd-core/src/test/java/org/apache/sshd/server/ServerTest.java
+++ b/sshd-core/src/test/java/org/apache/sshd/server/ServerTest.java
@@ -245,7 +245,7 @@ public class ServerTest extends BaseTestSupport {
assertTrue("Shell latch not signalled in time", TestEchoShell.latch.await(1L, TimeUnit.SECONDS));
}
- /**
+ /*
* The scenario is the following:
* - create a command that sends continuous data to the client
* - the client does not read the data, filling the ssh window and the tcp socket
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/test/java/org/apache/sshd/server/channel/ChannelSessionTest.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/test/java/org/apache/sshd/server/channel/ChannelSessionTest.java b/sshd-core/src/test/java/org/apache/sshd/server/channel/ChannelSessionTest.java
index 4b30dec..3c86a32 100644
--- a/sshd-core/src/test/java/org/apache/sshd/server/channel/ChannelSessionTest.java
+++ b/sshd-core/src/test/java/org/apache/sshd/server/channel/ChannelSessionTest.java
@@ -41,7 +41,7 @@ public class ChannelSessionTest extends BaseTestSupport {
super();
}
- /**
+ /*
* Test whether onWindowExpanded is called from server session
*/
@Test
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-core/src/test/java/org/apache/sshd/util/test/BaseTestSupport.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/test/java/org/apache/sshd/util/test/BaseTestSupport.java b/sshd-core/src/test/java/org/apache/sshd/util/test/BaseTestSupport.java
index 0769031..99921a0 100644
--- a/sshd-core/src/test/java/org/apache/sshd/util/test/BaseTestSupport.java
+++ b/sshd-core/src/test/java/org/apache/sshd/util/test/BaseTestSupport.java
@@ -141,7 +141,7 @@ public abstract class BaseTestSupport extends Assert {
* @param comps The path components - ignored if {@code null}/empty
* @return The {@link Path} representing the result - same as target folder if no components
* @see #TEMP_SUBFOLDER_NAME
- * @see #getTempTargetFolder();
+ * @see #getTempTargetFolder()
*/
protected Path getTempTargetRelativeFile(Collection<String> comps) {
return Utils.resolve(getTempTargetFolder(), comps);
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/d9f51085/sshd-git/src/main/java/org/apache/sshd/git/transport/GitSshdSession.java
----------------------------------------------------------------------
diff --git a/sshd-git/src/main/java/org/apache/sshd/git/transport/GitSshdSession.java b/sshd-git/src/main/java/org/apache/sshd/git/transport/GitSshdSession.java
index 00a63b6..08b4e3a 100644
--- a/sshd-git/src/main/java/org/apache/sshd/git/transport/GitSshdSession.java
+++ b/sshd-git/src/main/java/org/apache/sshd/git/transport/GitSshdSession.java
@@ -55,7 +55,7 @@ public class GitSshdSession extends AbstractLoggingBean implements RemoteSession
/**
* Property used to configure the SSHD {@link org.apache.sshd.common.FactoryManager} with
* the default timeout (millis) to open a channel to the remote SSH server.
- * If not specified then {@link #DEFAULT_CHANNEL_OPEN__TIMEOUT) is used.
+ * If not specified then {@link #DEFAULT_CHANNEL_OPEN__TIMEOUT} is used.
*/
public static final String CHANNEL_OPEN_TIMEOUT_PROPT = "git-ssh-channel-open-timeout";
public static final long DEFAULT_CHANNEL_OPEN_TIMEOUT = TimeUnit.SECONDS.toMillis(7L);
[2/2] mina-sshd git commit: [SSHD-479] Upgrade used Maven artifacts
versions to more recent versions
Posted by lg...@apache.org.
[SSHD-479] Upgrade used Maven artifacts versions to more recent versions
Upgraded checksyle plugin to version 2.16
Project: http://git-wip-us.apache.org/repos/asf/mina-sshd/repo
Commit: http://git-wip-us.apache.org/repos/asf/mina-sshd/commit/e1b8bc40
Tree: http://git-wip-us.apache.org/repos/asf/mina-sshd/tree/e1b8bc40
Diff: http://git-wip-us.apache.org/repos/asf/mina-sshd/diff/e1b8bc40
Branch: refs/heads/master
Commit: e1b8bc40c52a90876cdbf4faba2dd8206a06ea29
Parents: d9f5108
Author: Lyor Goldstein <lg...@vmware.com>
Authored: Wed Oct 21 10:03:18 2015 +0300
Committer: Lyor Goldstein <lg...@vmware.com>
Committed: Wed Oct 21 10:03:18 2015 +0300
----------------------------------------------------------------------
pom.xml | 4 ++--
.../java/org/apache/sshd/common/channel/AbstractChannel.java | 2 +-
.../java/org/apache/sshd/common/forward/TcpipClientChannel.java | 2 +-
.../org/apache/sshd/common/util/closeable/AbstractCloseable.java | 2 +-
4 files changed, 5 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/e1b8bc40/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index f38108b..311d803 100644
--- a/pom.xml
+++ b/pom.xml
@@ -451,7 +451,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.16</version>
+ <version>2.17</version>
<configuration>
<logViolationsToConsole>true</logViolationsToConsole>
<resourceExcludes>**/*.properties</resourceExcludes>
@@ -743,7 +743,7 @@
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
- <version>6.10.1</version>
+ <version>6.11.2</version>
<exclusions>
<!-- MCHECKSTYLE-156 -->
<exclusion>
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/e1b8bc40/sshd-core/src/main/java/org/apache/sshd/common/channel/AbstractChannel.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/channel/AbstractChannel.java b/sshd-core/src/main/java/org/apache/sshd/common/channel/AbstractChannel.java
index ea579e1..6bbb931 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/channel/AbstractChannel.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/channel/AbstractChannel.java
@@ -67,7 +67,7 @@ public abstract class AbstractChannel
*/
public static final Int2IntFunction RESPONSE_BUFFER_GROWTH_FACTOR = Int2IntFunction.Utils.add(Byte.SIZE);
- protected static enum GracefulState {
+ protected enum GracefulState {
Opened, CloseSent, CloseReceived, Closed
}
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/e1b8bc40/sshd-core/src/main/java/org/apache/sshd/common/forward/TcpipClientChannel.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/forward/TcpipClientChannel.java b/sshd-core/src/main/java/org/apache/sshd/common/forward/TcpipClientChannel.java
index 6fbe333..8eeb9b7 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/forward/TcpipClientChannel.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/forward/TcpipClientChannel.java
@@ -44,7 +44,7 @@ public class TcpipClientChannel extends AbstractClientChannel {
/**
* Type of channel being created
*/
- public static enum Type {
+ public enum Type {
Direct,
Forwarded
}
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/e1b8bc40/sshd-core/src/main/java/org/apache/sshd/common/util/closeable/AbstractCloseable.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/util/closeable/AbstractCloseable.java b/sshd-core/src/main/java/org/apache/sshd/common/util/closeable/AbstractCloseable.java
index 8aaa5b0..a86abaa 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/util/closeable/AbstractCloseable.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/util/closeable/AbstractCloseable.java
@@ -32,7 +32,7 @@ import org.apache.sshd.common.future.SshFutureListener;
*/
public abstract class AbstractCloseable extends IoBaseCloseable {
- public static enum State {
+ public enum State {
Opened, Graceful, Immediate, Closed
}