You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by gn...@apache.org on 2009/04/02 12:02:45 UTC
svn commit: r761224 - in /mina/sshd/trunk/src/main/java/org/apache/sshd: ./
client/kex/ client/session/ common/ common/channel/ common/cipher/
common/compression/ common/digest/ common/kex/ common/mac/ common/random/
common/signature/ common/util/ serv...
Author: gnodet
Date: Thu Apr 2 10:02:44 2009
New Revision: 761224
URL: http://svn.apache.org/viewvc?rev=761224&view=rev
Log:
Improve javadocs
Added:
mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/package.html
mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/package.html
mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/package.html
mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/package.html
mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/package.html
mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/package.html
mina/sshd/trunk/src/main/java/org/apache/sshd/package.html
Modified:
mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/AbstractDHGClient.java
mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/DHG1.java
mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/DHG14.java
mina/sshd/trunk/src/main/java/org/apache/sshd/client/session/ClientSessionImpl.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/AbstractFactoryManager.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/NamedFactory.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/channel/Window.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES128CBC.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES192CBC.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES256CBC.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/BaseCipher.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/BlowfishCBC.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/CipherNone.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/TripleDESCBC.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionDelayedZlib.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionNone.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionZlib.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/BaseDigest.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/MD5.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/SHA1.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/kex/DH.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/kex/DHGroupData.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/BaseMac.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACMD5.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACMD596.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACSHA1.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACSHA196.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/BouncyCastleRandom.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/JceRandom.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/SignatureDSA.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/SignatureRSA.java
mina/sshd/trunk/src/main/java/org/apache/sshd/common/util/Buffer.java
mina/sshd/trunk/src/main/java/org/apache/sshd/server/CommandFactory.java
mina/sshd/trunk/src/main/java/org/apache/sshd/server/command/ScpCommand.java
mina/sshd/trunk/src/main/java/org/apache/sshd/server/command/UnknownCommand.java
mina/sshd/trunk/src/main/java/org/apache/sshd/server/session/ServerSession.java
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/AbstractDHGClient.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/AbstractDHGClient.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/AbstractDHGClient.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/AbstractDHGClient.java Thu Apr 2 10:02:44 2009
@@ -37,7 +37,9 @@
import org.slf4j.LoggerFactory;
/**
- * TODO Add javadoc
+ * Base class for DHG key exchange algorithms.
+ * Implementations will only have to configure the required data on the
+ * {@link DH} class in the {@link #initDH(org.apache.sshd.common.kex.DH)} method.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
@@ -91,7 +93,7 @@
log.info("Received SSH_MSG_KEXDH_REPLY");
byte[] K_S = buffer.getBytes();
- byte[] f = buffer.getMPIntAsBytes();
+ f = buffer.getMPIntAsBytes();
byte[] sig = buffer.getBytes();
dh.setF(f);
K = dh.getK();
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/DHG1.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/DHG1.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/DHG1.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/DHG1.java Thu Apr 2 10:02:44 2009
@@ -31,6 +31,9 @@
*/
public class DHG1 extends AbstractDHGClient {
+ /**
+ * Named factory for DHG1 key exchange
+ */
public static class Factory implements NamedFactory<KeyExchange> {
public String getName() {
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/DHG14.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/DHG14.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/DHG14.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/client/kex/DHG14.java Thu Apr 2 10:02:44 2009
@@ -33,6 +33,9 @@
*/
public class DHG14 extends AbstractDHGClient {
+ /**
+ * Named factory for DHG14 key exchange
+ */
public static class Factory implements NamedFactory<KeyExchange> {
public String getName() {
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/client/session/ClientSessionImpl.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/client/session/ClientSessionImpl.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/client/session/ClientSessionImpl.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/client/session/ClientSessionImpl.java Thu Apr 2 10:02:44 2009
@@ -150,7 +150,7 @@
case SSH_MSG_DEBUG: {
boolean display = buffer.getBoolean();
String msg = buffer.getString();
- log.info("Received SSH_MSG_DEBUG '{}'", msg);
+ log.info("Received SSH_MSG_DEBUG (display={}) '{}'", display, msg);
break;
}
case SSH_MSG_IGNORE:
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/AbstractFactoryManager.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/AbstractFactoryManager.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/AbstractFactoryManager.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/AbstractFactoryManager.java Thu Apr 2 10:02:44 2009
@@ -24,6 +24,9 @@
import java.util.Map;
import java.util.Properties;
+import org.slf4j.LoggerFactory;
+import org.slf4j.Logger;
+
/**
* TODO Add javadoc
*
@@ -32,6 +35,8 @@
*/
public abstract class AbstractFactoryManager implements FactoryManager {
+ private final Logger log = LoggerFactory.getLogger(getClass());
+
private Map<String,String> properties = new HashMap<String,String>();
private List<NamedFactory<KeyExchange>> keyExchangeFactories;
private List<NamedFactory<Cipher>> cipherFactories;
@@ -117,7 +122,7 @@
protected void loadVersion() {
this.version = "SSHD-UNKNOWN";
try {
- InputStream input = getClass().getResourceAsStream("sshd-version.properties");
+ InputStream input = getClass().getClassLoader().getResourceAsStream("org/apache/sshd/sshd-version.properties");
try {
Properties props = new Properties();
props.load(input);
@@ -126,7 +131,7 @@
input.close();
}
} catch (Exception e) {
- // Ignore
+ log.warn("Unable to load version from resources. Missing org/apache/sshd/sshd-version.properties ?", e);
}
}
}
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/NamedFactory.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/NamedFactory.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/NamedFactory.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/NamedFactory.java Thu Apr 2 10:02:44 2009
@@ -49,7 +49,7 @@
public static class Utils {
/**
- * Create an instance of the spcecified name by looking up the needed factory
+ * Create an instance of the specified name by looking up the needed factory
* in the list.
*
* @param factories list of available factories
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/channel/Window.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/channel/Window.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/channel/Window.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/channel/Window.java Thu Apr 2 10:02:44 2009
@@ -24,7 +24,11 @@
import org.slf4j.LoggerFactory;
/**
- * TODO Add javadoc
+ * A Window for a given channel.
+ * Windows are used to not overflow the client or server when sending datas.
+ * Both clients and servers have a local and remote window and won't send
+ * anymore data until the window has been expanded. When the local window
+ * is
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
@@ -65,6 +69,7 @@
this.maxSize = size;
this.packetSize = packetSize;
}
+
public void expand(int window) {
synchronized (lock) {
size += window;
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES128CBC.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES128CBC.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES128CBC.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES128CBC.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,16 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * AES128CBC cipher
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class AES128CBC extends BaseCipher {
+ /**
+ * Named factory for AES128CBC Cipher
+ */
public static class Factory implements NamedFactory<Cipher> {
public String getName() {
return "aes128-cbc";
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES192CBC.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES192CBC.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES192CBC.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES192CBC.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,16 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * AES192CBC Cipher
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class AES192CBC extends BaseCipher {
+ /**
+ * Named factory for AES192CBC Cipher
+ */
public static class Factory implements NamedFactory<Cipher> {
public String getName() {
return "aes192-cbc";
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES256CBC.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES256CBC.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES256CBC.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/AES256CBC.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,16 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * AES256CBC Cipher
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class AES256CBC extends BaseCipher {
+ /**
+ * Named factory for AES256CBC Cipher
+ */
public static class Factory implements NamedFactory<Cipher> {
public String getName() {
return "aes256-cbc";
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/BaseCipher.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/BaseCipher.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/BaseCipher.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/BaseCipher.java Thu Apr 2 10:02:44 2009
@@ -25,7 +25,7 @@
import org.apache.sshd.common.util.SecurityUtils;
/**
- * TODO Add javadoc
+ * Base class for all Cipher implementations delegating to the JCE provider.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/BlowfishCBC.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/BlowfishCBC.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/BlowfishCBC.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/BlowfishCBC.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,16 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * BlowfishCBC Cipher
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class BlowfishCBC extends BaseCipher {
+ /**
+ * Named factory for BlowfishCBC Cipher
+ */
public static class Factory implements NamedFactory<Cipher> {
public String getName() {
return "blowfish-cbc";
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/CipherNone.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/CipherNone.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/CipherNone.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/CipherNone.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,19 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * Represents a no-op cipher.
+ * This cipher can not really be used during authentication and should only
+ * be used after, so that authentication remains secured, but not the remaining
+ * of the exchanges.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class CipherNone implements Cipher {
+ /**
+ * Named factory for the no-op Cipher
+ */
public static class Factory implements NamedFactory<Cipher> {
public String getName() {
return "none";
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/TripleDESCBC.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/TripleDESCBC.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/TripleDESCBC.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/TripleDESCBC.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,16 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * TripleDESCBC Cipher
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class TripleDESCBC extends BaseCipher {
+ /**
+ * Named factory for TripleDESCBC Cipher
+ */
public static class Factory implements NamedFactory<Cipher> {
public String getName() {
return "3des-cbc";
Added: mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/package.html
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/package.html?rev=761224&view=auto
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/package.html (added)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/cipher/package.html Thu Apr 2 10:02:44 2009
@@ -0,0 +1,25 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+</head>
+<body>
+
+<a href="{@docRoot}/org/apache/sshd/common/Cipher.html"><code>Cipher</code></a> implementations.
+
+</body>
+</html>
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionDelayedZlib.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionDelayedZlib.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionDelayedZlib.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionDelayedZlib.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,18 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * ZLib delayed compression.
+ *
+ * @see Compression#isDelayed()
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class CompressionDelayedZlib extends CompressionZlib {
+ /**
+ * Named factory for the ZLib Delayed Compression.
+ */
public static class Factory implements NamedFactory<Compression> {
public String getName() {
return "zlib@openssh.com";
@@ -39,6 +44,12 @@
}
}
+ /**
+ * Create a new instance of a delayed ZLib compression
+ */
+ public CompressionDelayedZlib() {
+ }
+
public boolean isDelayed() {
return true;
}
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionNone.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionNone.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionNone.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionNone.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,19 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * No-op <code>Compression</code>.
+ * This is actually an abstract class, because no compression will be
+ * identified by a <code>null</code> <code>Compression</code> object.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public abstract class CompressionNone implements Compression {
+ /**
+ * Named factory for the no-op <code>Compression</code>.
+ * This factory will simply return <code>null</code>.
+ */
public static class Factory implements NamedFactory<Compression> {
public String getName() {
return "none";
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionZlib.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionZlib.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionZlib.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/CompressionZlib.java Thu Apr 2 10:02:44 2009
@@ -29,13 +29,16 @@
import org.apache.sshd.common.util.Buffer;
/**
- * TODO Add javadoc
+ * ZLib based Compression.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class CompressionZlib implements Compression {
+ /**
+ * Named factory for the ZLib Compression.
+ */
public static class Factory implements NamedFactory<Compression> {
public String getName() {
return "zlib";
@@ -51,6 +54,12 @@
private ZStream stream;
private byte[] tmpbuf = new byte[BUF_SIZE];
+ /**
+ * Create a new instance of a ZLib base compression
+ */
+ public CompressionZlib() {
+ }
+
public boolean isDelayed() {
return false;
}
Added: mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/package.html
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/package.html?rev=761224&view=auto
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/package.html (added)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/compression/package.html Thu Apr 2 10:02:44 2009
@@ -0,0 +1,25 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+</head>
+<body>
+
+<a href="{@docRoot}/org/apache/sshd/common/Compression.html"><code>Compression</code></a> implementations.
+
+</body>
+</html>
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/BaseDigest.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/BaseDigest.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/BaseDigest.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/BaseDigest.java Thu Apr 2 10:02:44 2009
@@ -24,7 +24,7 @@
import org.apache.sshd.common.util.SecurityUtils;
/**
- * TODO Add javadoc
+ * Base class for Digest algorithms based on the JCE provider.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
@@ -35,6 +35,14 @@
private int bsize;
private MessageDigest md;
+ /**
+ * Create a new digest using the given algorithm and block size.
+ * The initialization and creation of the underlying {@link MessageDigest}
+ * object will be done in the {@link #init()} method.
+ *
+ * @param algorithm the JCE algorithm to use for this digest
+ * @param bsize the block size of this digest
+ */
public BaseDigest(String algorithm, int bsize) {
this.algorithm = algorithm;
this.bsize = bsize;
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/MD5.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/MD5.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/MD5.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/MD5.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,16 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * MD5 Digest.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class MD5 extends BaseDigest {
+ /**
+ * Named factory for MD5 digest
+ */
public static class Factory implements NamedFactory<Digest> {
public String getName() {
@@ -40,6 +43,9 @@
}
}
+ /**
+ * Create a new instance of a MD5 digest
+ */
public MD5() {
super("MD5", 16);
}
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/SHA1.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/SHA1.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/SHA1.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/SHA1.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,16 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * SHA1 Digest.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class SHA1 extends BaseDigest {
+ /**
+ * Named factory for SHA1 digest
+ */
public static class Factory implements NamedFactory<Digest> {
public String getName() {
@@ -40,6 +43,9 @@
}
}
+ /**
+ * Create a new instance of a SHA1 digest
+ */
public SHA1() {
super("SHA-1", 20);
}
Added: mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/package.html
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/package.html?rev=761224&view=auto
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/package.html (added)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/digest/package.html Thu Apr 2 10:02:44 2009
@@ -0,0 +1,25 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+</head>
+<body>
+
+<a href="{@docRoot}/org/apache/sshd/common/Digest.html"><code>Digest</code></a> implementations.
+
+</body>
+</html>
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/kex/DH.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/kex/DH.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/kex/DH.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/kex/DH.java Thu Apr 2 10:02:44 2009
@@ -31,7 +31,7 @@
import org.apache.sshd.common.util.SecurityUtils;
/**
- * TODO Add javadoc
+ * Diffie-Hellman key generator.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/kex/DHGroupData.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/kex/DHGroupData.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/kex/DHGroupData.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/kex/DHGroupData.java Thu Apr 2 10:02:44 2009
@@ -19,12 +19,12 @@
package org.apache.sshd.common.kex;
/**
- * TODO Add javadoc
+ * Simple class holding the data for DH group key exchanges.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
-public class DHGroupData {
+public final class DHGroupData {
public static final byte[] G = { 2 };
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/BaseMac.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/BaseMac.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/BaseMac.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/BaseMac.java Thu Apr 2 10:02:44 2009
@@ -24,7 +24,7 @@
import org.apache.sshd.common.util.SecurityUtils;
/**
- * TODO Add javadoc
+ * Base class for <code>Mac</code> implementations based on the JCE provider.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACMD5.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACMD5.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACMD5.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACMD5.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,16 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * HMAC-MD5 <code>Mac</code>.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class HMACMD5 extends BaseMac {
+ /**
+ * Named factory for the HMACMD5 <code>Mac</code>
+ */
public static class Factory implements NamedFactory<Mac> {
public String getName() {
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACMD596.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACMD596.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACMD596.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACMD596.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,16 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * HMAC-MD5-96 <code>Mac</code>
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class HMACMD596 extends BaseMac {
+ /**
+ * Named factory for the HMAC-MD5-96 <code>Mac</code>
+ */
public static class Factory implements NamedFactory<Mac> {
public String getName() {
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACSHA1.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACSHA1.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACSHA1.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACSHA1.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,16 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * HMAC-SHA1 <code>Mac</code>
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class HMACSHA1 extends BaseMac {
+ /**
+ * Named factory for the HMAC-SHA1 <code>Mac</code>
+ */
public static class Factory implements NamedFactory<Mac> {
public String getName() {
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACSHA196.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACSHA196.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACSHA196.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/HMACSHA196.java Thu Apr 2 10:02:44 2009
@@ -22,13 +22,16 @@
import org.apache.sshd.common.NamedFactory;
/**
- * TODO Add javadoc
+ * HMAC-SHA1-96 <code>Mac</code>
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class HMACSHA196 extends BaseMac {
+ /**
+ * Named factory for the HMAC-SHA1-96 <code>Mac</code>
+ */
public static class Factory implements NamedFactory<Mac> {
public String getName() {
Added: mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/package.html
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/package.html?rev=761224&view=auto
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/package.html (added)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/mac/package.html Thu Apr 2 10:02:44 2009
@@ -0,0 +1,25 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+</head>
+<body>
+
+<a href="{@docRoot}/org/apache/sshd/common/Mac.html"><code>Mac</code></a> implementations.
+
+</body>
+</html>
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/BouncyCastleRandom.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/BouncyCastleRandom.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/BouncyCastleRandom.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/BouncyCastleRandom.java Thu Apr 2 10:02:44 2009
@@ -26,13 +26,19 @@
import org.bouncycastle.crypto.prng.VMPCRandomGenerator;
/**
- * TODO Add javadoc
+ * BouncyCastle <code>Random</code>.
+ * This pseudo random number generator uses the a very fast PRNG from BouncyCastle.
+ * The JRE random will be used when creating a new generator to add some random
+ * data to the seed.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class BouncyCastleRandom implements Random {
+ /**
+ * Named factory for the BouncyCastle <code>Random</code>
+ */
public static class Factory implements NamedFactory<Random> {
public String getName() {
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/JceRandom.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/JceRandom.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/JceRandom.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/JceRandom.java Thu Apr 2 10:02:44 2009
@@ -24,13 +24,16 @@
import org.apache.sshd.common.Random;
/**
- * TODO Add javadoc
+ * A <code>Random</code> implementation using the built-in {@link SecureRandom} PRNG.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class JceRandom implements Random {
+ /**
+ * Named factory for the BouncyCastle <code>Random</code>
+ */
public static class Factory implements NamedFactory<Random> {
public String getName() {
Added: mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/package.html
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/package.html?rev=761224&view=auto
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/package.html (added)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/random/package.html Thu Apr 2 10:02:44 2009
@@ -0,0 +1,25 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+</head>
+<body>
+
+<a href="{@docRoot}/org/apache/sshd/common/Random.html"><code>Random</code></a> implementations.
+
+</body>
+</html>
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/SignatureDSA.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/SignatureDSA.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/SignatureDSA.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/SignatureDSA.java Thu Apr 2 10:02:44 2009
@@ -23,13 +23,16 @@
import org.apache.sshd.common.Signature;
/**
- * TODO Add javadoc
+ * DSA <code>Signature</code>
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class SignatureDSA extends AbstractSignature {
+ /**
+ * A named factory for DSA signature
+ */
public static class Factory implements NamedFactory<Signature> {
public String getName() {
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/SignatureRSA.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/SignatureRSA.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/SignatureRSA.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/SignatureRSA.java Thu Apr 2 10:02:44 2009
@@ -23,13 +23,16 @@
import org.apache.sshd.common.Signature;
/**
- * TODO Add javadoc
+ * RSA <code>Signature</code>
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
*/
public class SignatureRSA extends AbstractSignature {
+ /**
+ * A named factory for RSA <code>Signature</code>
+ */
public static class Factory implements NamedFactory<Signature> {
public String getName() {
Added: mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/package.html
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/package.html?rev=761224&view=auto
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/package.html (added)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/signature/package.html Thu Apr 2 10:02:44 2009
@@ -0,0 +1,25 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+</head>
+<body>
+
+<a href="{@docRoot}/org/apache/sshd/common/Signature.html"><code>Signature</code></a> implementations.
+
+</body>
+</html>
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/common/util/Buffer.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/common/util/Buffer.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/common/util/Buffer.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/common/util/Buffer.java Thu Apr 2 10:02:44 2009
@@ -344,7 +344,7 @@
}
}
- private static final int getNextPowerOf2(int i) {
+ private static int getNextPowerOf2(int i) {
int j = 1;
while (j < i) {
j <<= 1;
Added: mina/sshd/trunk/src/main/java/org/apache/sshd/package.html
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/package.html?rev=761224&view=auto
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/package.html (added)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/package.html Thu Apr 2 10:02:44 2009
@@ -0,0 +1,25 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+</head>
+<body>
+
+Defines the two main classes for the client and server side of SSH protocol support.
+
+</body>
+</html>
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/server/CommandFactory.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/server/CommandFactory.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/server/CommandFactory.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/server/CommandFactory.java Thu Apr 2 10:02:44 2009
@@ -40,7 +40,7 @@
* the display output to be sent back to the client.
*
* @param command
- * @return a non null command
+ * @return a non null <code>Command</code>
*/
Command createCommand(String command);
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/server/command/ScpCommand.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/server/command/ScpCommand.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/server/command/ScpCommand.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/server/command/ScpCommand.java Thu Apr 2 10:02:44 2009
@@ -25,8 +25,11 @@
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
+import java.util.Arrays;
import org.apache.sshd.server.CommandFactory;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
/**
* This commands provide SCP support on both server and client side.
@@ -38,6 +41,8 @@
*/
public class ScpCommand implements CommandFactory.Command, Runnable {
+ private static final Logger log = LoggerFactory.getLogger(ScpCommand.class);
+
private boolean optR;
private boolean optT;
private boolean optF;
@@ -51,6 +56,9 @@
private IOException error;
public ScpCommand(String[] args) {
+ if (log.isDebugEnabled()) {
+ log.debug("Executing command {}", Arrays.asList(args));
+ }
root = new File(".");
for (int i = 1; i < args.length; i++) {
if (args[i].charAt(0) == '-') {
@@ -143,13 +151,16 @@
} catch (IOException e2) {
// Ignore
}
- e.printStackTrace();
+ log.info("Error in scp command", e);
} finally {
callback.onExit(0);
}
}
private void writeDir(String header, File path) throws IOException {
+ if (log.isDebugEnabled()) {
+ log.debug("Writing dir {}", path);
+ }
if (!header.startsWith("D")) {
throw new IOException("Expected a D message but got '" + header + "'");
}
@@ -192,6 +203,9 @@
}
private void writeFile(String header, File path) throws IOException {
+ if (log.isDebugEnabled()) {
+ log.debug("Writing file {}", path);
+ }
if (!header.startsWith("C")) {
throw new IOException("Expected a C message but got '" + header + "'");
}
@@ -245,6 +259,9 @@
}
private void readFile(File path) throws IOException {
+ if (log.isDebugEnabled()) {
+ log.debug("Reading file {}", path);
+ }
StringBuffer buf = new StringBuffer();
buf.append("C");
buf.append("0644"); // what about perms
@@ -272,6 +289,9 @@
}
private void readDir(File path) throws IOException {
+ if (log.isDebugEnabled()) {
+ log.debug("Reading directory {}", path);
+ }
StringBuffer buf = new StringBuffer();
buf.append("D");
buf.append("0755"); // what about perms
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/server/command/UnknownCommand.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/server/command/UnknownCommand.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/server/command/UnknownCommand.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/server/command/UnknownCommand.java Thu Apr 2 10:02:44 2009
@@ -25,7 +25,9 @@
import org.apache.sshd.server.CommandFactory;
/**
- * TODO Add javadoc
+ * Implementation of an unknown command that can be returned by <code>CommandFactory</code>
+ * when the command is not knownas it is supposed to always
+ * return a valid <code>Command</code> object.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
* @version $Rev$, $Date$
Modified: mina/sshd/trunk/src/main/java/org/apache/sshd/server/session/ServerSession.java
URL: http://svn.apache.org/viewvc/mina/sshd/trunk/src/main/java/org/apache/sshd/server/session/ServerSession.java?rev=761224&r1=761223&r2=761224&view=diff
==============================================================================
--- mina/sshd/trunk/src/main/java/org/apache/sshd/server/session/ServerSession.java (original)
+++ mina/sshd/trunk/src/main/java/org/apache/sshd/server/session/ServerSession.java Thu Apr 2 10:02:44 2009
@@ -123,7 +123,7 @@
case SSH_MSG_DEBUG: {
boolean display = buffer.getBoolean();
String msg = buffer.getString();
- log.info("Received SSH_MSG_DEBUG '{}'", msg);
+ log.info("Received SSH_MSG_DEBUG (display={}) '{}'", display, msg);
break;
}
case SSH_MSG_IGNORE: