2 * Copyright (c) 2015 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.groupbasedpolicy.neutron.ovsdb.util;
10 import static org.opendaylight.groupbasedpolicy.neutron.ovsdb.util.DataStore.readFromDs;
12 import java.util.ArrayList;
13 import java.util.List;
14 import java.util.concurrent.ExecutionException;
16 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
17 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.Name;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SubnetId;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.EndpointService;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.Endpoints;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.RegisterEndpointInput;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.RegisterEndpointInputBuilder;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.UnregisterEndpointInput;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.UnregisterEndpointInputBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoint.fields.L3Address;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoint.fields.L3AddressBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.Endpoint;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointKey;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.unregister.endpoint.input.L2;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.unregister.endpoint.input.L2Builder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.unregister.endpoint.input.L3;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.unregister.endpoint.input.L3Builder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayContextInput;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayContextInputBuilder;
40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
41 import org.opendaylight.yangtools.yang.common.RpcResult;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
45 import com.google.common.base.Optional;
46 import com.google.common.collect.ImmutableList;
48 public class EndpointHelper {
49 private static final Logger LOG = LoggerFactory.getLogger(EndpointHelper.class);
52 * Look up the {@link Endpoint} from the Endpoint Registry.
54 * @param epKey The {@link EndpointKey} to look up
55 * @param dataBroker The {@link DataBroker} to use for the transaction
56 * @return The corresponding {@link Endpoint}, null if not found
58 public static Endpoint lookupEndpoint(EndpointKey epKey, DataBroker dataBroker) {
59 InstanceIdentifier<Endpoint> iid = InstanceIdentifier
60 .builder(Endpoints.class)
61 .child(Endpoint.class, epKey).build();
63 ReadWriteTransaction transaction = dataBroker.newReadWriteTransaction();
64 Optional<Endpoint> optionalEp = readFromDs(LogicalDatastoreType.OPERATIONAL, iid, transaction );
65 if (optionalEp.isPresent()) {
66 return optionalEp.get();
73 * Update a {@link Endpoint} in the Endpoint Repository with the
74 * location information and port name in the OfOverlay augmentation.
75 * It looks up the {@link EndpointKey} in a data store maintained by the
76 * neutron-mapper, and uses that to look up the {@link Endpoint}, and
77 * then uses RPCs to delete then add the updated {@link Endpoint}
79 * @param epKey The {@link EndpointKey}
83 public static void updateEndpointWithLocation(Endpoint endpoint, String nodeIdString,
84 String nodeConnectorIdString, String portName, EndpointService endpointService) {
85 EndpointBuilder epBuilder = new EndpointBuilder(endpoint);
86 UnregisterEndpointInput unregisterEpRpcInput = createUnregisterEndpointInput(endpoint);
87 RegisterEndpointInput registerEpRpcInput =
88 createRegisterEndpointInput(epBuilder.build(),
91 nodeConnectorIdString);
93 RpcResult<Void> rpcResult = endpointService.unregisterEndpoint(unregisterEpRpcInput).get();
94 if (!rpcResult.isSuccessful()) {
95 LOG.warn("Illegal state - RPC unregisterEndpoint failed. Input of RPC: {}", unregisterEpRpcInput);
98 rpcResult = endpointService.registerEndpoint(registerEpRpcInput).get();
99 if (!rpcResult.isSuccessful()) {
100 LOG.warn("Illegal state - RPC registerEndpoint failed. Input of RPC: {}", registerEpRpcInput);
103 } catch (InterruptedException | ExecutionException e) {
104 LOG.error("addPort - RPC invocation failed.", e);
110 * Create the {@link UnregisterEndpointInput} state needed to remove
111 * the existing {@link Endpoint} from the Endpoint Registry.
113 * @param ep The {@link Endpoint} to remove from the registry
114 * @return The {@link UnregisterEndpointInput}, null if failure
116 public static UnregisterEndpointInput createUnregisterEndpointInput(Endpoint ep) {
117 UnregisterEndpointInputBuilder inputBuilder = new UnregisterEndpointInputBuilder();
118 L2 l2Ep = new L2Builder().setL2Context(ep.getL2Context()).setMacAddress(ep.getMacAddress()).build();
119 inputBuilder.setL2(ImmutableList.of(l2Ep));
120 // TODO Li msunal this has to be rewrite when OFOverlay renderer will support l3-endpoints.
121 // Endpoint probably will not have l3-addresses anymore, because L2 and L3 endpoints should
122 // be registered separately.
123 if (ep.getL3Address() != null && !ep.getL3Address().isEmpty()) {
124 List<L3> l3Eps = new ArrayList<>();
125 for (L3Address ip : ep.getL3Address()) {
126 l3Eps.add(new L3Builder().setL3Context(ip.getL3Context()).setIpAddress(ip.getIpAddress()).build());
128 inputBuilder.setL3(l3Eps);
130 return inputBuilder.build();
134 * Create the updated {@link RegisterEndpointInput}, using the existing
135 * {@link Endpoint} and the new OfOverlay augmentation information (i.e.
136 * port name, NodeId, and NodeConnectorId).
138 * @param ep The existing {@link Endpoint} state
139 * @param portName The new port name in the OfOverlay augmentation
140 * @param nodeIdString The new NodeId in the OfOverlay augmentation
141 * @param nodeConnectorIdString The new NodeConnectorId in the OfOverlay augmentation
142 * @return The new {@link RegisterEndpointInput}, null if failure
144 public static RegisterEndpointInput createRegisterEndpointInput(Endpoint ep,
145 String portName, String nodeIdString, String nodeConnectorIdString) {
147 org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId invNodeId =
148 new org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId(nodeIdString);
149 org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId ncId =
150 new org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId(nodeConnectorIdString);
152 RegisterEndpointInputBuilder inputBuilder = new RegisterEndpointInputBuilder().setL2Context(
154 .setMacAddress(new MacAddress(ep.getMacAddress()))
155 .setTenant(new TenantId(ep.getTenant()))
156 .setEndpointGroups(ep.getEndpointGroups())
157 .addAugmentation(OfOverlayContextInput.class,
158 new OfOverlayContextInputBuilder()
159 .setPortName(new Name(portName))
160 .setNodeId(invNodeId)
161 .setNodeConnectorId(ncId)
163 .setTimestamp(System.currentTimeMillis());
165 // TODO Li msunal this getting of just first IP has to be rewrite when OFOverlay renderer
166 // will support l3-endpoints. Then we will register L2 and L3 endpoints separately.
167 if (ep.getNetworkContainment() != null) {
168 inputBuilder.setNetworkContainment(new SubnetId(ep.getNetworkContainment()));
169 L3Address l3Address = new L3AddressBuilder()
170 .setIpAddress(ep.getL3Address().get(0).getIpAddress())
171 .setL3Context(ep.getL3Address().get(0).getL3Context())
173 inputBuilder.setL3Address(ImmutableList.of(l3Address));
175 return inputBuilder.build();