api/src/main/java/com/cloud/network/rules/PortForwardingRule.java

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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 com.cloud.network.rules;

import com.cloud.utils.net.Ip;

/**
 * Specifies the port forwarding for firewall rule.
 */
public interface PortForwardingRule extends FirewallRule {
    /**
     * @return destination ip address.
     */
    Ip getDestinationIpAddress();

    /**
     * updates the destination ip address.
     */
    void setDestinationIpAddress(Ip destinationIpAddress);

    /**
     * @return start of destination port.
     */
    int getDestinationPortStart();

    /**
     * @return end of destination port range
     */
    int getDestinationPortEnd();

    /**
     * @return destination ip address.
     */
    long getVirtualMachineId();

}