L4Classifier.java

/*
 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.groupbasedpolicy.renderer.vpp.sf;

import java.util.List;
import java.util.Map;

import org.opendaylight.groupbasedpolicy.api.sf.L4ClassifierDefinition;
import org.opendaylight.groupbasedpolicy.renderer.vpp.policy.acl.GbpAceBuilder;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.packet.fields.rev160708.acl.transport.header.fields.DestinationPortRangeBuilder;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.packet.fields.rev160708.acl.transport.header.fields.SourcePortRangeBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ClassifierDefinitionId;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ParameterName;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definitions.ClassifierDefinition;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.instance.ParameterValue;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.has.parameters.type.parameter.type.IntBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.has.parameters.type.parameter.type.RangeBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.supported.classifier.definition.SupportedParameterValues;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.supported.classifier.definition.SupportedParameterValuesBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.supported._int.value.fields.SupportedIntValueInRange;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.supported._int.value.fields.SupportedIntValueInRangeBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.supported.range.value.fields.SupportedRangeValue;
import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.supported.range.value.fields.SupportedRangeValueBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.collect.ImmutableList;

/**
 * Match against TCP or UDP, and source and/or destination ports
 */
public class L4Classifier extends Classifier {

    private static final Logger LOG = LoggerFactory.getLogger(L4Classifier.class);

    static final String EXC_MSG_PARAM_VALUE_NOT_SPECIFIED = "Value of parameter not specified: ";
    static final String EXC_MSG_MUT_EXCLUSIVE_PARAMS = "Mutually exclusive parameters: ";
    static final String EXC_MSG_RANGE_VALUE_MISMATCH = "Range value mismatch: ";

    public L4Classifier(Classifier parent) {
        super(parent);
    }

    @Override
    public ClassifierDefinitionId getId() {
        return L4ClassifierDefinition.ID;
    }

    @Override
    public ClassifierDefinition getClassifierDefinition() {
        return L4ClassifierDefinition.DEFINITION;
    }

    @Override
    public List<SupportedParameterValues> getSupportedParameterValues() {
        List<SupportedIntValueInRange> allPossiblePortsIntInRange =
                ImmutableList.of(new SupportedIntValueInRangeBuilder().setMin(1L).setMax(65535L).build());
        List<SupportedRangeValue> allPossiblePortsRange =
                ImmutableList.of(new SupportedRangeValueBuilder().setMin(1L).setMax(65535L).build());

        SupportedParameterValues srcPorts = new SupportedParameterValuesBuilder()
            .setParameterName(new ParameterName(L4ClassifierDefinition.SRC_PORT_PARAM))
            .setParameterType(new IntBuilder().setSupportedIntValueInRange(allPossiblePortsIntInRange).build())
            .build();
        SupportedParameterValues dstPorts = new SupportedParameterValuesBuilder()
            .setParameterName(new ParameterName(L4ClassifierDefinition.DST_PORT_PARAM))
            .setParameterType(new IntBuilder().setSupportedIntValueInRange(allPossiblePortsIntInRange).build())
            .build();

        SupportedParameterValues srcPortsRange = new SupportedParameterValuesBuilder()
            .setParameterName(new ParameterName(L4ClassifierDefinition.SRC_PORT_RANGE_PARAM))
            .setParameterType(new RangeBuilder().setSupportedRangeValue(allPossiblePortsRange).build())
            .build();
        SupportedParameterValues dstPortsRange = new SupportedParameterValuesBuilder()
            .setParameterName(new ParameterName(L4ClassifierDefinition.DST_PORT_RANGE_PARAM))
            .setParameterType(new RangeBuilder().setSupportedRangeValue(allPossiblePortsRange).build())
            .build();

        return ImmutableList.of(srcPorts, dstPorts, srcPortsRange, dstPortsRange);
    }

    @Override
    protected void checkPresenceOfRequiredParams(Map<String, ParameterValue> params) {
        validatePortParam(params, L4ClassifierDefinition.SRC_PORT_PARAM, L4ClassifierDefinition.SRC_PORT_RANGE_PARAM);
        validatePortParam(params, L4ClassifierDefinition.DST_PORT_PARAM, L4ClassifierDefinition.DST_PORT_RANGE_PARAM);
        validateRange(params, L4ClassifierDefinition.SRC_PORT_RANGE_PARAM);
        validateRange(params, L4ClassifierDefinition.DST_PORT_RANGE_PARAM);
    }

    private void validatePortParam(Map<String, ParameterValue> params, String portParam, String portRangeParam) {
        if (params.get(portParam) != null) {
            StringBuilder paramLog = new StringBuilder();
            if (params.get(portParam).getIntValue() == null) {
                paramLog.append(EXC_MSG_PARAM_VALUE_NOT_SPECIFIED).append(portParam);
                throw new IllegalArgumentException(paramLog.toString());
            }
            if (params.get(portRangeParam) != null) {
                paramLog.append(EXC_MSG_MUT_EXCLUSIVE_PARAMS).append(portParam).append(" and ").append(portRangeParam);
                throw new IllegalArgumentException(paramLog.toString());
            }
        }
    }

    private void validateRange(Map<String, ParameterValue> params, String portRangeParam) {
        if (params.get(portRangeParam) != null) {
            if (params.get(portRangeParam).getRangeValue() == null) {
                throw new IllegalArgumentException(EXC_MSG_PARAM_VALUE_NOT_SPECIFIED + portRangeParam);
            }
            Long min = params.get(portRangeParam).getRangeValue().getMin();
            Long max = params.get(portRangeParam).getRangeValue().getMax();
            if (min > max) {
                throw new IllegalArgumentException(EXC_MSG_RANGE_VALUE_MISMATCH + min + ">" + max);
            }
        }
    }

    @Override
    GbpAceBuilder update(GbpAceBuilder ruleBuilder, Map<String, ParameterValue> params) {
        ruleBuilder.setSourcePortRange(resolveSourcePortRange(params, L4ClassifierDefinition.SRC_PORT_PARAM,
                L4ClassifierDefinition.SRC_PORT_RANGE_PARAM));
        ruleBuilder.setDestinationPortRange(resolveDestinationPortRange(params, L4ClassifierDefinition.DST_PORT_PARAM,
                L4ClassifierDefinition.DST_PORT_RANGE_PARAM));
        return ruleBuilder;
    }

    private SourcePortRangeBuilder resolveSourcePortRange(Map<String, ParameterValue> params, String portParam,
        String portRangeParam) {
        SourcePortRangeBuilder srcRange = new SourcePortRangeBuilder();
        if (params.get(portParam) != null) {
            PortNumber portNumber = new PortNumber(params.get(portParam).getIntValue().intValue());
            srcRange.setLowerPort(portNumber).setUpperPort(portNumber);
        }
        if (params.get(portRangeParam) != null) {
            srcRange.setLowerPort(new PortNumber(params.get(portParam).getRangeValue().getMin().intValue()));
            srcRange.setUpperPort(new PortNumber(params.get(portParam).getRangeValue().getMax().intValue()));
        }
        return srcRange;
    }

    private DestinationPortRangeBuilder resolveDestinationPortRange(Map<String, ParameterValue> params,
        String portParam, String portRangeParam) {
        DestinationPortRangeBuilder dstRange = new DestinationPortRangeBuilder();
        if (params.get(portParam) != null) {
            PortNumber portNumber = new PortNumber(params.get(portParam).getIntValue().intValue());
            dstRange.setLowerPort(portNumber).setUpperPort(portNumber);
        }
        if (params.get(portRangeParam) != null) {
            dstRange.setLowerPort(new PortNumber(params.get(portParam).getRangeValue().getMin().intValue()));
            dstRange.setUpperPort(new PortNumber(params.get(portParam).getRangeValue().getMax().intValue()));
        }
        return dstRange;
    }

    @Override
    void checkPrereqs(GbpAceBuilder matchBuilders) {
        // TODO check whether mandatory fields are set in builder
    }

}