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