/**
    *
    * Copyright (C) 2011 Cloud Conscious, LLC. <info@cloudconscious.com>
    *
    * ====================================================================
    * 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.jclouds.vcloud.domain.network.nat.rules;
  
  import static com.google.common.base.Preconditions.checkNotNull;
  
  import javax.annotation.Nullable;
  
  import org.jclouds.vcloud.domain.network.nat.NatProtocol;
  import org.jclouds.vcloud.domain.network.nat.NatRule;
  
  /**
   * The VmRule element describes a NAT rule that maps an IP address and port in a vApp network to an
   * external IP address and port. The external IP address, external port, and internal port are
   * specified in the element. The internal IP address is discovered by looking up the specified
   * VmReference and VmNicId.
   * 
   * @since vcloud 0.9
   * @author Adrian Cole
   */
  public class VmRule implements NatRule {
     @Nullable
     private final String externalIP;
     private final int externalPort;
     @Nullable
     private final String vAppScopedLocalId;
     private final int vmNicId;
     private final int internalPort;
     private final NatProtocol protocol;
  
     public VmRule(@Nullable String externalIP, int externalPort, @Nullable String vAppScopedLocalId, int vmNicId,
              int internalPort, NatProtocol protocol) {
        this.externalIP = externalIP;
        this.externalPort = externalPort;
        this.vAppScopedLocalId = vAppScopedLocalId;
        this.vmNicId = vmNicId;
        this.internalPort = internalPort;
        this.protocol = checkNotNull(protocol, "protocol");
     }
  
     /**
      * IP address to which this NAT rule maps the IP address specified in the InternalIp element.
      */
     @Nullable
     public String getExternalIP() {
        return externalIP;
     }
  
     /**
      * network port to which this NAT rule maps the port number specified in the InternalPort element
      */
     public Integer getExternalPort() {
        return externalPort;
     }
  
     /**
      * @return read‐only identifier created on import
      * @since vcloud 0.9
      */
     @Nullable
     public String getVAppScopedLocalId() {
        return vAppScopedLocalId;
     }
  
     /**
      * @return device number of the NIC on the referenced virtual machine
      * @since vcloud 0.9
      */
     public int getVmNicId() {
        return vmNicId;
     }
  
     /**
      * network port to which this NAT rule maps the port number specified in the ExternalPort
      * element.
      */
     public Integer getInternalPort() {
        return internalPort;
     }
  
     /**
      * specifies the network protocol to which this rule applies
      */
    public NatProtocol getProtocol() {
       return protocol;
    }
 
    @Override
    public int hashCode() {
       final int prime = 31;
       int result = 1;
       result = prime * result + ((externalIP == null) ? 0 : externalIP.hashCode());
       result = prime * result + externalPort;
       result = prime * result + internalPort;
       result = prime * result + ((protocol == null) ? 0 : protocol.hashCode());
       result = prime * result + ((vAppScopedLocalId == null) ? 0 : vAppScopedLocalId.hashCode());
       result = prime * result + vmNicId;
       return result;
    }
 
    @Override
    public boolean equals(Object obj) {
       if (this == obj)
          return true;
       if (obj == null)
          return false;
       if (getClass() != obj.getClass())
          return false;
       VmRule other = (VmRule) obj;
       if (externalIP == null) {
          if (other.externalIP != null)
             return false;
       } else if (!externalIP.equals(other.externalIP))
          return false;
       if (externalPort != other.externalPort)
          return false;
       if (internalPort != other.internalPort)
          return false;
       if (protocol == null) {
          if (other.protocol != null)
             return false;
       } else if (!protocol.equals(other.protocol))
          return false;
       if (vAppScopedLocalId == null) {
          if (other.vAppScopedLocalId != null)
             return false;
       } else if (!vAppScopedLocalId.equals(other.vAppScopedLocalId))
          return false;
       if (vmNicId != other.vmNicId)
          return false;
       return true;
    }
 
    @Override
    public String toString() {
       return "[externalIP=" + externalIP + ", externalPort=" + externalPort + ", internalPort=" + internalPort
                + ", protocol=" + protocol + ", vAppScopedLocalId=" + vAppScopedLocalId + ", vmNicId=" + vmNicId + "]";
    }
 
 }