View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.net.telnet;
19  
20  /***
21   * The TelnetNotificationHandler interface can be used to handle
22   * notification of options negotiation commands received on a telnet
23   * session.
24   * <p>
25   * The user can implement this interface and register a
26   * TelnetNotificationHandler by using the registerNotificationHandler()
27   * of TelnetClient to be notified of option negotiation commands.
28   ***/
29  
30  public interface TelnetNotificationHandler
31  {
32      /***
33       * The remote party sent a DO command.
34       ***/
35      public static final int RECEIVED_DO =   1;
36  
37      /***
38       * The remote party sent a DONT command.
39       ***/
40      public static final int RECEIVED_DONT = 2;
41  
42      /***
43       * The remote party sent a WILL command.
44       ***/
45      public static final int RECEIVED_WILL = 3;
46  
47      /***
48       * The remote party sent a WONT command.
49       ***/
50      public static final int RECEIVED_WONT = 4;
51  
52      /***
53       * The remote party sent a COMMAND.
54       * @since 2.2
55       ***/
56      public static final int RECEIVED_COMMAND = 5;
57  
58      /***
59       * Callback method called when TelnetClient receives an
60       * command or option negotiation command
61       *
62       * @param negotiation_code - type of (negotiation) command received
63       * (RECEIVED_DO, RECEIVED_DONT, RECEIVED_WILL, RECEIVED_WONT, RECEIVED_COMMAND)
64       *
65       * @param option_code - code of the option negotiated, or the command code itself (e.g. NOP).
66       ***/
67      public void receivedNegotiation(int negotiation_code, int option_code);
68  }