/*
      Copyright 2007 Ramon Servadei
   
      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 fulmine.distribution.connection.tcp;
  
  import static fulmine.util.Utils.COLON;
  import static fulmine.util.Utils.string;
  import fulmine.AbstractLifeCycle;
  import fulmine.Domain;
  import fulmine.IDomain;
  import fulmine.ILifeCycle;
  import fulmine.IType;
  import fulmine.Type;
  import fulmine.context.IFrameworkContext;
  import fulmine.distribution.connection.IConnectionBroker;
  import fulmine.distribution.connection.IConnectionParameters;
  import fulmine.util.reference.is;
  
  /**
   * Encapsulates the parameters for the TCP/IP server socket of a remote
   * {@link IFrameworkContext} to connect to.
   * <p>
   * A note on the hierarchy; this only extends {@link AbstractLifeCycle} because
   * the {@link TcpConnection} sub class requires the {@link ILifeCycle} method
   * implementations provided by the {@link AbstractLifeCycle}. This is a conceded
   * design choice.
   * 
   * @author Ramon Servadei
   */
  public class TcpConnectionParameters extends AbstractLifeCycle implements
      IConnectionParameters
  {
      /**
       * The IP remoteHostAddress of the host of the remote
       * {@link IConnectionBroker}
       */
      private final String remoteHostAddress;
  
      /** The TCP remoteHostTcpPort of the remote {@link IConnectionBroker} */
      private final int remoteHostTcpPort;
  
      /**
       * The identity of the remote {@link IConnectionBroker} this connection is
       * for
       */
      private String identity;
  
      /** The hashcode of the connection */
      private int connectionHashCode;
  
      /**
       * Standard constructor for the parameters of a TCP/IP connection to a
       * remote {@link IConnectionBroker}.
       * 
       * @param identity
       *            the connection identity (the identity of the remote context)
       * @param connectionHashCode
       *            the hashcode of the connection to the remote context
       * @param remoteHostAddress
       *            the IP remoteHostAddress or resolvable host name
       * @param remoteHostTcpPort
       *            the remoteHostTcpPort for the socket connection
       */
      public TcpConnectionParameters(String identity, int connectionHashCode,
          String address, int port)
      {
          this.identity = identity;
          this.remoteHostAddress = address;
          this.remoteHostTcpPort = port;
          this.connectionHashCode = connectionHashCode;
      }
  
      public final String getRemoteContextIdentity()
      {
          return this.identity;
      }
  
      /**
       * @return The IP address of the host of the remote
       *         {@link IConnectionBroker}
       */
      protected String getRemoteHostAddress()
      {
          return this.remoteHostAddress;
      }
  
      /**
      * @return The TCP port of the remote {@link IConnectionBroker}
      */
     protected int getRemoteHostTcpPort()
     {
         return this.remoteHostTcpPort;
     }
 
     protected void setIdentity(String identity)
     {
         this.identity = identity;
     }
 
     public final String getIdentity()
     {
         return this.identity;
     }
 
     public IType getType()
     {
         return Type.SYSTEM;
     }
 
     public IDomain getDomain()
     {
         return Domain.FRAMEWORK;
     }
 
     public String getAddress()
     {
         return getIdentity() + COLON + getType() + COLON + getDomain();
     }
 
     protected void setRemoteContextHashCode(int hashCode)
     {
         this.connectionHashCode = hashCode;
     }
 
     public int getRemoteContextHashCode()
     {
         return this.connectionHashCode;
     }
 
     public boolean isEqual(IConnectionParameters connectionParameters)
     {
         return equals(connectionParameters);
     }
 
     @Override
     protected void doDestroy()
     {
     }
 
     @Override
     protected void doStart()
     {
     }
 
     @Override
     public String toString()
     {
         return string(this, getIdentity() + ", Socket="
             + getRemoteHostAddress() + COLON + getRemoteHostTcpPort()
             + ", connectionHashCode=" + getRemoteContextHashCode());
     }
 
     @Override
     public int hashCode()
     {
         return this.connectionHashCode;
     }
 
     @Override
     public boolean equals(Object obj)
     {
         if (is.same(this, obj))
         {
             return true;
         }
         if (!(obj instanceof TcpConnectionParameters))
         {
             return false;
         }
         final TcpConnectionParameters other = (TcpConnectionParameters) obj;
         return is.eq(this.connectionHashCode, other.connectionHashCode)
             && is.eq(this.remoteHostAddress, other.remoteHostAddress)
             && is.eq(this.identity, other.identity)
             && is.eq(this.remoteHostTcpPort, other.remoteHostTcpPort);
     }
 }