2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.netconf.cli.commands.local;
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;
19 import org.opendaylight.controller.netconf.cli.NetconfDeviceConnectionManager;
20 import org.opendaylight.controller.netconf.cli.commands.AbstractCommand;
21 import org.opendaylight.controller.netconf.cli.commands.Command;
22 import org.opendaylight.controller.netconf.cli.commands.input.Input;
23 import org.opendaylight.controller.netconf.cli.commands.input.InputDefinition;
24 import org.opendaylight.controller.netconf.cli.commands.output.Output;
25 import org.opendaylight.controller.netconf.cli.commands.output.OutputDefinition;
26 import org.opendaylight.controller.netconf.client.conf.NetconfClientConfiguration;
27 import org.opendaylight.controller.netconf.client.conf.NetconfClientConfigurationBuilder;
28 import org.opendaylight.controller.netconf.nettyutil.handler.ssh.authentication.LoginPassword;
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.Node;
33 import org.opendaylight.yangtools.yang.data.api.SimpleNode;
34 import org.opendaylight.yangtools.yang.data.impl.CompositeNodeTOImpl;
35 import org.opendaylight.yangtools.yang.data.impl.SimpleNodeTOImpl;
36 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
39 * Local command to connect to a remote device
41 public class Connect extends AbstractCommand {
43 private final NetconfDeviceConnectionManager connectManager;
44 private final Integer connectionTimeout;
46 private Connect(final QName qName, final InputDefinition args, final OutputDefinition output,
47 final NetconfDeviceConnectionManager connectManager, final String description, final Integer connectionTimeout) {
48 super(qName, args, output, description);
49 this.connectManager = connectManager;
50 this.connectionTimeout = connectionTimeout;
54 public Output invoke(final Input inputArgs) {
55 final NetconfClientConfigurationBuilder config = getConfig(inputArgs);
56 return invoke(config, getArgument(inputArgs, "address-name", String.class));
59 private Output invoke(final NetconfClientConfigurationBuilder config, final String addressName) {
60 final Set<String> remoteCmds = connectManager.connectBlocking(addressName, config);
62 final ArrayList<Node<?>> output = Lists.newArrayList();
63 output.add(new SimpleNodeTOImpl<>(QName.create(getCommandId(), "status"), null, "Connection initiated"));
65 for (final String cmdId : remoteCmds) {
66 output.add(new SimpleNodeTOImpl<>(QName.create(getCommandId(), "remote-commands"), null, cmdId));
69 return new Output(new CompositeNodeTOImpl(getCommandId(), null, output));
72 private NetconfClientConfigurationBuilder getConfig(final Input inputArgs) {
74 final ReconnectStrategy strategy = getReconnectStrategy();
76 final String address = getArgument(inputArgs, "address-name", String.class);
77 final Integer port = getArgument(inputArgs, "address-port", Integer.class);
78 final String username = getArgument(inputArgs, "user-name", String.class);
79 final String passwd = getArgument(inputArgs, "user-password", String.class);
81 final InetSocketAddress inetAddress;
83 inetAddress = new InetSocketAddress(InetAddress.getByName(address), port);
84 } catch (final UnknownHostException e) {
85 throw new IllegalArgumentException("Unable to use address: " + address, e);
88 return NetconfClientConfigurationBuilder.create().withAddress(inetAddress)
89 .withConnectionTimeoutMillis(connectionTimeout)
90 .withReconnectStrategy(strategy)
91 .withAuthHandler(new LoginPassword(username, passwd))
92 .withProtocol(NetconfClientConfiguration.NetconfClientProtocol.SSH);
95 private <T> Optional<T> getArgumentOpt(final Input inputArgs, final String argName, final Class<T> type) {
96 final QName argQName = QName.create(getCommandId(), argName);
97 final Node<?> argumentNode = inputArgs.getArg(argName);
98 if (argumentNode == null) {
99 return Optional.absent();
101 Preconditions.checkArgument(argumentNode instanceof SimpleNode, "Only simple type argument supported, %s",
104 final Object value = argumentNode.getValue();
105 Preconditions.checkArgument(type.isInstance(value), "Unexpected instance type: %s for argument: %s",
106 value.getClass(), argQName);
107 return Optional.of(type.cast(value));
110 private <T> T getArgument(final Input inputArgs, final String argName, final Class<T> type) {
111 final Optional<T> argumentOpt = getArgumentOpt(inputArgs, argName, type);
112 Preconditions.checkState(argumentOpt.isPresent(), "Argument: %s is missing but is required", argName);
113 return argumentOpt.get();
116 public static ReconnectStrategy getReconnectStrategy() {
117 // FIXME move to args either start-up args or input nodes for connect or both
118 return new NeverReconnectStrategy(GlobalEventExecutor.INSTANCE, 1000);
121 public static Command create(final RpcDefinition rpcDefinition, final NetconfDeviceConnectionManager connectManager, final Integer connectionTimeout) {
122 return new Connect(rpcDefinition.getQName(), getInputDefinition(rpcDefinition),
123 getOutputDefinition(rpcDefinition), connectManager, rpcDefinition.getDescription(), connectionTimeout);