summaryrefslogtreecommitdiff
path: root/app/src/main/java/org/apache/commons/net/ProtocolCommandSupport.java
diff options
context:
space:
mode:
Diffstat (limited to 'app/src/main/java/org/apache/commons/net/ProtocolCommandSupport.java')
-rw-r--r--app/src/main/java/org/apache/commons/net/ProtocolCommandSupport.java134
1 files changed, 134 insertions, 0 deletions
diff --git a/app/src/main/java/org/apache/commons/net/ProtocolCommandSupport.java b/app/src/main/java/org/apache/commons/net/ProtocolCommandSupport.java
new file mode 100644
index 0000000..e9e4380
--- /dev/null
+++ b/app/src/main/java/org/apache/commons/net/ProtocolCommandSupport.java
@@ -0,0 +1,134 @@
+/*
+ * 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.commons.net;
+
+import org.apache.commons.net.util.ListenerList;
+
+import java.io.Serializable;
+import java.util.EventListener;
+
+/***
+ * ProtocolCommandSupport is a convenience class for managing a list of
+ * ProtocolCommandListeners and firing ProtocolCommandEvents. You can
+ * simply delegate ProtocolCommandEvent firing and listener
+ * registering/unregistering tasks to this class.
+ * <p>
+ * <p>
+ * @see ProtocolCommandEvent
+ * @see ProtocolCommandListener
+ * @author Daniel F. Savarese
+ ***/
+
+public class ProtocolCommandSupport implements Serializable
+{
+ private Object __source;
+ private ListenerList __listeners;
+
+ /***
+ * Creates a ProtocolCommandSupport instant using the indicated source
+ * as the source of fired ProtocolCommandEvents.
+ * <p>
+ * @param source The source to use for all generated ProtocolCommandEvents.
+ ***/
+ public ProtocolCommandSupport(Object source)
+ {
+ __listeners = new ListenerList();
+ __source = source;
+ }
+
+
+ /***
+ * Fires a ProtocolCommandEvent signalling the sending of a command to all
+ * registered listeners, invoking their
+ * {@link org.apache.commons.net.ProtocolCommandListener#protocolCommandSent protocolCommandSent() }
+ * methods.
+ * <p>
+ * @param command The string representation of the command type sent, not
+ * including the arguments (e.g., "STAT" or "GET").
+ * @param message The entire command string verbatim as sent to the server,
+ * including all arguments.
+ ***/
+ public void fireCommandSent(String command, String message)
+ {
+ ProtocolCommandEvent event;
+
+ event = new ProtocolCommandEvent(__source, command, message);
+
+ for (EventListener listener : __listeners)
+ {
+ ((ProtocolCommandListener)listener).protocolCommandSent(event);
+ }
+ }
+
+ /***
+ * Fires a ProtocolCommandEvent signalling the reception of a command reply
+ * to all registered listeners, invoking their
+ * {@link org.apache.commons.net.ProtocolCommandListener#protocolReplyReceived protocolReplyReceived() }
+ * methods.
+ * <p>
+ * @param replyCode The integer code indicating the natureof the reply.
+ * This will be the protocol integer value for protocols
+ * that use integer reply codes, or the reply class constant
+ * corresponding to the reply for protocols like POP3 that use
+ * strings like OK rather than integer codes (i.e., POP3Repy.OK).
+ * @param message The entire reply as received from the server.
+ ***/
+ public void fireReplyReceived(int replyCode, String message)
+ {
+ ProtocolCommandEvent event;
+ event = new ProtocolCommandEvent(__source, replyCode, message);
+
+ for (EventListener listener : __listeners)
+ {
+ ((ProtocolCommandListener)listener).protocolReplyReceived(event);
+ }
+ }
+
+ /***
+ * Adds a ProtocolCommandListener.
+ * <p>
+ * @param listener The ProtocolCommandListener to add.
+ ***/
+ public void addProtocolCommandListener(ProtocolCommandListener listener)
+ {
+ __listeners.addListener(listener);
+ }
+
+ /***
+ * Removes a ProtocolCommandListener.
+ * <p>
+ * @param listener The ProtocolCommandListener to remove.
+ ***/
+ public void removeProtocolCommandListener(ProtocolCommandListener listener)
+ {
+ __listeners.removeListener(listener);
+ }
+
+
+ /***
+ * Returns the number of ProtocolCommandListeners currently registered.
+ * <p>
+ * @return The number of ProtocolCommandListeners currently registered.
+ ***/
+ public int getListenerCount()
+ {
+ return __listeners.getListenerCount();
+ }
+
+}
+