renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/sf/EtherTypeClassifier.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.renderer.ofoverlay.sf;
  10
  11 import java.util.List;
  12 import java.util.Map;
  13
  14 import com.google.common.collect.ImmutableList;
  15
  16 import org.opendaylight.groupbasedpolicy.api.sf.EtherTypeClassifierDefinition;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClassifierDefinitionId;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ParameterName;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definitions.ClassifierDefinition;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.instance.ParameterValue;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.has.parameters.type.parameter.type.IntBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.supported.classifier.definition.SupportedParameterValues;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.supported.classifier.definition.SupportedParameterValuesBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.supported._int.value.fields.SupportedIntValue;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.supported._int.value.fields.SupportedIntValueBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetType;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetTypeBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatchBuilder;
  31
  32 /**
  33  * Match on the ether type of the traffic
  34  */
  35 public class EtherTypeClassifier extends Classifier {
  36
  37     protected EtherTypeClassifier(Classifier parent) {
  38         super(parent);
  39     }
  40
  41     @Override
  42     public ClassifierDefinitionId getId() {
  43         return EtherTypeClassifierDefinition.ID;
  44     }
  45
  46     @Override
  47     public ClassifierDefinition getClassifierDefinition() {
  48         return EtherTypeClassifierDefinition.DEFINITION;
  49     }
  50
  51     @Override
  52     public List<SupportedParameterValues> getSupportedParameterValues() {
  53
  54         List<SupportedIntValue> values = ImmutableList.of(
  55                 new SupportedIntValueBuilder().setValue(EtherTypeClassifierDefinition.ARP_VALUE).build(),
  56                 new SupportedIntValueBuilder().setValue(EtherTypeClassifierDefinition.IPv4_VALUE).build(),
  57                 new SupportedIntValueBuilder().setValue(EtherTypeClassifierDefinition.IPv6_VALUE).build());
  58         SupportedParameterValuesBuilder b = new SupportedParameterValuesBuilder();
  59         b.setParameterName(new ParameterName(EtherTypeClassifierDefinition.ETHERTYPE_PARAM));
  60         b.setParameterType(new IntBuilder().setSupportedIntValue(values).build());
  61
  62         return ImmutableList.of(b.build());
  63     }
  64
  65     @Override
  66     protected void checkPresenceOfRequiredParams(Map<String, ParameterValue> params) {
  67         if (params.get(EtherTypeClassifierDefinition.ETHERTYPE_PARAM) == null) {
  68             throw new IllegalArgumentException(
  69                     "Parameter " + EtherTypeClassifierDefinition.ETHERTYPE_PARAM + " " + MSG_NOT_SPECIFIED);
  70         }
  71         if (params.get(EtherTypeClassifierDefinition.ETHERTYPE_PARAM).getIntValue() == null) {
  72             throw new IllegalArgumentException(
  73                     "Value of " + EtherTypeClassifierDefinition.ETHERTYPE_PARAM + " " + MSG_PARAMETER_IS_NOT_PRESENT);
  74         }
  75     }
  76
  77     @Override
  78     protected List<MatchBuilder> update(List<MatchBuilder> matches, Map<String, ParameterValue> params) {
  79         Long type = params.get(EtherTypeClassifierDefinition.ETHERTYPE_PARAM).getIntValue();
  80         for (MatchBuilder match : matches) {
  81             EthernetMatchBuilder em;
  82             if (match.getEthernetMatch() != null) {
  83                 equalOrNotSetValidation(match.getEthernetMatch().getEthernetType(), type);
  84                 continue;
  85             } else {
  86                 em = new EthernetMatchBuilder();
  87             }
  88             em.setEthernetType(new EthernetTypeBuilder().setType(new EtherType(type)).build());
  89             match.setEthernetMatch(em.build());
  90         }
  91         return matches;
  92     }
  93
  94     private void equalOrNotSetValidation(EthernetType ethTypeInMatch, long paramValue) {
  95         if (ethTypeInMatch != null) {
  96             if (paramValue != ethTypeInMatch.getType().getValue()) {
  97                 throw new IllegalArgumentException(MSG_CLASSIFICATION_CONFLICT_DETECTED + " at "
  98                         + EtherTypeClassifierDefinition.ETHERTYPE_PARAM + " parameter for values "
  99                         + ethTypeInMatch.getType().getValue() + " and " + paramValue + ". It is not allowed "
 100                         + "to assign different values to the same parameter among all the classifiers within one rule.");
 101             }
 102         }
 103     }
 104
 105     @Override
 106     protected void checkPrereqs(List<MatchBuilder> matches) {
 107         // So far EthType has no prereqs.
 108     }
 109 }