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 notification of options negotiation commands received on a telnet session.
22 * <p>
23 * The user can implement this interface and register a TelnetNotificationHandler by using the registerNotificationHandler() of TelnetClient to be notified of
24 * option negotiation commands.
25 * </p>
26 */
27 public interface TelnetNotificationHandler {
28 /**
29 * The remote party sent a DO command.
30 */
31 int RECEIVED_DO = 1;
32
33 /**
34 * The remote party sent a {@code DONT} command.
35 */
36 int RECEIVED_DONT = 2;
37
38 /**
39 * The remote party sent a {@code WILL} command.
40 */
41 int RECEIVED_WILL = 3;
42
43 /**
44 * The remote party sent a {@code WONT} command.
45 */
46 int RECEIVED_WONT = 4;
47
48 /**
49 * The remote party sent a {@code COMMAND}.
50 *
51 * @since 2.2
52 */
53 int RECEIVED_COMMAND = 5;
54
55 /**
56 * Callback method called when TelnetClient receives a command or option negotiation command
57 *
58 * @param negotiation_code - type of (negotiation) command received (RECEIVED_DO, RECEIVED_DONT, RECEIVED_WILL, RECEIVED_WONT, RECEIVED_COMMAND)
59 *
60 * @param option_code - code of the option negotiated, or the command code itself (e.g. NOP).
61 */
62 void receivedNegotiation(int negotiation_code, int option_code);
63 }