openstack/net-virt/src/main/java/org/opendaylight/netvirt/openstack/netvirt/translator/crud/impl/NeutronSecurityGroupInterface.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.netvirt.openstack.netvirt.translator.crud.impl;
  10
  11 import java.util.ArrayList;
  12 import java.util.HashSet;
  13 import java.util.List;
  14 import java.util.Set;
  15
  16 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
  17 import org.opendaylight.netvirt.openstack.netvirt.translator.crud.INeutronSecurityRuleCRUD;
  18 import org.opendaylight.netvirt.openstack.netvirt.translator.NeutronSecurityGroup;
  19 import org.opendaylight.netvirt.openstack.netvirt.translator.NeutronSecurityRule;
  20 import org.opendaylight.netvirt.openstack.netvirt.translator.crud.INeutronSecurityGroupCRUD;
  21 import org.opendaylight.netvirt.openstack.netvirt.translator.crud.NeutronCRUDInterfaces;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.groups.attributes.SecurityGroups;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.groups.attributes.security.groups.SecurityGroup;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.groups.attributes.security.groups.SecurityGroupBuilder;
  27 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  28 import org.osgi.framework.BundleContext;
  29 import org.osgi.framework.ServiceRegistration;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33
  34 public class NeutronSecurityGroupInterface extends AbstractNeutronInterface<SecurityGroup,NeutronSecurityGroup> implements INeutronSecurityGroupCRUD {
  35
  36     private static final Logger LOGGER = LoggerFactory.getLogger(NeutronSecurityGroupInterface.class);
  37
  38     NeutronSecurityGroupInterface(ProviderContext providerContext) {
  39         super(providerContext);
  40     }
  41
  42     @Override
  43     public boolean neutronSecurityGroupExists(String uuid) {
  44         SecurityGroup group = readMd(createInstanceIdentifier(toMd(uuid)));
  45         if (group == null) {
  46             return false;
  47         }
  48         return true;
  49     }
  50
  51     @Override
  52     public NeutronSecurityGroup getNeutronSecurityGroup(String uuid) {
  53         SecurityGroup group = readMd(createInstanceIdentifier(toMd(uuid)));
  54         if (group == null) {
  55             return null;
  56         }
  57         return fromMd(group);
  58     }
  59
  60     @Override
  61     public List<NeutronSecurityGroup> getAllNeutronSecurityGroups() {
  62         Set<NeutronSecurityGroup> allSecurityGroups = new HashSet<>();
  63         SecurityGroups groups = readMd(createInstanceIdentifier());
  64         if (groups != null) {
  65             for (SecurityGroup group: groups.getSecurityGroup()) {
  66                 allSecurityGroups.add(fromMd(group));
  67             }
  68         }
  69         LOGGER.debug("Exiting getSecurityGroups, Found {} OpenStackSecurityGroup", allSecurityGroups.size());
  70         List<NeutronSecurityGroup> ans = new ArrayList<>();
  71         ans.addAll(allSecurityGroups);
  72         return ans;
  73     }
  74
  75     @Override
  76     public boolean addNeutronSecurityGroup(NeutronSecurityGroup input) {
  77         if (neutronSecurityGroupExists(input.getID())) {
  78             return false;
  79         }
  80         addMd(input);
  81         return true;
  82     }
  83
  84     @Override
  85     public boolean removeNeutronSecurityGroup(String uuid) {
  86         if (!neutronSecurityGroupExists(uuid)) {
  87             return false;
  88         }
  89         removeMd(toMd(uuid));
  90         return true;
  91     }
  92
  93     @Override
  94     public boolean updateNeutronSecurityGroup(String uuid, NeutronSecurityGroup delta) {
  95         if (!neutronSecurityGroupExists(uuid)) {
  96             return false;
  97         }
  98         updateMd(delta);
  99         return true;
 100     }
 101
 102     @Override
 103     public boolean neutronSecurityGroupInUse(String securityGroupUUID) {
 104         return !neutronSecurityGroupExists(securityGroupUUID);
 105     }
 106
 107     protected NeutronSecurityGroup fromMd(SecurityGroup group) {
 108         NeutronSecurityGroup answer = new NeutronSecurityGroup();
 109         if (group.getName() != null) {
 110             answer.setSecurityGroupName(group.getName());
 111         }
 112         if (group.getDescription() != null) {
 113             answer.setSecurityGroupDescription(group.getDescription());
 114         }
 115         if (group.getTenantId() != null) {
 116             answer.setSecurityGroupTenantID(group.getTenantId().getValue().replace("-",""));
 117         }
 118
 119         // Bug 4550
 120         // https://bugs.opendaylight.org/show_bug.cgi?id=4550
 121         // Now SecurityGroup::securityGroupRule isn't updated.
 122         // always rebuid it from security group rules
 123         NeutronCRUDInterfaces interfaces = new NeutronCRUDInterfaces()
 124             .fetchINeutronSecurityRuleCRUD(this);
 125         INeutronSecurityRuleCRUD srCrud = interfaces.getSecurityRuleInterface();
 126
 127         List<NeutronSecurityRule> rules = new ArrayList<>();
 128         String sgId = group.getUuid().getValue();
 129         for (NeutronSecurityRule rule: srCrud.getAllNeutronSecurityRules()) {
 130             if (rule.getSecurityRuleGroupID().equals(sgId)) {
 131                 rules.add(rule);
 132             }
 133         }
 134         answer.setSecurityRules(rules);
 135
 136         if (group.getUuid() != null) {
 137             answer.setID(group.getUuid().getValue());
 138         }
 139         return answer;
 140     }
 141
 142     @Override
 143     protected SecurityGroup toMd(NeutronSecurityGroup securityGroup) {
 144         SecurityGroupBuilder securityGroupBuilder = new SecurityGroupBuilder();
 145         if (securityGroup.getSecurityGroupName() != null) {
 146             securityGroupBuilder.setName(securityGroup.getSecurityGroupName());
 147         }
 148         if (securityGroup.getSecurityGroupDescription() != null) {
 149             securityGroupBuilder.setDescription(securityGroup.getSecurityGroupDescription());
 150         }
 151         if (securityGroup.getSecurityGroupTenantID() != null) {
 152             securityGroupBuilder.setTenantId(toUuid(securityGroup.getSecurityGroupTenantID()));
 153         }
 154
 155         // don't update security group rule, always empty list
 156         // Bug 4550
 157         // https://bugs.opendaylight.org/show_bug.cgi?id=4550
 158         securityGroupBuilder.setSecurityRules(new ArrayList<>());
 159
 160         if (securityGroup.getID() != null) {
 161             securityGroupBuilder.setUuid(toUuid(securityGroup.getID()));
 162         } else {
 163             LOGGER.warn("Attempting to write neutron securityGroup without UUID");
 164         }
 165
 166         return securityGroupBuilder.build();
 167     }
 168
 169     @Override
 170     protected InstanceIdentifier<SecurityGroup> createInstanceIdentifier(SecurityGroup securityGroup) {
 171         return InstanceIdentifier.create(Neutron.class)
 172             .child(SecurityGroups.class).child(SecurityGroup.class,
 173                                                securityGroup.getKey());
 174     }
 175
 176     protected InstanceIdentifier<SecurityGroups> createInstanceIdentifier() {
 177         return InstanceIdentifier.create(Neutron.class)
 178             .child(SecurityGroups.class);
 179     }
 180
 181     @Override
 182     protected SecurityGroup toMd(String uuid) {
 183         SecurityGroupBuilder securityGroupBuilder = new SecurityGroupBuilder();
 184         securityGroupBuilder.setUuid(toUuid(uuid));
 185         return securityGroupBuilder.build();
 186     }
 187
 188     public static void registerNewInterface(BundleContext context,
 189                                             ProviderContext providerContext,
 190                                             List<ServiceRegistration<?>> registrations) {
 191         NeutronSecurityGroupInterface neutronSecurityGroupInterface = new NeutronSecurityGroupInterface(providerContext);
 192         ServiceRegistration<INeutronSecurityGroupCRUD> neutronSecurityGroupInterfaceRegistration = context.registerService(INeutronSecurityGroupCRUD.class, neutronSecurityGroupInterface, null);
 193         if(neutronSecurityGroupInterfaceRegistration != null) {
 194             registrations.add(neutronSecurityGroupInterfaceRegistration);
 195         }
 196     }
 197 }