netconf/netconf-api/src/main/java/org/opendaylight/netconf/api/messages/NetconfHelloMessageAdditionalHeader.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. 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.messages;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.net.InetAddresses;
  14 import java.util.regex.Matcher;
  15 import java.util.regex.Pattern;
  16
  17 /**
  18  * Additional header can be used with hello message to carry information about
  19  * session's connection. Provided information can be reported via netconf
  20  * monitoring.
  21  * <pre>
  22  * It has PATTERN "[username; host-address:port; transport; session-identifier;]"
  23  * username - name of account on a remote
  24  * host-address - client's IP address
  25  * port - port number
  26  * transport - tcp, ssh
  27  * session-identifier - persister, client
  28  * Session-identifier is optional, others mandatory.
  29  * </pre>
  30  * This header is inserted in front of a netconf hello message followed by a newline.
  31  */
  32 public class NetconfHelloMessageAdditionalHeader {
  33
  34     private static final String SC = ";";
  35
  36     private final String userName;
  37     private final String hostAddress;
  38     private final String port;
  39     private final String transport;
  40     private final String sessionIdentifier;
  41
  42     public NetconfHelloMessageAdditionalHeader(final String userName, final String hostAddress, final String port,
  43                                                final String transport, final String sessionIdentifier) {
  44         this.userName = userName;
  45         this.hostAddress = hostAddress;
  46         this.port = port;
  47         this.transport = transport;
  48         this.sessionIdentifier = sessionIdentifier;
  49     }
  50
  51     public String getUserName() {
  52         return userName;
  53     }
  54
  55     public String getAddress() {
  56         return hostAddress;
  57     }
  58
  59     public String getPort() {
  60         return port;
  61     }
  62
  63     public String getTransport() {
  64         return transport;
  65     }
  66
  67     public String getSessionIdentifier() {
  68         return sessionIdentifier;
  69     }
  70
  71     /**
  72      * Format additional header into a string suitable as a prefix for netconf hello message.
  73      */
  74     public String toFormattedString() {
  75         requireNonNull(userName);
  76         requireNonNull(hostAddress);
  77         requireNonNull(port);
  78         requireNonNull(transport);
  79         requireNonNull(sessionIdentifier);
  80         return "[" + userName + SC + hostAddress + ":" + port + SC + transport + SC + sessionIdentifier + SC + "]"
  81                 + System.lineSeparator();
  82     }
  83
  84     @Override
  85     public String toString() {
  86         final StringBuilder sb = new StringBuilder("NetconfHelloMessageAdditionalHeader{");
  87         sb.append("userName='").append(userName).append('\'');
  88         sb.append(", hostAddress='").append(hostAddress).append('\'');
  89         sb.append(", port='").append(port).append('\'');
  90         sb.append(", transport='").append(transport).append('\'');
  91         sb.append(", sessionIdentifier='").append(sessionIdentifier).append('\'');
  92         sb.append('}');
  93         return sb.toString();
  94     }
  95
  96     private static final Pattern PATTERN = Pattern
  97             .compile("\\[(?<username>[^;]+);(?<address>.+)[:/](?<port>[0-9]+);(?<transport>[a-z]+)[^\\]]+\\]");
  98     private static final Pattern CUSTOM_HEADER_PATTERN = Pattern
  99             .compile("\\[(?<username>[^;]+);"
 100                     + "(?<address>.+)[:/](?<port>[0-9]+);(?<transport>[a-z]+);(?<sessionIdentifier>[a-z]+)[^\\]]+\\]");
 101
 102     /**
 103      * Parse additional header from a formatted string.
 104      */
 105     public static NetconfHelloMessageAdditionalHeader fromString(final String additionalHeader) {
 106         String additionalHeaderTrimmed = additionalHeader.trim();
 107         Matcher matcher = PATTERN.matcher(additionalHeaderTrimmed);
 108         Matcher matcher2 = CUSTOM_HEADER_PATTERN.matcher(additionalHeaderTrimmed);
 109         checkArgument(matcher.matches(), "Additional header in wrong format %s, expected %s",
 110                 additionalHeaderTrimmed, PATTERN);
 111
 112         String username = matcher.group("username");
 113         String address = matcher.group("address");
 114         checkArgument(InetAddresses.isInetAddress(address));
 115         String port = matcher.group("port");
 116         String transport = matcher.group("transport");
 117         String sessionIdentifier = "client";
 118         if (matcher2.matches()) {
 119             sessionIdentifier = matcher2.group("sessionIdentifier");
 120         }
 121         return new NetconfHelloMessageAdditionalHeader(username, address, port, transport, sessionIdentifier);
 122     }
 123 }