groupbasedpolicy/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/sf/L4Classifier.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 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClassifierDefinitionId;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClassifierName;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.Description;
  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.definition.Parameter.IsRequired;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definition.Parameter.Type;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definition.ParameterBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definitions.ClassifierDefinition;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definitions.ClassifierDefinitionBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.TcpMatchBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.UdpMatchBuilder;
  27
  28 import com.google.common.collect.ImmutableList;
  29 import com.google.common.collect.ImmutableMap;
  30
  31 /**
  32  * Match against TCP or UDP, and source and/or destination ports
  33  * @author readams
  34  */
  35 public class L4Classifier extends IpProtoClassifier {
  36     public static final ClassifierDefinitionId ID =
  37             new ClassifierDefinitionId("4250ab32-e8b8-445a-aebb-e1bd2cdd291f");
  38     private static final String SPORT = "sourceport";
  39     private static final String DPORT = "destport";
  40     private static final ClassifierDefinition DEF =
  41             new ClassifierDefinitionBuilder()
  42                 .setId(new ClassifierDefinitionId("4250ab32-e8b8-445a-aebb-e1bd2cdd291f"))
  43                 .setParent(IpProtoClassifier.ID)
  44                 .setName(new ClassifierName("l4"))
  45                 .setDescription(new Description("Match on the port number of UDP or TCP traffic"))
  46                 .setParameter(ImmutableList.of(new ParameterBuilder()
  47                         .setName(new ParameterName(SPORT))
  48                         .setDescription(new Description("The source port number to match against"))
  49                         .setType(Type.Int)
  50                         .build(),
  51                     new ParameterBuilder()
  52                         .setName(new ParameterName(DPORT))
  53                         .setDescription(new Description("The destination port number to match against"))
  54                         .setType(Type.Int)
  55                         .build(),
  56                     new ParameterBuilder()
  57                         .setName(new ParameterName(TYPE))
  58                         .setDescription(new Description("TCP or UDP"))
  59                         .setIsRequired(IsRequired.Required)
  60                         .setType(Type.String)
  61                         .build()))
  62                 .build();
  63
  64     private static final Map<String, Object> tcp =
  65             ImmutableMap.<String,Object>of(PROTO, Long.valueOf(6));
  66     private static final Map<String, Object> udp =
  67             ImmutableMap.<String,Object>of(PROTO, Long.valueOf(17));
  68
  69     @Override
  70     public ClassifierDefinitionId getId() {
  71         return ID;
  72     }
  73
  74     @Override
  75     public ClassifierDefinition getClassDef() {
  76         return DEF;
  77     }
  78
  79     @Override
  80     public List<MatchBuilder> updateMatch(List<MatchBuilder> matches,
  81                                           Map<String, Object> params) {
  82         Object t = params.get(TYPE);
  83         // XXX TODO generate exception and fail the match
  84         if (t == null || !(t instanceof String)) return matches;
  85         String type = (String)t;
  86
  87         if ("UDP".equals(type))
  88             matches = super.updateMatch(matches, udp);
  89         else
  90             matches = super.updateMatch(matches, tcp);
  91
  92         Long sport = null;
  93         Long dport = null;
  94         t = params.get(SPORT);
  95         if (t != null && (t instanceof Long))
  96             sport = (Long)t;
  97         t = params.get(DPORT);
  98         if (t != null && (t instanceof Long))
  99             dport = (Long)t;
 100
 101         for (MatchBuilder b : matches) {
 102             if ("UDP".equals(type)) {
 103                 UdpMatchBuilder m = new UdpMatchBuilder();
 104                 if (sport != null)
 105                     m.setUdpSourcePort(new PortNumber(sport.intValue()));
 106                 if (dport != null)
 107                     m.setUdpDestinationPort(new PortNumber(dport.intValue()));
 108                 b.setLayer4Match(m.build());
 109             } else {
 110                 TcpMatchBuilder m = new TcpMatchBuilder();
 111                 if (sport != null)
 112                     m.setTcpSourcePort(new PortNumber(sport.intValue()));
 113                 if (dport != null)
 114                     m.setTcpDestinationPort(new PortNumber(dport.intValue()));
 115                 b.setLayer4Match(m.build());
 116             }
 117         }
 118         return matches;
 119     }
 120 }