transcriber/src/main/java/org/opendaylight/neutron/transcriber/NeutronLoadBalancerPoolInterface.java

   1 /*
   2  * Copyright (c) 2014, 2015 Red Hat, 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
   9 package org.opendaylight.neutron.transcriber;
  10
  11 import java.util.ArrayList;
  12 import java.util.HashSet;
  13 import java.util.List;
  14 import java.util.Set;
  15 import java.util.concurrent.ExecutionException;
  16
  17 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  18 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  20 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  21 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  22 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
  23 import org.opendaylight.neutron.spi.INeutronLoadBalancerPoolCRUD;
  24 import org.opendaylight.neutron.spi.NeutronLoadBalancerPool;
  25 import org.opendaylight.neutron.spi.NeutronLoadBalancerPoolMember;
  26 import org.opendaylight.neutron.spi.NeutronLoadBalancer_SessionPersistence;
  27 import org.opendaylight.neutron.spi.Neutron_ID;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.ProtocolBase;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.ProtocolHttp;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.ProtocolHttps;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.ProtocolTcp;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.ProtocolTerminatedHttps;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.lbaasv2.rev150712.lbaas.attributes.Pools;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.lbaasv2.rev150712.lbaas.attributes.pools.Pool;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.lbaasv2.rev150712.lbaas.attributes.pools.PoolBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.lbaasv2.rev150712.lbaas.attributes.pools.pool.Members;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.lbaasv2.rev150712.lbaas.attributes.pools.pool.members.Member;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.lbaasv2.rev150712.lbaas.attributes.pools.pool.members.MemberBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.lbaasv2.rev150712.pool.attributes.SessionPersistenceBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44 import org.osgi.framework.BundleContext;
  45 import org.osgi.framework.ServiceRegistration;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 import com.google.common.base.Optional;
  50 import com.google.common.collect.ImmutableBiMap;
  51 import com.google.common.util.concurrent.CheckedFuture;
  52
  53 public class NeutronLoadBalancerPoolInterface extends AbstractNeutronInterface<Pool, Pools, NeutronLoadBalancerPool> implements INeutronLoadBalancerPoolCRUD {
  54     private static final Logger LOGGER = LoggerFactory.getLogger(NeutronLoadBalancerPoolInterface.class);
  55
  56     private static final ImmutableBiMap<Class<? extends ProtocolBase>,String> PROTOCOL_MAP
  57             = new ImmutableBiMap.Builder<Class<? extends ProtocolBase>,String>()
  58             .put(ProtocolHttp.class,"HTTP")
  59             .put(ProtocolHttps.class,"HTTPS")
  60             .put(ProtocolTcp.class,"TCP")
  61             .put(ProtocolTerminatedHttps.class,"TERMINATED_HTTPS")
  62             .build();
  63
  64     NeutronLoadBalancerPoolInterface(ProviderContext providerContext) {
  65         super(providerContext);
  66     }
  67
  68     @Override
  69     public boolean neutronLoadBalancerPoolExists(String uuid) {
  70         return exists(uuid);
  71     }
  72
  73     @Override
  74     public NeutronLoadBalancerPool getNeutronLoadBalancerPool(String uuid) {
  75         return get(uuid);
  76     }
  77
  78     @Override
  79     protected List<Pool> getDataObjectList(Pools pools) {
  80         return pools.getPool();
  81     }
  82
  83     @Override
  84     public List<NeutronLoadBalancerPool> getAllNeutronLoadBalancerPools() {
  85         return getAll();
  86     }
  87
  88     @Override
  89     public boolean addNeutronLoadBalancerPool(NeutronLoadBalancerPool input) {
  90         //TODO: add code to find INeutronLoadBalancerPoolAware services and call newtorkCreated on them
  91         return add(input);
  92     }
  93
  94     @Override
  95     public boolean removeNeutronLoadBalancerPool(String uuid) {
  96         return remove(uuid);
  97     }
  98
  99     @Override
 100     public boolean updateNeutronLoadBalancerPool(String uuid, NeutronLoadBalancerPool delta) {
 101         return update(uuid, delta);
 102     }
 103
 104     @Override
 105     public boolean neutronLoadBalancerPoolInUse(String loadBalancerPoolUUID) {
 106         return !exists(loadBalancerPoolUUID);
 107     }
 108
 109     @Override
 110     protected Pool toMd(String uuid) {
 111         PoolBuilder poolBuilder = new PoolBuilder();
 112         poolBuilder.setUuid(toUuid(uuid));
 113         return poolBuilder.build();
 114     }
 115
 116     @Override
 117     protected InstanceIdentifier<Pool> createInstanceIdentifier(Pool pool) {
 118         return InstanceIdentifier.create(Neutron.class)
 119                 .child(Pools.class)
 120                 .child(Pool.class, pool.getKey());
 121     }
 122
 123     @Override
 124     protected InstanceIdentifier<Pools> createInstanceIdentifier() {
 125         return InstanceIdentifier.create(Neutron.class)
 126                 .child(Pools.class);
 127     }
 128
 129     @Override
 130     protected Pool toMd(NeutronLoadBalancerPool pool) {
 131         PoolBuilder poolBuilder = new PoolBuilder();
 132         poolBuilder.setAdminStateUp(pool.getLoadBalancerPoolAdminIsStateIsUp());
 133         if (pool.getLoadBalancerPoolDescription() != null) {
 134             poolBuilder.setDescr(pool.getLoadBalancerPoolDescription());
 135         }
 136         if (pool.getNeutronLoadBalancerPoolHealthMonitorID() != null) {
 137             poolBuilder.setHealthmonitorId(toUuid(pool.getNeutronLoadBalancerPoolHealthMonitorID()));
 138         }
 139         if (pool.getLoadBalancerPoolLbAlgorithm() != null) {
 140             poolBuilder.setLbAlgorithm(pool.getLoadBalancerPoolLbAlgorithm());
 141         }
 142         if (pool.getLoadBalancerPoolListeners() != null) {
 143             List<Uuid> listListener = new ArrayList<Uuid>();
 144             for (Neutron_ID neutron_id : pool.getLoadBalancerPoolListeners()) {
 145                 listListener.add(toUuid(neutron_id.getID()));
 146             }
 147             poolBuilder.setListeners(listListener);
 148         }
 149         // because members are another container, we don't want to copy
 150         // it over, so just skip it here
 151         if (pool.getLoadBalancerPoolName() != null) {
 152             poolBuilder.setName(pool.getLoadBalancerPoolName());
 153         }
 154         if (pool.getLoadBalancerPoolProtocol() != null) {
 155             ImmutableBiMap<String, Class<? extends ProtocolBase>> mapper =
 156                 PROTOCOL_MAP.inverse();
 157             poolBuilder.setProtocol((Class<? extends ProtocolBase>) mapper.get(pool.getLoadBalancerPoolProtocol()));
 158         }
 159         if (pool.getLoadBalancerPoolSessionPersistence() != null) {
 160             NeutronLoadBalancer_SessionPersistence sessionPersistence = pool.getLoadBalancerPoolSessionPersistence();
 161             SessionPersistenceBuilder sessionPersistenceBuilder = new SessionPersistenceBuilder();
 162             sessionPersistenceBuilder.setCookieName(sessionPersistence.getCookieName());
 163             sessionPersistenceBuilder.setType(sessionPersistence.getType());
 164             poolBuilder.setSessionPersistence(sessionPersistenceBuilder.build());
 165         }
 166         if (pool.getTenantID() != null) {
 167             poolBuilder.setTenantId(toUuid(pool.getTenantID()));
 168         }
 169         if (pool.getID() != null) {
 170             poolBuilder.setUuid(toUuid(pool.getID()));
 171         } else {
 172             LOGGER.warn("Attempting to write neutron load balancer pool without UUID");
 173         }
 174         return poolBuilder.build();
 175     }
 176
 177     protected NeutronLoadBalancerPool fromMd(Pool pool) {
 178         NeutronLoadBalancerPool answer = new NeutronLoadBalancerPool();
 179         if (pool.isAdminStateUp() != null) {
 180             answer.setLoadBalancerPoolAdminStateIsUp(pool.isAdminStateUp());
 181         }
 182         if (pool.getDescr() != null) {
 183             answer.setLoadBalancerPoolDescription(pool.getDescr());
 184         }
 185         if (pool.getHealthmonitorId() != null) {
 186             answer.setNeutronLoadBalancerPoolHealthMonitorID(pool.getHealthmonitorId().getValue());
 187         }
 188         if (pool.getLbAlgorithm() != null) {
 189             answer.setLoadBalancerPoolLbAlgorithm(pool.getLbAlgorithm());
 190         }
 191         if (pool.getListeners() != null) {
 192             List<Neutron_ID> ids = new ArrayList<Neutron_ID>();
 193             for (Uuid id : pool.getListeners()) {
 194                 ids.add(new Neutron_ID(id.getValue()));
 195             }
 196             answer.setLoadBalancerPoolListeners(ids);
 197         }
 198         if (pool.getMembers() != null) {
 199             List<NeutronLoadBalancerPoolMember> members = new ArrayList<NeutronLoadBalancerPoolMember>();
 200             for (Member member: pool.getMembers().getMember()) {
 201                 members.add(fromMemberMd(member));
 202             }
 203             answer.setLoadBalancerPoolMembers(members);
 204         }
 205         if (pool.getName() != null) {
 206             answer.setLoadBalancerPoolName(pool.getName());
 207         }
 208         if (pool.getProtocol() != null) {
 209             answer.setLoadBalancerPoolProtocol(PROTOCOL_MAP.get(pool.getProtocol()));
 210         }
 211         if (pool.getSessionPersistence() != null) {
 212             NeutronLoadBalancer_SessionPersistence sessionPersistence = new NeutronLoadBalancer_SessionPersistence();
 213             sessionPersistence.setCookieName(pool.getSessionPersistence().getCookieName());
 214             sessionPersistence.setType(pool.getSessionPersistence().getType());
 215
 216             answer.setLoadBalancerSessionPersistence(sessionPersistence);
 217         }
 218         if (pool.getTenantId() != null) {
 219             answer.setTenantID(pool.getTenantId());
 220         }
 221         if (pool.getUuid() != null) {
 222             answer.setID(pool.getUuid().getValue());
 223         }
 224         return answer;
 225     }
 226
 227     public static void registerNewInterface(BundleContext context,
 228                                             ProviderContext providerContext,
 229                                             List<ServiceRegistration<?>> registrations) {
 230         NeutronLoadBalancerPoolInterface neutronLoadBalancerPoolInterface = new NeutronLoadBalancerPoolInterface(providerContext);
 231         ServiceRegistration<INeutronLoadBalancerPoolCRUD> neutronLoadBalancerPoolInterfaceRegistration = context.registerService(INeutronLoadBalancerPoolCRUD.class, neutronLoadBalancerPoolInterface, null);
 232         if(neutronLoadBalancerPoolInterfaceRegistration != null) {
 233             registrations.add(neutronLoadBalancerPoolInterfaceRegistration);
 234         }
 235     }
 236
 237     public boolean neutronLoadBalancerPoolMemberExists(String poolUuid, String uuid) {
 238         Member member = readMemberMd(
 239                 createMemberInstanceIdentifier(toMd(poolUuid),
 240                                                toMemberMd(uuid)));
 241         if (member == null) {
 242             return false;
 243         }
 244         return true;
 245     }
 246
 247     public NeutronLoadBalancerPoolMember getNeutronLoadBalancerPoolMember(
 248             String poolUuid, String uuid) {
 249         Member member = readMemberMd(
 250                 createMemberInstanceIdentifier(toMd(poolUuid),
 251                                                toMemberMd(uuid)));
 252         if (member == null) {
 253             return null;
 254         }
 255         return fromMemberMd(member);
 256     }
 257
 258     public List<NeutronLoadBalancerPoolMember> getAllNeutronLoadBalancerPoolMembers(String poolUuid) {
 259         Set<NeutronLoadBalancerPoolMember> allLoadBalancerPoolMembers = new HashSet<NeutronLoadBalancerPoolMember>();
 260         Members members = readMd(createMembersInstanceIdentifier(toMd(poolUuid)));
 261         if (members != null) {
 262             for (Member member: members.getMember()) {
 263                 allLoadBalancerPoolMembers.add(fromMemberMd(member));
 264             }
 265         }
 266         LOGGER.debug("Exiting getLoadBalancerPoolMembers, Found {} OpenStackLoadBalancerPoolMember",
 267                 allLoadBalancerPoolMembers.size());
 268         List<NeutronLoadBalancerPoolMember> ans = new ArrayList<NeutronLoadBalancerPoolMember>();
 269         ans.addAll(allLoadBalancerPoolMembers);
 270         return ans;
 271     }
 272
 273     public boolean addNeutronLoadBalancerPoolMember(String poolUuid, NeutronLoadBalancerPoolMember input) {
 274         if (neutronLoadBalancerPoolMemberExists(poolUuid, input.getID())) {
 275             return false;
 276         }
 277         addMemberMd(toMd(poolUuid), input);
 278         return true;
 279     }
 280
 281     public boolean removeNeutronLoadBalancerPoolMember(String poolUuid, String uuid) {
 282         if (!neutronLoadBalancerPoolMemberExists(poolUuid, uuid)) {
 283             return false;
 284         }
 285         return removeMemberMd(toMd(poolUuid), toMemberMd(uuid));
 286     }
 287
 288     public boolean updateNeutronLoadBalancerPoolMember(String poolUuid,
 289             String uuid, NeutronLoadBalancerPoolMember delta) {
 290         if (!neutronLoadBalancerPoolMemberExists(poolUuid, uuid)) {
 291             return false;
 292         }
 293         updateMemberMd(toMd(poolUuid), delta);
 294         return true;
 295     }
 296
 297     public boolean neutronLoadBalancerPoolMemberInUse(String poolUuid,
 298             String loadBalancerPoolMemberID) {
 299         return !neutronLoadBalancerPoolMemberExists(poolUuid,
 300                                                     loadBalancerPoolMemberID);
 301     }
 302
 303     protected InstanceIdentifier<Member> createMemberInstanceIdentifier(Pool pool,
 304             Member item) {
 305         return InstanceIdentifier.create(Neutron.class)
 306             .child(Pools.class)
 307             .child(Pool.class, pool.getKey())
 308             .child(Members.class)
 309             .child(Member.class, item.getKey());
 310     }
 311
 312     protected InstanceIdentifier<Members> createMembersInstanceIdentifier(Pool pool) {
 313         return InstanceIdentifier.create(Neutron.class)
 314             .child(Pools.class)
 315             .child(Pool.class, pool.getKey())
 316             .child(Members.class);
 317     }
 318
 319     static NeutronLoadBalancerPoolMember fromMemberMd(Member member) {
 320         NeutronLoadBalancerPoolMember answer = new NeutronLoadBalancerPoolMember();
 321         if (member.isAdminStateUp() != null) {
 322             answer.setPoolMemberAdminStateIsUp(member.isAdminStateUp());
 323         }
 324         if (member.getAddress() != null) {
 325             answer.setPoolMemberAddress(String.valueOf(member.getAddress().getValue()));
 326         }
 327         if (member.getProtocolPort() != null) {
 328             answer.setPoolMemberProtoPort(member.getProtocolPort());
 329         }
 330         if (member.getUuid() != null) {
 331             answer.setID(member.getUuid().getValue());
 332             answer.setPoolID(member.getUuid().getValue());
 333         }
 334         if (member.getSubnetId() != null) {
 335             answer.setPoolMemberSubnetID(member.getSubnetId().getValue());
 336         }
 337         if (member.getTenantId() != null) {
 338             answer.setTenantID(member.getTenantId());
 339         }
 340         if (member.getWeight() != null) {
 341             answer.setPoolMemberWeight(member.getWeight());
 342         }
 343         return answer;
 344     }
 345
 346     protected Member toMemberMd(NeutronLoadBalancerPoolMember member) {
 347         MemberBuilder memberBuilder = new MemberBuilder();
 348         memberBuilder.setAdminStateUp(member.getPoolMemberAdminStateIsUp());
 349         if (member.getPoolMemberAddress() != null) {
 350             IpAddress ipAddress = new IpAddress(member.getPoolMemberAddress().toCharArray());
 351             memberBuilder.setAddress(ipAddress);
 352         }
 353         if (member.getPoolMemberProtoPort() != null) {
 354             memberBuilder.setProtocolPort(member.getPoolMemberProtoPort());
 355         }
 356         if (member.getID() != null) {
 357             memberBuilder.setUuid(toUuid(member.getID()));
 358         }
 359         if (member.getPoolMemberSubnetID() != null) {
 360             memberBuilder.setSubnetId(toUuid(member.getPoolMemberSubnetID()));
 361         }
 362         if (member.getTenantID() != null) {
 363             memberBuilder.setTenantId(toUuid(member.getTenantID()));
 364         }
 365         if (member.getPoolMemberWeight() != null) {
 366             memberBuilder.setWeight(member.getPoolMemberWeight());
 367         }
 368         return memberBuilder.build();
 369     }
 370
 371     protected Member toMemberMd(String uuid) {
 372         MemberBuilder memberBuilder = new MemberBuilder();
 373         memberBuilder.setUuid(toUuid(uuid));
 374         return memberBuilder.build();
 375     }
 376
 377     protected <T extends org.opendaylight.yangtools.yang.binding.DataObject> T readMemberMd(InstanceIdentifier<T> path) {
 378         T result = null;
 379         final ReadOnlyTransaction transaction = getDataBroker().newReadOnlyTransaction();
 380         CheckedFuture<Optional<T>, ReadFailedException> future = transaction.read(LogicalDatastoreType.CONFIGURATION, path);
 381         if (future != null) {
 382             Optional<T> optional;
 383             try {
 384                 optional = future.checkedGet();
 385                 if (optional.isPresent()) {
 386                     result = optional.get();
 387                 }
 388             } catch (ReadFailedException e) {
 389                 LOGGER.warn("Failed to read {}", path, e);
 390             }
 391         }
 392         transaction.close();
 393         return result;
 394     }
 395
 396     protected boolean addMemberMd(Pool pool, NeutronLoadBalancerPoolMember neutronObject) {
 397         // TODO think about adding existence logic
 398         return updateMemberMd(pool, neutronObject);
 399     }
 400
 401     protected boolean updateMemberMd(Pool pool, NeutronLoadBalancerPoolMember neutronObject) {
 402         WriteTransaction transaction = getDataBroker().newWriteOnlyTransaction();
 403         Member item = toMemberMd(neutronObject);
 404         InstanceIdentifier<Member> iid = createMemberInstanceIdentifier(pool, item);
 405         transaction.put(LogicalDatastoreType.CONFIGURATION, iid, item,true);
 406         CheckedFuture<Void, TransactionCommitFailedException> future = transaction.submit();
 407         try {
 408             future.get();
 409         } catch (InterruptedException | ExecutionException e) {
 410             LOGGER.warn("Transation failed ",e);
 411             return false;
 412         }
 413         return true;
 414     }
 415
 416     protected boolean removeMemberMd(Pool pool, Member item) {
 417         WriteTransaction transaction = getDataBroker().newWriteOnlyTransaction();
 418         InstanceIdentifier<Member> iid = createMemberInstanceIdentifier(pool, item);
 419         transaction.delete(LogicalDatastoreType.CONFIGURATION, iid);
 420         CheckedFuture<Void, TransactionCommitFailedException> future = transaction.submit();
 421         try {
 422             future.get();
 423         } catch (InterruptedException | ExecutionException e) {
 424             LOGGER.warn("Transation failed ",e);
 425             return false;
 426         }
 427         return true;
 428     }
 429 }