neutron-mapper/src/main/java/org/opendaylight/groupbasedpolicy/neutron/mapper/infrastructure/ServiceUtil.java

   1 /*
   2  * Copyright (c) 2017 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.infrastructure;
  10
  11 import java.util.ArrayList;
  12 import java.util.List;
  13
  14 import javax.annotation.Nullable;
  15
  16 import org.opendaylight.groupbasedpolicy.api.sf.EtherTypeClassifierDefinition;
  17 import org.opendaylight.groupbasedpolicy.api.sf.IpProtoClassifierDefinition;
  18 import org.opendaylight.groupbasedpolicy.api.sf.L4ClassifierDefinition;
  19 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.MappingUtils;
  20 import org.opendaylight.groupbasedpolicy.neutron.mapper.util.Utils;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClassifierDefinitionId;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClassifierName;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClauseName;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ContractId;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.Description;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.EndpointGroupId;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.Name;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ParameterName;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.RuleName;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SelectorName;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SubjectName;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.HasDirection.Direction;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.action.refs.ActionRef;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.classifier.refs.ClassifierRef;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.classifier.refs.ClassifierRefBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.endpoint.identification.constraints.EndpointIdentificationConstraintsBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.endpoint.identification.constraints.endpoint.identification.constraints.L3EndpointIdentificationConstraintsBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.has.endpoint.identification.constraints.endpoint.identification.constraints.l3.endpoint.identification.constraints.PrefixConstraintBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.instance.ParameterValue;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.instance.ParameterValueBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.Contract;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.ContractBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.EndpointGroupBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.EndpointGroup.IntraGroupPolicy;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.contract.Clause;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.contract.ClauseBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.contract.Subject;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.contract.clause.ConsumerMatchers;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.contract.clause.ConsumerMatchersBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.contract.clause.ProviderMatchers;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.contract.clause.ProviderMatchersBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.contract.subject.Rule;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.contract.subject.RuleBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.endpoint.group.ConsumerNamedSelector;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.endpoint.group.ConsumerNamedSelectorBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.endpoint.group.ProviderNamedSelector;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.endpoint.group.ProviderNamedSelectorBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.subject.feature.instances.ClassifierInstance;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.policy.subject.feature.instances.ClassifierInstanceBuilder;
  61
  62 import com.google.common.collect.ImmutableList;
  63
  64 public class ServiceUtil {
  65
  66     protected static Contract createContract(ContractId cid, List<Subject> subjects, Description description) {
  67         return new ContractBuilder().setId(cid).setSubject(subjects).setDescription(description).build();
  68     }
  69
  70     protected static ClassifierInstance createClassifInstance(ClassifierName name, ClassifierDefinitionId id,
  71             List<ParameterValue> pv) {
  72         return new ClassifierInstanceBuilder().setName(name)
  73             .setClassifierDefinitionId(id)
  74             .setParameterValue(pv)
  75             .build();
  76     }
  77
  78     protected static EndpointGroupBuilder createEpgBuilder(EndpointGroupId epgId, Name name, Description description) {
  79         return new EndpointGroupBuilder().setId(epgId)
  80             .setName(name)
  81             .setIntraGroupPolicy(IntraGroupPolicy.RequireContract)
  82             .setDescription(description);
  83     }
  84
  85     protected static List<ParameterValue> createParams(long etherType, long proto, @Nullable Long srcPort,
  86             @Nullable Long dstPort) {
  87         List<ParameterValue> params = new ArrayList<>();
  88         if (srcPort != null) {
  89             params.add(new ParameterValueBuilder().setName(new ParameterName(L4ClassifierDefinition.SRC_PORT_PARAM))
  90                 .setIntValue(srcPort)
  91                 .build());
  92         }
  93         if (dstPort != null) {
  94             params.add(new ParameterValueBuilder().setName(new ParameterName(L4ClassifierDefinition.DST_PORT_PARAM))
  95                 .setIntValue(dstPort)
  96                 .build());
  97         }
  98         params.add(new ParameterValueBuilder().setName(new ParameterName(IpProtoClassifierDefinition.PROTO_PARAM))
  99             .setIntValue(proto)
 100             .build());
 101         params.add(new ParameterValueBuilder().setName(new ParameterName(EtherTypeClassifierDefinition.ETHERTYPE_PARAM))
 102             .setIntValue(etherType)
 103             .build());
 104         return params;
 105     }
 106
 107     protected static Clause createClauseWithConsProvEic(@Nullable IpPrefix ipPrefix, SubjectName subjectName) {
 108          ConsumerMatchers consumerMatchers = null;
 109          ProviderMatchers providerMatchers = null;
 110          StringBuilder clauseName = new StringBuilder();
 111          clauseName.append(subjectName.getValue());
 112          if (ipPrefix != null) {
 113              clauseName.append(MappingUtils.NAME_DOUBLE_DELIMETER).append(Utils.getStringIpPrefix(ipPrefix));
 114              consumerMatchers =
 115                      new ConsumerMatchersBuilder()
 116                          .setEndpointIdentificationConstraints(new EndpointIdentificationConstraintsBuilder()
 117                              .setL3EndpointIdentificationConstraints(new L3EndpointIdentificationConstraintsBuilder()
 118                                  .setPrefixConstraint(
 119                                          ImmutableList.of(new PrefixConstraintBuilder().setIpPrefix(ipPrefix).build()))
 120                                  .build())
 121                              .build())
 122                          .build();
 123              providerMatchers =
 124                      new ProviderMatchersBuilder()
 125                          .setEndpointIdentificationConstraints(new EndpointIdentificationConstraintsBuilder()
 126                              .setL3EndpointIdentificationConstraints(new L3EndpointIdentificationConstraintsBuilder()
 127                                  .setPrefixConstraint(
 128                                          ImmutableList.of(new PrefixConstraintBuilder().setIpPrefix(ipPrefix).build()))
 129                                  .build())
 130                              .build())
 131                          .build();
 132          }
 133          return new ClauseBuilder().setName(new ClauseName(clauseName.toString()))
 134              .setSubjectRefs(ImmutableList.of(subjectName))
 135              .setConsumerMatchers(consumerMatchers)
 136              .setProviderMatchers(providerMatchers)
 137              .build();
 138      }
 139
 140     protected static Rule createRuleAllow(ClassifierName classifierName, Direction direction) {
 141          ClassifierName name =
 142                  new ClassifierName(direction.name() + MappingUtils.NAME_DOUBLE_DELIMETER + classifierName.getValue());
 143          ClassifierRef classifierRef = new ClassifierRefBuilder().setName(name)
 144              .setInstanceName(classifierName)
 145              .setDirection(direction)
 146              .build();
 147          return new RuleBuilder().setName(new RuleName(name))
 148              .setActionRef(ImmutableList.<ActionRef>of(MappingUtils.ACTION_REF_ALLOW))
 149              .setClassifierRef(ImmutableList.of(classifierRef))
 150              .build();
 151      }
 152
 153     protected static ProviderNamedSelector createProviderSelector(Contract contract) {
 154          SelectorName selectorName = new SelectorName(contract.getSubject().get(0).getName().getValue());
 155          return new ProviderNamedSelectorBuilder().setName(selectorName)
 156              .setContract(ImmutableList.of(contract.getId()))
 157              .build();
 158      }
 159
 160     protected static ConsumerNamedSelector createConsumerSelector(Contract contract) {
 161          SelectorName selectorName = new SelectorName(contract.getSubject().get(0).getName().getValue());
 162          return new ConsumerNamedSelectorBuilder().setName(selectorName)
 163              .setContract(ImmutableList.of(contract.getId()))
 164              .build();
 165      }
 166 }