Centralize NETCONF over SSH subsystem name
[netconf.git] / protocol / netconf-api / src / main / java / org / opendaylight / netconf / api / TransportConstants.java
1 /*
2  * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.netconf.api;
9
10 import org.eclipse.jdt.annotation.NonNullByDefault;
11
12 /**
13  * Various constants related to NETCONF transport layer.
14  */
15 @NonNullByDefault
16 public final class TransportConstants {
17     /**
18      * The name of the SSH subsystem used to carry NETCONF sessions, as defined in
19      * <a href="https://www.rfc-editor.org/rfc/rfc6242#section-7">RFC6242</a>.
20      */
21     public static final String SSH_SUBSYSTEM = "netconf";
22
23     /**
24      * The default TCP port to use for NETCONF over SSH, as defined in
25      * <a href="https://www.rfc-editor.org/rfc/rfc6242#section-7">RFC6242</a>.
26      */
27     public static final int SSH_TCP_PORT = 830;
28
29     private TransportConstants() {
30         // Hidden on purpose
31     }
32 }