netconf/tools/netconf-cli/src/main/java/org/opendaylight/netconf/cli/commands/local/Connect.java

   1 /*
   2  * Copyright (c) 2014 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.cli.commands.local;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.Lists;
  13 import io.netty.util.concurrent.GlobalEventExecutor;
  14 import java.net.InetAddress;
  15 import java.net.InetSocketAddress;
  16 import java.net.UnknownHostException;
  17 import java.util.ArrayList;
  18 import java.util.Set;
  19 import org.opendaylight.netconf.cli.NetconfDeviceConnectionManager;
  20 import org.opendaylight.netconf.cli.commands.AbstractCommand;
  21 import org.opendaylight.netconf.cli.commands.Command;
  22 import org.opendaylight.netconf.cli.commands.input.Input;
  23 import org.opendaylight.netconf.cli.commands.input.InputDefinition;
  24 import org.opendaylight.netconf.cli.commands.output.Output;
  25 import org.opendaylight.netconf.cli.commands.output.OutputDefinition;
  26 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  27 import org.opendaylight.netconf.client.conf.NetconfClientConfigurationBuilder;
  28 import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.LoginPasswordHandler;
  29 import org.opendaylight.protocol.framework.NeverReconnectStrategy;
  30 import org.opendaylight.protocol.framework.ReconnectStrategy;
  31 import org.opendaylight.yangtools.yang.common.QName;
  32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  34 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  35 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
  41 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  42
  43 /**
  44  * Local command to connect to a remote device.
  45  */
  46 public class Connect extends AbstractCommand {
  47
  48     private final NetconfDeviceConnectionManager connectManager;
  49     private final Integer connectionTimeout;
  50
  51     private Connect(final QName qualifiedName, final InputDefinition args, final OutputDefinition output,
  52                     final NetconfDeviceConnectionManager connectManager, final String description,
  53                     final Integer connectionTimeout) {
  54         super(qualifiedName, args, output, description);
  55         this.connectManager = connectManager;
  56         this.connectionTimeout = connectionTimeout;
  57     }
  58
  59     @Override
  60     public Output invoke(final Input inputArgs) {
  61         final NetconfClientConfigurationBuilder config = getConfig(inputArgs);
  62         return invoke(config, getArgument(inputArgs, "address-name", String.class), inputArgs);
  63     }
  64
  65     private Output invoke(final NetconfClientConfigurationBuilder config,
  66                           final String addressName, final Input inputArgs) {
  67         final Set<String> remoteCmds = connectManager.connectBlocking(addressName, getAdress(inputArgs), config);
  68
  69         final ArrayList<DataContainerChild<?, ?>> output = Lists.newArrayList();
  70         output.add(ImmutableLeafNodeBuilder.create()
  71                 .withNodeIdentifier(new NodeIdentifier(QName.create(getCommandId(), "status")))
  72                 .withValue("Connection initiated").build());
  73
  74         final ArrayList<LeafSetEntryNode<Object>> leafListChildren = Lists.newArrayList();
  75         for (final String cmdId : remoteCmds) {
  76             leafListChildren.add(ImmutableLeafSetEntryNodeBuilder.create()
  77                     .withNodeIdentifier(new NodeWithValue(QName.create(getCommandId(), "remote-commands"), cmdId))
  78                     .withValue(cmdId).build());
  79         }
  80
  81         return new Output(ImmutableLeafSetNodeBuilder.create()
  82                 .withNodeIdentifier(new NodeIdentifier(QName.create(getCommandId(), "remote-commands")))
  83                 .withValue(leafListChildren).build());
  84     }
  85
  86     private NetconfClientConfigurationBuilder getConfig(final Input inputArgs) {
  87
  88         final ReconnectStrategy strategy = getReconnectStrategy();
  89
  90         final String address = getArgument(inputArgs, "address-name", String.class);
  91         final Integer port = getArgument(inputArgs, "address-port", Integer.class);
  92         final String username = getArgument(inputArgs, "user-name", String.class);
  93         final String passwd = getArgument(inputArgs, "user-password", String.class);
  94
  95         final InetSocketAddress inetAddress;
  96         try {
  97             inetAddress = new InetSocketAddress(InetAddress.getByName(address), port);
  98         } catch (final UnknownHostException e) {
  99             throw new IllegalArgumentException("Unable to use address: " + address, e);
 100         }
 101
 102         return NetconfClientConfigurationBuilder.create().withAddress(inetAddress)
 103                 .withConnectionTimeoutMillis(connectionTimeout)
 104                 .withReconnectStrategy(strategy)
 105                 .withAuthHandler(new LoginPasswordHandler(username, passwd))
 106                 .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.SSH);
 107     }
 108
 109     private InetSocketAddress getAdress(final Input inputArgs) {
 110         final String address = getArgument(inputArgs, "address-name", String.class);
 111         final InetSocketAddress inetAddress;
 112         try {
 113             inetAddress = new InetSocketAddress(
 114                 InetAddress.getByName(address), getArgument(inputArgs, "address-port", Integer.class));
 115         } catch (final UnknownHostException e) {
 116             throw new IllegalArgumentException("Unable to use address: " + address, e);
 117         }
 118         return inetAddress;
 119     }
 120
 121     private <T> Optional<T> getArgumentOpt(final Input inputArgs, final String argName, final Class<T> type) {
 122         final QName argQName = QName.create(getCommandId(), argName);
 123         final NormalizedNode<?, ?> argumentNode = inputArgs.getArg(argName);
 124         if (argumentNode == null) {
 125             return Optional.absent();
 126         }
 127         Preconditions.checkArgument(argumentNode instanceof LeafNode, "Only simple type argument supported, %s",
 128                 argQName);
 129
 130         final Object value = argumentNode.getValue();
 131         Preconditions.checkArgument(type.isInstance(value), "Unexpected instance type: %s for argument: %s",
 132                 value.getClass(), argQName);
 133         return Optional.of(type.cast(value));
 134     }
 135
 136     private <T> T getArgument(final Input inputArgs, final String argName, final Class<T> type) {
 137         final Optional<T> argumentOpt = getArgumentOpt(inputArgs, argName, type);
 138         Preconditions.checkState(argumentOpt.isPresent(), "Argument: %s is missing but is required", argName);
 139         return argumentOpt.get();
 140     }
 141
 142     public static ReconnectStrategy getReconnectStrategy() {
 143         // FIXME move to args either start-up args or input nodes for connect or both
 144         return new NeverReconnectStrategy(GlobalEventExecutor.INSTANCE, 1000);
 145     }
 146
 147     public static Command create(final RpcDefinition rpcDefinition, final NetconfDeviceConnectionManager connectManager,
 148                                  final Integer connectionTimeout) {
 149         return new Connect(rpcDefinition.getQName(), getInputDefinition(rpcDefinition),
 150                 getOutputDefinition(rpcDefinition), connectManager, rpcDefinition.getDescription(), connectionTimeout);
 151     }
 152 }