InstallOneSwitchFlow.java

Go to the documentation of this file.

/* Copyright 2017 Telstra Open Source
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

package org.openkilda.messaging.command.flow;

import static com.google.common.base.MoreObjects.toStringHelper;
import static org.openkilda.messaging.Utils.FLOW_ID;
import static org.openkilda.messaging.Utils.TRANSACTION_ID;

import org.openkilda.messaging.Utils;
import org.openkilda.messaging.model.SwitchId;
import org.openkilda.messaging.payload.flow.OutputVlanType;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

import java.util.Objects;

@JsonSerialize
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
        TRANSACTION_ID,
        FLOW_ID,
        "cookie",
        "switch_id",
        "input_port",
        "output_port",
        "input_vlan_id",
        "output_vlan_id",
        "output_vlan_type",
        "bandwidth",
        "meter_id"})
public class InstallOneSwitchFlow extends BaseInstallFlow {
    private static final long serialVersionUID = 1L;

    @JsonProperty("meter_id")
    protected Long meterId;

    @JsonProperty("bandwidth")
    private Long bandwidth;

    @JsonProperty("output_vlan_type")
    private OutputVlanType outputVlanType;

    @JsonProperty("input_vlan_id")
    private Integer inputVlanId;

    @JsonProperty("output_vlan_id")
    private Integer outputVlanId;

    @JsonCreator
    public InstallOneSwitchFlow(@JsonProperty(TRANSACTION_ID) final Long transactionId,
                                @JsonProperty(FLOW_ID) final String id,
                                @JsonProperty("cookie") final Long cookie,
                                @JsonProperty("switch_id") final SwitchId switchId,
                                @JsonProperty("input_port") final Integer inputPort,
                                @JsonProperty("output_port") final Integer outputPort,
                                @JsonProperty("input_vlan_id") final Integer inputVlanId,
                                @JsonProperty("output_vlan_id") final Integer outputVlanId,
                                @JsonProperty("output_vlan_type") final OutputVlanType outputVlanType,
                                @JsonProperty("bandwidth") final Long bandwidth,
                                @JsonProperty("meter_id") final Long meterId) {
        super(transactionId, id, cookie, switchId, inputPort, outputPort);
        setInputVlanId(inputVlanId);
        setOutputVlanId(outputVlanId);
        setOutputVlanType(outputVlanType);
        setBandwidth(bandwidth);
        setMeterId(meterId);
    }

    public Long getBandwidth() {
        return bandwidth;
    }

    public void setBandwidth(final Long bandwidth) {
        if (bandwidth == null) {
            throw new IllegalArgumentException("need to set bandwidth");
        } else if (bandwidth < 0L) {
            throw new IllegalArgumentException("need to set non negative bandwidth");
        }
        this.bandwidth = bandwidth;
    }

    public OutputVlanType getOutputVlanType() {
        return outputVlanType;
    }

    public void setOutputVlanType(final OutputVlanType outputVlanType) {
        if (outputVlanType == null) {
            throw new IllegalArgumentException("need to set output_vlan_type");
        } else if (!Utils.validateOutputVlanType(outputVlanId, outputVlanType)) {
            throw new IllegalArgumentException("need to set valid values for output_vlan_id and output_vlan_type");
        } else {
            this.outputVlanType = outputVlanType;
        }
    }

    public Integer getInputVlanId() {
        return inputVlanId;
    }

    public void setInputVlanId(final Integer inputVlanId) {
        if (inputVlanId == null) {
            this.inputVlanId = 0;
        } else if (Utils.validateVlanRange(inputVlanId)) {
            this.inputVlanId = inputVlanId;
        } else {
            throw new IllegalArgumentException("need to set valid value for input_vlan_id");
        }
    }

    public Integer getOutputVlanId() {
        return outputVlanId;
    }

    public void setOutputVlanId(final Integer outputVlanId) {
        if (outputVlanId == null) {
            this.outputVlanId = 0;
        } else if (Utils.validateVlanRange(outputVlanId)) {
            this.outputVlanId = outputVlanId;
        } else {
            throw new IllegalArgumentException("need to set valid value for output_vlan_id");
        }
    }

    public Long getMeterId() {
        return meterId;
    }

    public void setMeterId(final Long meterId) {
        if (meterId == null) {
            throw new IllegalArgumentException("need to set meterId");
        } else if (meterId < 0) {
            throw new IllegalArgumentException("need to set non negative meterId");
        }
        this.meterId = meterId;
    }

    @Override
    public String toString() {
        return toStringHelper(this)
                .add(TRANSACTION_ID, transactionId)
                .add(FLOW_ID, id)
                .add("cookie", cookie)
                .add("switch_id", switchId)
                .add("input_port", inputPort)
                .add("output_port", outputPort)
                .add("input_vlan_id", inputVlanId)
                .add("output_vlan_id", outputVlanId)
                .add("output_vlan_type", outputVlanType)
                .add("bandwidth", bandwidth)
                .add("meter_id", meterId)
                .toString();
    }

    @Override
    public boolean equals(Object object) {
        if (this == object) {
            return true;
        }
        if (object == null || getClass() != object.getClass()) {
            return false;
        }

        InstallOneSwitchFlow that = (InstallOneSwitchFlow) object;
        return Objects.equals(getTransactionId(), that.getTransactionId())
                && Objects.equals(getId(), that.getId())
                && Objects.equals(getCookie(), that.getCookie())
                && Objects.equals(getSwitchId(), that.getSwitchId())
                && Objects.equals(getInputPort(), that.getInputPort())
                && Objects.equals(getOutputPort(), that.getOutputPort())
                && Objects.equals(getInputVlanId(), that.getInputVlanId())
                && Objects.equals(getOutputVlanId(), that.getOutputVlanId())
                && Objects.equals(getOutputVlanType(), that.getOutputVlanType())
                && Objects.equals(getBandwidth(), that.getBandwidth())
                && Objects.equals(getMeterId(), that.getMeterId());
    }

    @Override
    public int hashCode() {
        return Objects.hash(transactionId, id, cookie, switchId, inputPort, outputPort,
                inputVlanId, outputVlanId, outputVlanType, bandwidth, meterId);
    }
}