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