neutron-mapper/src/main/java/org/opendaylight/groupbasedpolicy/neutron/mapper/util/MappingUtils.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, 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.groupbasedpolicy.neutron.mapper.util;
  10
  11 import org.opendaylight.groupbasedpolicy.api.sf.AllowActionDefinition;
  12 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  13 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpPrefix;
  14 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
  15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Prefix;
  16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ActionName;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ContextId;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.EndpointGroupId;
  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.NetworkDomainId;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.L3Context;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.L2BridgeDomain;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.L2FloodDomain;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.Subnet;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.rev160427.ContextType;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.rev160427.forwarding.fields.Parent;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.rev160427.forwarding.fields.ParentBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.neutron.gbp.mapper.rev150513.change.action.of.security.group.rules.input.action.ActionChoice;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.neutron.gbp.mapper.rev150513.change.action.of.security.group.rules.input.action.action.choice.AllowActionCaseBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.neutron.gbp.mapper.rev150513.change.action.of.security.group.rules.input.action.action.choice.SfcActionCaseBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.neutron.gbp.mapper.rev150513.change.action.of.security.group.rules.input.action.action.choice.allow.action._case.AllowBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.action.refs.ActionRef;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.action.refs.ActionRefBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.subject.feature.instances.ActionInstance;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.subject.feature.instances.ActionInstanceBuilder;
  37
  38 public final class MappingUtils {
  39
  40     public static final String NEUTRON_ROUTER = "neutron_router-";
  41     public static final String NEUTRON_EXTERNAL = "neutron_external_network-";
  42     public static final String NEUTRON_GROUP = "neutron_group-";
  43     public static final IpPrefix DEFAULT_ROUTE = new IpPrefix(new Ipv4Prefix("0.0.0.0/0"));
  44     public static final ActionInstance ACTION_ALLOW = new ActionInstanceBuilder().setName(
  45             new ActionName("Allow"))
  46         .setActionDefinitionId(AllowActionDefinition.DEFINITION.getId())
  47         .build();
  48     public static final ActionChoice ALLOW_ACTION_CHOICE = new AllowActionCaseBuilder().setAllow(
  49             new AllowBuilder().build()).build();
  50     public static final ActionRef ACTION_REF_ALLOW =
  51             new ActionRefBuilder().setName(ACTION_ALLOW.getName()).setOrder(0).build();
  52     public static final Uuid EIG_UUID = new Uuid("eeeaa3a2-e9ba-44e0-a462-bea923d30e38");
  53     public static final EndpointGroupId EPG_EXTERNAL_ID = new EndpointGroupId(EIG_UUID.getValue());
  54
  55     public static final String NAME_VALUE_DELIMETER = "-";
  56     public static final String NAME_DELIMETER = "_";
  57     public static final String NAME_DOUBLE_DELIMETER = "__";
  58
  59     // Network domains defined here to overcome package conflict resolution
  60     public static final Class<L3Context> L3_CONTEXT = L3Context.class;
  61     public static final Class<L2BridgeDomain> L2_BRDIGE_DOMAIN = L2BridgeDomain.class;
  62     public static final Class<L2FloodDomain> L2_FLOOD_DOMAIN = L2FloodDomain.class;
  63     public static final Class<Subnet> SUBNET = Subnet.class;
  64
  65     private MappingUtils() {
  66         throw new UnsupportedOperationException("Cannot create an instance.");
  67     }
  68
  69     public static ActionRef createSfcActionRef(String sfcChainName) {
  70         return new ActionRefBuilder().setName(new ActionName(sfcChainName)).setOrder(0).build();
  71     }
  72
  73     public static ActionChoice createSfcActionChoice(String chainName) {
  74         return new SfcActionCaseBuilder().setSfcChainName(chainName).build();
  75     }
  76
  77     public static <T extends ContextType> Parent createParent(ContextId id, Class<T> domainType) {
  78         return new ParentBuilder().setContextId(id).setContextType(domainType).build();
  79     }
  80
  81     public static <T extends ContextType> Parent createParent(NetworkDomainId id, Class<T> domainType) {
  82         return new ParentBuilder().setContextId(new ContextId(id.getValue())).setContextType(domainType).build();
  83     }
  84
  85     public static IpPrefix ipAddressToIpPrefix(char[] address) {
  86         return ipAddressToIpPrefix(new IpAddress(address));
  87     }
  88
  89     public static IpPrefix ipAddressToIpPrefix(IpAddress address) {
  90         if (address.getIpv4Address() != null) {
  91             return new IpPrefix(new Ipv4Prefix(ipv4PrefixOf(address)));
  92         } else if (address.getIpv6Address() != null) {
  93             return new IpPrefix(new Ipv6Prefix(ipv6PrefixOf(address)));
  94         }
  95         throw new IllegalArgumentException("Ip address [{}] is not a valid Ipv4 or Ipv6 address." + address);
  96     }
  97
  98     public static String ipAddressToStringIpPrefix(String address) {
  99         return ipAddressToStringIpPrefix(new IpAddress(address.toCharArray()));
 100     }
 101
 102     public static String ipAddressToStringIpPrefix(char[] address) {
 103         return ipAddressToStringIpPrefix(new IpAddress(address));
 104     }
 105
 106     public static String ipAddressToStringIpPrefix(IpAddress address) {
 107         if (address.getIpv4Address() != null) {
 108             return ipv4PrefixOf(address);
 109         } else if (address.getIpv6Address() != null) {
 110             return ipv6PrefixOf(address);
 111         }
 112         throw new IllegalArgumentException("Ip address [{}] is not a valid Ipv4 or Ipv6 address." + address);
 113     }
 114
 115     private static String ipv4PrefixOf(IpAddress ipAddress) {
 116         return new String(ipAddress.getValue()) + "/32";
 117     }
 118
 119     private static String ipv6PrefixOf(IpAddress ipAddress) {
 120         return new String(ipAddress.getValue()) + "/128";
 121     }
 122
 123     public static IpAddress ipPrefixToIpAddress(char[] ipPrefix) {
 124         return ipPrefixToIpAddress(new IpPrefix(ipPrefix));
 125     }
 126
 127     public static IpAddress ipPrefixToIpAddress(IpPrefix prefix) {
 128         return new IpAddress(ipPrefixToStringIpAddress(prefix).toCharArray());
 129     }
 130
 131     public static String ipPrefixToStringIpAddress(IpPrefix prefix) {
 132         if (prefix.getIpv4Prefix() != null) {
 133             String[] split = prefix.getIpv4Prefix().getValue().split("/");
 134             return split[0];
 135
 136         } else if (prefix.getIpv6Prefix() != null) {
 137             String[] split = prefix.getIpv6Prefix().getValue().split("/");
 138             return split[0];
 139         }
 140         throw new IllegalArgumentException("Cannot extract IP prefix from IP address {}" + prefix);
 141     }
 142 }