2 * Copyright (c) 2013 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.openflowplugin.openflow.md.core.sal;
10 import com.google.common.base.Preconditions;
11 import java.math.BigInteger;
12 import java.net.Inet4Address;
13 import java.net.Inet6Address;
14 import java.net.InetAddress;
15 import java.net.InetSocketAddress;
16 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
17 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
18 import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
19 import org.opendaylight.openflowplugin.api.openflow.md.ModelDrivenSwitch;
20 import org.opendaylight.openflowplugin.api.openflow.md.core.NotificationQueueWrapper;
21 import org.opendaylight.openflowplugin.openflow.md.core.session.OFSessionUtil;
22 import org.opendaylight.openflowplugin.api.openflow.md.core.session.SessionContext;
23 import org.opendaylight.openflowplugin.api.openflow.md.core.session.SessionListener;
24 import org.opendaylight.openflowplugin.api.openflow.md.core.session.SessionManager;
25 import org.opendaylight.openflowplugin.api.openflow.md.core.session.SwitchSessionKeyOF;
26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Address;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeUpdated;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeUpdatedBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRemoved;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRemovedBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdated;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdatedBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
41 import org.opendaylight.yangtools.concepts.CompositeObjectRegistration;
42 import org.opendaylight.yangtools.concepts.ListenerRegistration;
43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
49 * session and inventory listener implementation
51 public class SalRegistrationManager implements SessionListener, AutoCloseable {
53 private static final Logger LOG = LoggerFactory.getLogger(SalRegistrationManager.class);
55 private ProviderContext providerContext;
57 private NotificationProviderService publishService;
59 private DataBroker dataService;
61 private SwitchFeaturesUtil swFeaturesUtil;
63 private ListenerRegistration<SessionListener> sessionListenerRegistration;
65 public SalRegistrationManager() {
66 swFeaturesUtil = SwitchFeaturesUtil.getInstance();
69 public NotificationProviderService getPublishService() {
70 return publishService;
73 public void setPublishService(NotificationProviderService publishService) {
74 this.publishService = publishService;
77 public ProviderContext getProviderContext() {
78 return providerContext;
81 public void onSessionInitiated(ProviderContext session) {
82 LOG.debug("onSessionInitiated");
83 this.providerContext = session;
84 this.publishService = session.getSALService(NotificationProviderService.class);
85 this.dataService = session.getSALService(DataBroker.class);
86 // We register as listener for Session Manager
87 sessionListenerRegistration = getSessionManager().registerSessionListener(this);
88 getSessionManager().setNotificationProviderService(publishService);
89 getSessionManager().setDataBroker(dataService);
90 LOG.debug("SalRegistrationManager initialized");
94 public void onSessionAdded(SwitchSessionKeyOF sessionKey, SessionContext context) {
95 GetFeaturesOutput features = context.getFeatures();
96 BigInteger datapathId = features.getDatapathId();
97 InstanceIdentifier<Node> identifier = identifierFromDatapathId(datapathId);
98 NodeRef nodeRef = new NodeRef(identifier);
99 NodeId nodeId = nodeIdFromDatapathId(datapathId);
100 ModelDrivenSwitchImpl ofSwitch = new ModelDrivenSwitchImpl(nodeId, identifier, context);
101 CompositeObjectRegistration<ModelDrivenSwitch> registration = ofSwitch.register(providerContext);
102 context.setProviderRegistration(registration);
104 LOG.debug("ModelDrivenSwitch for {} registered to MD-SAL.", datapathId.toString());
106 NotificationQueueWrapper wrappedNotification = new NotificationQueueWrapper(
107 nodeAdded(ofSwitch, features, nodeRef),
108 context.getFeatures().getVersion());
109 context.getNotificationEnqueuer().enqueueNotification(wrappedNotification);
113 public void onSessionRemoved(SessionContext context) {
114 GetFeaturesOutput features = context.getFeatures();
115 BigInteger datapathId = features.getDatapathId();
116 InstanceIdentifier<Node> identifier = identifierFromDatapathId(datapathId);
117 NodeRef nodeRef = new NodeRef(identifier);
118 NodeRemoved nodeRemoved = nodeRemoved(nodeRef);
120 CompositeObjectRegistration<ModelDrivenSwitch> registration = context.getProviderRegistration();
121 if (null != registration) {
122 registration.close();
123 context.setProviderRegistration(null);
125 LOG.debug("ModelDrivenSwitch for {} unregistered from MD-SAL.", datapathId.toString());
127 NotificationQueueWrapper wrappedNotification = new NotificationQueueWrapper(
128 nodeRemoved, context.getFeatures().getVersion());
129 context.getNotificationEnqueuer().enqueueNotification(wrappedNotification);
132 private NodeUpdated nodeAdded(ModelDrivenSwitch sw, GetFeaturesOutput features, NodeRef nodeRef) {
133 NodeUpdatedBuilder builder = new NodeUpdatedBuilder();
134 builder.setId(sw.getNodeId());
135 builder.setNodeRef(nodeRef);
137 FlowCapableNodeUpdatedBuilder builder2 = new FlowCapableNodeUpdatedBuilder();
139 builder2.setIpAddress(getIpAddressOf(sw));
140 } catch (Exception e) {
141 LOG.warn("IP address of the node {} cannot be obtained.", sw.getNodeId(), e);
143 builder2.setSwitchFeatures(swFeaturesUtil.buildSwitchFeatures(features));
144 builder.addAugmentation(FlowCapableNodeUpdated.class, builder2.build());
146 return builder.build();
149 private static IpAddress getIpAddressOf(ModelDrivenSwitch sw) {
150 SessionContext sessionContext = sw.getSessionContext();
151 Preconditions.checkNotNull(sessionContext.getPrimaryConductor(),
152 "primary conductor must not be NULL -> " + sw.getNodeId());
153 Preconditions.checkNotNull(sessionContext.getPrimaryConductor().getConnectionAdapter(),
154 "connection adapter of primary conductor must not be NULL -> " + sw.getNodeId());
155 InetSocketAddress remoteAddress = sessionContext.getPrimaryConductor().getConnectionAdapter()
157 if (remoteAddress == null) {
158 LOG.warn("IP address of the node {} cannot be obtained. No connection with switch.", sw.getNodeId());
161 return resolveIpAddress(remoteAddress.getAddress());
164 private static IpAddress resolveIpAddress(InetAddress address) {
165 String hostAddress = address.getHostAddress();
166 if (address instanceof Inet4Address) {
167 return new IpAddress(new Ipv4Address(hostAddress));
169 if (address instanceof Inet6Address) {
170 return new IpAddress(new Ipv6Address(hostAddress));
172 throw new IllegalArgumentException("Unsupported IP address type!");
175 private NodeRemoved nodeRemoved(NodeRef nodeRef) {
176 NodeRemovedBuilder builder = new NodeRemovedBuilder();
177 builder.setNodeRef(nodeRef);
178 return builder.build();
181 public static InstanceIdentifier<Node> identifierFromDatapathId(BigInteger datapathId) {
182 NodeKey nodeKey = nodeKeyFromDatapathId(datapathId);
183 InstanceIdentifierBuilder<Node> builder = InstanceIdentifier.builder(Nodes.class).child(Node.class, nodeKey);
184 return builder.build();
187 public static NodeKey nodeKeyFromDatapathId(BigInteger datapathId) {
188 return new NodeKey(nodeIdFromDatapathId(datapathId));
191 public static NodeId nodeIdFromDatapathId(BigInteger datapathId) {
192 // FIXME: Convert to textual representation of datapathID
193 String current = datapathId.toString();
194 return new NodeId("openflow:" + current);
197 public SessionManager getSessionManager() {
198 return OFSessionUtil.getSessionManager();
202 public void close() {
205 providerContext = null;
206 publishService = null;
207 if (sessionListenerRegistration != null) {
208 sessionListenerRegistration.close();
213 * @param providerContext the providerContext to set
215 public void setProviderContext(ProviderContext providerContext) {
216 this.providerContext = providerContext;