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 2016/09/15 16:02:07 UTC

[3/5] mina-sshd git commit: Make all SSHD listeners extend SshdEventListener

Make all SSHD listeners extend SshdEventListener


Project: http://git-wip-us.apache.org/repos/asf/mina-sshd/repo
Commit: http://git-wip-us.apache.org/repos/asf/mina-sshd/commit/3453416a
Tree: http://git-wip-us.apache.org/repos/asf/mina-sshd/tree/3453416a
Diff: http://git-wip-us.apache.org/repos/asf/mina-sshd/diff/3453416a

Branch: refs/heads/master
Commit: 3453416a133f6ed85b0492fcb29a8bc5a826ea7c
Parents: c42798c
Author: Lyor Goldstein <ly...@gmail.com>
Authored: Thu Sep 15 19:02:05 2016 +0300
Committer: Lyor Goldstein <ly...@gmail.com>
Committed: Thu Sep 15 19:02:05 2016 +0300

----------------------------------------------------------------------
 .../sshd/common/channel/ChannelListener.java    |  4 +--
 .../forward/PortForwardingEventListener.java    |  4 +--
 .../sshd/common/future/SshFutureListener.java   |  4 +--
 .../common/scp/ScpTransferEventListener.java    |  5 ++--
 .../session/ReservedSessionMessagesHandler.java |  3 +-
 .../sshd/common/session/SessionListener.java    |  4 +--
 .../sshd/common/util/SshdEventListener.java     | 29 ++++++++++++++++++++
 .../org/apache/sshd/server/SignalListener.java  |  4 +--
 .../subsystem/sftp/SftpEventListener.java       |  4 +--
 .../common/util/EventListenerUtilsTest.java     |  2 +-
 10 files changed, 47 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/3453416a/sshd-core/src/main/java/org/apache/sshd/common/channel/ChannelListener.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/channel/ChannelListener.java b/sshd-core/src/main/java/org/apache/sshd/common/channel/ChannelListener.java
index 20eb29d..0124fca 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/channel/ChannelListener.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/channel/ChannelListener.java
@@ -19,7 +19,7 @@
 
 package org.apache.sshd.common.channel;
 
-import java.util.EventListener;
+import org.apache.sshd.common.util.SshdEventListener;
 
 /**
  * Provides a simple listener for client / server channels being established
@@ -29,7 +29,7 @@ import java.util.EventListener;
  *
  * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
  */
-public interface ChannelListener extends EventListener {
+public interface ChannelListener extends SshdEventListener {
     ChannelListener EMPTY = new ChannelListener() {
         @Override
         public String toString() {

http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/3453416a/sshd-core/src/main/java/org/apache/sshd/common/forward/PortForwardingEventListener.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/forward/PortForwardingEventListener.java b/sshd-core/src/main/java/org/apache/sshd/common/forward/PortForwardingEventListener.java
index 25211bb..857fbfe 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/forward/PortForwardingEventListener.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/forward/PortForwardingEventListener.java
@@ -20,15 +20,15 @@
 package org.apache.sshd.common.forward;
 
 import java.io.IOException;
-import java.util.EventListener;
 
 import org.apache.sshd.common.session.Session;
+import org.apache.sshd.common.util.SshdEventListener;
 import org.apache.sshd.common.util.net.SshdSocketAddress;
 
 /**
  * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
  */
-public interface PortForwardingEventListener extends EventListener {
+public interface PortForwardingEventListener extends SshdEventListener {
     PortForwardingEventListener EMPTY = new PortForwardingEventListener() {
         @Override
         public String toString() {

http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/3453416a/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 2fadaf7..a005c0f 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
@@ -18,7 +18,7 @@
  */
 package org.apache.sshd.common.future;
 
-import java.util.EventListener;
+import org.apache.sshd.common.util.SshdEventListener;
 
 /**
  * Something interested in being notified when the completion
@@ -29,7 +29,7 @@ import java.util.EventListener;
  */
 @SuppressWarnings("rawtypes")
 @FunctionalInterface
-public interface SshFutureListener<T extends SshFuture> extends EventListener {
+public interface SshFutureListener<T extends SshFuture> extends SshdEventListener {
 
     /**
      * Invoked when the operation associated with the {@link SshFuture}

http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/3453416a/sshd-core/src/main/java/org/apache/sshd/common/scp/ScpTransferEventListener.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/scp/ScpTransferEventListener.java b/sshd-core/src/main/java/org/apache/sshd/common/scp/ScpTransferEventListener.java
index 95380cd..2e99576 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/scp/ScpTransferEventListener.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/scp/ScpTransferEventListener.java
@@ -22,15 +22,16 @@ package org.apache.sshd.common.scp;
 import java.io.IOException;
 import java.nio.file.Path;
 import java.nio.file.attribute.PosixFilePermission;
-import java.util.EventListener;
 import java.util.Set;
 
+import org.apache.sshd.common.util.SshdEventListener;
+
 /**
  * Can be registered in order to receive events about SCP transfers
  *
  * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
  */
-public interface ScpTransferEventListener extends EventListener {
+public interface ScpTransferEventListener extends SshdEventListener {
     enum FileOperation {
         SEND,
         RECEIVE

http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/3453416a/sshd-core/src/main/java/org/apache/sshd/common/session/ReservedSessionMessagesHandler.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/session/ReservedSessionMessagesHandler.java b/sshd-core/src/main/java/org/apache/sshd/common/session/ReservedSessionMessagesHandler.java
index 838b929..6c525f7 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/session/ReservedSessionMessagesHandler.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/session/ReservedSessionMessagesHandler.java
@@ -19,6 +19,7 @@
 
 package org.apache.sshd.common.session;
 
+import org.apache.sshd.common.util.SshdEventListener;
 import org.apache.sshd.common.util.buffer.Buffer;
 
 /**
@@ -27,7 +28,7 @@ import org.apache.sshd.common.util.buffer.Buffer;
  *
  * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
  */
-public interface ReservedSessionMessagesHandler {
+public interface ReservedSessionMessagesHandler extends SshdEventListener {
     /**
      * Invoked when an {@code SSH_MSG_IGNORE} packet is received
      *

http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/3453416a/sshd-core/src/main/java/org/apache/sshd/common/session/SessionListener.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/session/SessionListener.java b/sshd-core/src/main/java/org/apache/sshd/common/session/SessionListener.java
index e4267dc..8466ee7 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/session/SessionListener.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/session/SessionListener.java
@@ -18,17 +18,17 @@
  */
 package org.apache.sshd.common.session;
 
-import java.util.EventListener;
 import java.util.Map;
 
 import org.apache.sshd.common.kex.KexProposalOption;
+import org.apache.sshd.common.util.SshdEventListener;
 
 /**
  * Represents an interface receiving session events.
  *
  * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
  */
-public interface SessionListener extends EventListener {
+public interface SessionListener extends SshdEventListener {
     enum Event {
         KeyEstablished, Authenticated, KexCompleted
     }

http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/3453416a/sshd-core/src/main/java/org/apache/sshd/common/util/SshdEventListener.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/util/SshdEventListener.java b/sshd-core/src/main/java/org/apache/sshd/common/util/SshdEventListener.java
new file mode 100644
index 0000000..16dfc9f
--- /dev/null
+++ b/sshd-core/src/main/java/org/apache/sshd/common/util/SshdEventListener.java
@@ -0,0 +1,29 @@
+/*
+ * 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.
+ */
+
+package org.apache.sshd.common.util;
+
+import java.util.EventListener;
+
+/**
+ * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
+ */
+public interface SshdEventListener extends EventListener {
+    // marker interface for quickly locating our session listeners
+}

http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/3453416a/sshd-core/src/main/java/org/apache/sshd/server/SignalListener.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/server/SignalListener.java b/sshd-core/src/main/java/org/apache/sshd/server/SignalListener.java
index f16dbfd..bdb6370 100644
--- a/sshd-core/src/main/java/org/apache/sshd/server/SignalListener.java
+++ b/sshd-core/src/main/java/org/apache/sshd/server/SignalListener.java
@@ -18,12 +18,12 @@
  */
 package org.apache.sshd.server;
 
-import java.util.EventListener;
+import org.apache.sshd.common.util.SshdEventListener;
 
 /**
  * Define a listener to receive signals
  */
-public interface SignalListener extends EventListener {
+public interface SignalListener extends SshdEventListener {
 
     /**
      * @param signal The received {@link Signal}

http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/3453416a/sshd-core/src/main/java/org/apache/sshd/server/subsystem/sftp/SftpEventListener.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/server/subsystem/sftp/SftpEventListener.java b/sshd-core/src/main/java/org/apache/sshd/server/subsystem/sftp/SftpEventListener.java
index 60a0d1f..f5736c9 100644
--- a/sshd-core/src/main/java/org/apache/sshd/server/subsystem/sftp/SftpEventListener.java
+++ b/sshd-core/src/main/java/org/apache/sshd/server/subsystem/sftp/SftpEventListener.java
@@ -23,9 +23,9 @@ import java.io.IOException;
 import java.nio.file.CopyOption;
 import java.nio.file.Path;
 import java.util.Collection;
-import java.util.EventListener;
 import java.util.Map;
 
+import org.apache.sshd.common.util.SshdEventListener;
 import org.apache.sshd.server.session.ServerSession;
 
 /**
@@ -35,7 +35,7 @@ import org.apache.sshd.server.session.ServerSession;
  *
  * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
  */
-public interface SftpEventListener extends EventListener {
+public interface SftpEventListener extends SshdEventListener {
     /**
      * Called when the SFTP protocol has been initialized
      *

http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/3453416a/sshd-core/src/test/java/org/apache/sshd/common/util/EventListenerUtilsTest.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/test/java/org/apache/sshd/common/util/EventListenerUtilsTest.java b/sshd-core/src/test/java/org/apache/sshd/common/util/EventListenerUtilsTest.java
index 03d8d20..7b22fbe 100644
--- a/sshd-core/src/test/java/org/apache/sshd/common/util/EventListenerUtilsTest.java
+++ b/sshd-core/src/test/java/org/apache/sshd/common/util/EventListenerUtilsTest.java
@@ -111,7 +111,7 @@ public class EventListenerUtilsTest extends BaseTestSupport {
         assertEquals("Mismatched post p2-remove size", 0, s.size());
     }
 
-    interface ProxyListener extends EventListener {
+    interface ProxyListener extends SshdEventListener {
         void callMeWithString(String s);
 
         void callMeWithNumber(Number n);