2 * Copyright (c) 2016 Brocade Communication Systems 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.netconf.callhome.mount;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.base.MoreObjects;
13 import io.netty.util.concurrent.Future;
14 import org.opendaylight.netconf.api.NetconfTerminationReason;
15 import org.opendaylight.netconf.api.messages.NetconfMessage;
16 import org.opendaylight.netconf.callhome.protocol.CallHomeChannelActivator;
17 import org.opendaylight.netconf.callhome.protocol.CallHomeProtocolSessionContext;
18 import org.opendaylight.netconf.client.NetconfClientSession;
19 import org.opendaylight.netconf.client.NetconfClientSessionListener;
20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev230430.connection.parameters.ProtocolBuilder;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev230430.credentials.credentials.LoginPasswordBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNodeBuilder;
24 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
25 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
26 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
27 import org.opendaylight.yangtools.yang.common.Decimal64;
28 import org.opendaylight.yangtools.yang.common.Uint16;
29 import org.opendaylight.yangtools.yang.common.Uint32;
31 // Non-final to allow mocking
32 class CallHomeMountSessionContext {
34 interface CloseCallback {
35 void onClosed(CallHomeMountSessionContext deviceContext);
38 private final NodeId nodeId;
39 private final CallHomeChannelActivator activator;
40 private final CallHomeProtocolSessionContext protocol;
41 private final CloseCallback onClose;
43 private final ContextKey key;
45 CallHomeMountSessionContext(final String nodeId, final CallHomeProtocolSessionContext protocol,
46 final CallHomeChannelActivator activator, final CloseCallback callback) {
48 this.nodeId = new NodeId(requireNonNull(nodeId, "nodeId"));
49 key = ContextKey.from(protocol.getRemoteAddress());
50 this.protocol = requireNonNull(protocol, "protocol");
51 this.activator = requireNonNull(activator, "activator");
52 onClose = requireNonNull(callback, "callback");
55 CallHomeProtocolSessionContext getProtocol() {
63 ContextKey getContextKey() {
68 * Create device default configuration.
71 * This configuration is a replacement of configuration device data
72 * which is normally stored in configuration datastore but is absent for call-home devices.
74 * @return {@link Node} containing the default device configuration
76 // FIXME make these defaults tune-able in odl-netconf-callhome-server
77 Node getConfigNode() {
78 return new NodeBuilder()
80 .addAugmentation(new NetconfNodeBuilder()
81 .setHost(new Host(key.getIpAddress()))
82 .setPort(key.getPort())
84 .setProtocol(new ProtocolBuilder()
85 .setName(protocol.getTransportType())
88 .setReconnectOnChangedSchema(false)
89 .setConnectionTimeoutMillis(Uint32.valueOf(20000))
90 .setDefaultRequestTimeoutMillis(Uint32.valueOf(60000))
91 .setMaxConnectionAttempts(Uint32.ZERO)
92 .setBetweenAttemptsTimeoutMillis(Uint16.valueOf(2000))
93 .setSleepFactor(Decimal64.valueOf("1.5"))
94 .setKeepaliveDelay(Uint32.valueOf(120))
95 .setConcurrentRpcLimit(Uint16.ZERO)
96 .setActorResponseWaitTime(Uint16.valueOf(5))
97 // the real call-home device credentials are applied in CallHomeAuthProviderImpl
98 .setCredentials(new LoginPasswordBuilder()
99 .setUsername("omitted")
100 .setPassword("omitted")
102 .setLockDatastore(true)
107 Future<NetconfClientSession> activateNetconfChannel(final NetconfClientSessionListener sessionListener) {
108 return activator.activate(wrap(sessionListener));
112 public String toString() {
113 return MoreObjects.toStringHelper(this)
114 .add("address", protocol.getRemoteAddress())
115 .add("hostKey", protocol.getRemoteServerKey())
119 private NetconfClientSessionListener wrap(final NetconfClientSessionListener delegate) {
120 return new NetconfClientSessionListener() {
122 public void onSessionUp(final NetconfClientSession session) {
123 delegate.onSessionUp(session);
127 public void onSessionTerminated(final NetconfClientSession session, final NetconfTerminationReason reason) {
129 delegate.onSessionTerminated(session, reason);
136 public void onSessionDown(final NetconfClientSession session, final Exception exc) {
140 delegate.onSessionDown(session, exc);
145 public void onMessage(final NetconfClientSession session, final NetconfMessage message) {
146 delegate.onMessage(session, message);
150 public void onError(final NetconfClientSession session, final Exception failure) {
151 delegate.onError(session, failure);
156 private void removeSelf() {
157 onClose.onClosed(this);