package org.apache.commons.jcs.auxiliary.lateral.socket.tcp;
   
   /*
    * 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.
   */
  
  import java.io.BufferedReader;
  import java.io.IOException;
  import java.io.InputStreamReader;
  import java.util.Collections;
  import java.util.HashMap;
  import java.util.Map;
  import java.util.Set;
  
  import org.apache.commons.jcs.auxiliary.lateral.LateralCommand;
  import org.apache.commons.jcs.auxiliary.lateral.LateralElementDescriptor;
  import org.apache.commons.jcs.auxiliary.lateral.socket.tcp.behavior.ITCPLateralCacheAttributes;
  import org.apache.commons.jcs.engine.CacheElement;
  import org.apache.commons.jcs.engine.CacheInfo;
  import org.apache.commons.jcs.engine.behavior.ICacheElement;
  import org.apache.commons.jcs.engine.behavior.ICacheServiceNonLocal;
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  /**
   * A lateral cache service implementation. Does not implement getGroupKey
   * TODO: Remove generics
   */
  public class LateralTCPService<K, V>
      implements ICacheServiceNonLocal<K, V>
  {
      /** The logger. */
      private static final Log log = LogFactory.getLog( LateralTCPService.class );
  
      /** special configuration */
      private boolean allowPut;
      private boolean allowGet;
      private boolean issueRemoveOnPut;
  
      /** Sends to another lateral. */
      private LateralTCPSender sender;
  
      /** use the vmid by default */
      private long listenerId = CacheInfo.listenerId;
  
      /**
       * Constructor for the LateralTCPService object
       * <p>
       * @param lca ITCPLateralCacheAttributes
       * @throws IOException
       */
      public LateralTCPService( ITCPLateralCacheAttributes lca )
          throws IOException
      {
          this.allowGet = lca.isAllowGet();
          this.allowPut = lca.isAllowPut();
          this.issueRemoveOnPut = lca.isIssueRemoveOnPut();
  
          try
          {
              sender = new LateralTCPSender( lca );
  
              if ( log.isInfoEnabled() )
              {
                  log.debug( "Created sender to [" + lca.getTcpServer() + "]" );
              }
          }
          catch ( IOException e )
          {
              // log.error( "Could not create sender", e );
              // This gets thrown over and over in recovery mode.
              // The stack trace isn't useful here.
              log.error( "Could not create sender to [" + lca.getTcpServer() + "] -- " + e.getMessage() );
  
              throw e;
          }
      }
  
      /**
       * @param item
       * @throws IOException
       */
      @Override
      public void update( ICacheElement<K, V> item )
         throws IOException
     {
         update( item, getListenerId() );
     }
 
     /**
      * If put is allowed, we will issue a put. If issue put on remove is configured, we will issue a
      * remove. Either way, we create a lateral element descriptor, which is essentially a JCS TCP
      * packet. It describes what operation the receiver should take when it gets the packet.
      * <p>
      * @see org.apache.commons.jcs.engine.behavior.ICacheServiceNonLocal#update(org.apache.commons.jcs.engine.behavior.ICacheElement,
      *      long)
      */
     @Override
     public void update( ICacheElement<K, V> item, long requesterId )
         throws IOException
     {
         // if we don't allow put, see if we should remove on put
         if ( !this.allowPut &&
             // if we can't remove on put, and we can't put then return
             !this.issueRemoveOnPut )
         {
             return;
         }
 
         // if we shouldn't remove on put, then put
         if ( !this.issueRemoveOnPut )
         {
             LateralElementDescriptor<K, V> led = new LateralElementDescriptor<K, V>( item );
             led.requesterId = requesterId;
             led.command = LateralCommand.UPDATE;
             sender.send( led );
         }
         // else issue a remove with the hashcode for remove check on
         // on the other end, this will be a server config option
         else
         {
             if ( log.isDebugEnabled() )
             {
                 log.debug( "Issuing a remove for a put" );
             }
             // set the value to null so we don't send the item
             CacheElement<K, V> ce = new CacheElement<K, V>( item.getCacheName(), item.getKey(), null );
             LateralElementDescriptor<K, V> led = new LateralElementDescriptor<K, V>( ce );
             led.requesterId = requesterId;
             led.command = LateralCommand.REMOVE;
             led.valHashCode = item.getVal().hashCode();
             sender.send( led );
         }
     }
 
     /**
      * Uses the default listener id and calls the next remove method.
      * <p>
      * @see org.apache.commons.jcs.engine.behavior.ICacheService#remove(String, Object)
      */
     @Override
     public void remove( String cacheName, K key )
         throws IOException
     {
         remove( cacheName, key, getListenerId() );
     }
 
     /**
      * Wraps the key in a LateralElementDescriptor.
      * <p>
      * @see org.apache.commons.jcs.engine.behavior.ICacheServiceNonLocal#remove(String, Object, long)
      */
     @Override
     public void remove( String cacheName, K key, long requesterId )
         throws IOException
     {
         CacheElement<K, V> ce = new CacheElement<K, V>( cacheName, key, null );
         LateralElementDescriptor<K, V> led = new LateralElementDescriptor<K, V>( ce );
         led.requesterId = requesterId;
         led.command = LateralCommand.REMOVE;
         sender.send( led );
     }
 
     /**
      * Does nothing.
      * <p>
      * @throws IOException
      */
     @Override
     public void release()
         throws IOException
     {
         // nothing needs to be done
     }
 
     /**
      * Will close the connection.
      * <p>
      * @param cacheName
      * @throws IOException
      */
     @Override
     public void dispose( String cacheName )
         throws IOException
     {
         sender.dispose();
     }
 
     /**
      * @param cacheName
      * @param key
      * @return ICacheElement&lt;K, V&gt; if found.
      * @throws IOException
      */
     @Override
     public ICacheElement<K, V> get( String cacheName, K key )
         throws IOException
     {
         return get( cacheName, key, getListenerId() );
     }
 
     /**
      * If get is allowed, we will issues a get request.
      * <p>
      * @param cacheName
      * @param key
      * @param requesterId
      * @return ICacheElement&lt;K, V&gt; if found.
      * @throws IOException
      */
     @Override
     public ICacheElement<K, V> get( String cacheName, K key, long requesterId )
         throws IOException
     {
         // if get is not allowed return
         if ( this.allowGet )
         {
             CacheElement<K, V> ce = new CacheElement<K, V>( cacheName, key, null );
             LateralElementDescriptor<K, V> led = new LateralElementDescriptor<K, V>( ce );
             // led.requesterId = requesterId; // later
             led.command = LateralCommand.GET;
             @SuppressWarnings("unchecked") // Need to cast from Object
             ICacheElement<K, V> response = (ICacheElement<K, V>)sender.sendAndReceive( led );
             if ( response != null )
             {
                 return response;
             }
             return null;
         }
         else
         {
             // nothing needs to be done
             return null;
         }
     }
 
     /**
      * If allow get is true, we will issue a getmatching query.
      * <p>
      * @param cacheName
      * @param pattern
      * @return a map of K key to ICacheElement&lt;K, V&gt; element, or an empty map if there is no
      *         data in cache matching the pattern.
      * @throws IOException
      */
     @Override
     public Map<K, ICacheElement<K, V>> getMatching( String cacheName, String pattern )
         throws IOException
     {
         return getMatching( cacheName, pattern, getListenerId() );
     }
 
     /**
      * If allow get is true, we will issue a getmatching query.
      * <p>
      * @param cacheName
      * @param pattern
      * @param requesterId - our identity
      * @return a map of K key to ICacheElement&lt;K, V&gt; element, or an empty map if there is no
      *         data in cache matching the pattern.
      * @throws IOException
      */
     @Override
     @SuppressWarnings("unchecked") // Need to cast from Object
     public Map<K, ICacheElement<K, V>> getMatching( String cacheName, String pattern, long requesterId )
         throws IOException
     {
         // if get is not allowed return
         if ( this.allowGet )
         {
             CacheElement<String, String> ce = new CacheElement<String, String>( cacheName, pattern, null );
             LateralElementDescriptor<String, String> led = new LateralElementDescriptor<String, String>( ce );
             // led.requesterId = requesterId; // later
             led.command = LateralCommand.GET_MATCHING;
 
             Object response = sender.sendAndReceive( led );
             if ( response != null )
             {
                 return (Map<K, ICacheElement<K, V>>) response;
             }
             return Collections.emptyMap();
         }
         else
         {
             // nothing needs to be done
             return null;
         }
     }
 
     /**
      * Gets multiple items from the cache based on the given set of keys.
      * <p>
      * @param cacheName
      * @param keys
      * @return a map of K key to ICacheElement&lt;K, V&gt; element, or an empty map if there is no
      *         data in cache for any of these keys
      * @throws IOException
      */
     @Override
     public Map<K, ICacheElement<K, V>> getMultiple( String cacheName, Set<K> keys )
         throws IOException
     {
         return getMultiple( cacheName, keys, getListenerId() );
     }
 
     /**
      * This issues a separate get for each item.
      * <p>
      * TODO We should change this. It should issue one request.
      * <p>
      * @param cacheName
      * @param keys
      * @param requesterId
      * @return a map of K key to ICacheElement&lt;K, V&gt; element, or an empty map if there is no
      *         data in cache for any of these keys
      * @throws IOException
      */
     @Override
     public Map<K, ICacheElement<K, V>> getMultiple( String cacheName, Set<K> keys, long requesterId )
         throws IOException
     {
         Map<K, ICacheElement<K, V>> elements = new HashMap<K, ICacheElement<K, V>>();
 
         if ( keys != null && !keys.isEmpty() )
         {
             for (K key : keys)
             {
                 ICacheElement<K, V> element = get( cacheName, key );
 
                 if ( element != null )
                 {
                     elements.put( key, element );
                 }
             }
         }
         return elements;
     }
 
     /**
      * Return the keys in this cache.
      * <p>
      * @param cacheName the name of the cache region
      * @see org.apache.commons.jcs.auxiliary.AuxiliaryCache#getKeySet()
      */
     @Override
     @SuppressWarnings("unchecked") // Need cast from Object
     public Set<K> getKeySet(String cacheName) throws IOException
     {
         CacheElement<String, String> ce = new CacheElement<String, String>(cacheName, null, null);
         LateralElementDescriptor<String, String> led = new LateralElementDescriptor<String, String>(ce);
         // led.requesterId = requesterId; // later
         led.command = LateralCommand.GET_KEYSET;
         Object response = sender.sendAndReceive(led);
         if (response != null)
         {
             return (Set<K>) response;
         }
 
         return null;
     }
 
     /**
      * @param cacheName
      * @throws IOException
      */
     @Override
     public void removeAll( String cacheName )
         throws IOException
     {
         removeAll( cacheName, getListenerId() );
     }
 
     /**
      * @param cacheName
      * @param requesterId
      * @throws IOException
      */
     @Override
     public void removeAll( String cacheName, long requesterId )
         throws IOException
     {
         CacheElement<String, String> ce = new CacheElement<String, String>( cacheName, "ALL", null );
         LateralElementDescriptor<String, String> led = new LateralElementDescriptor<String, String>( ce );
         led.requesterId = requesterId;
         led.command = LateralCommand.REMOVEALL;
         sender.send( led );
     }
 
     /**
      * @param args
      */
     public static void main( String args[] )
     {
         try
         {
             LateralTCPSender sender = new LateralTCPSender( new TCPLateralCacheAttributes() );
 
             // process user input till done
             boolean notDone = true;
             String message = null;
             // wait to dispose
             BufferedReader br = new BufferedReader( new InputStreamReader( System.in, "UTF-8" ) );
 
             while ( notDone )
             {
                 System.out.println( "enter message:" );
                 message = br.readLine();
 
                 if (message == null)
                 {
                     notDone = false;
                     continue;
                 }
 
                 CacheElement<String, String> ce = new CacheElement<String, String>( "test", "test", message );
                 LateralElementDescriptor<String, String> led = new LateralElementDescriptor<String, String>( ce );
                 sender.send( led );
             }
         }
         catch ( IOException e )
         {
             System.out.println( e.toString() );
         }
     }
 
     /**
      * @param listernId The listernId to set.
      */
     protected void setListenerId( long listernId )
     {
         this.listenerId = listernId;
     }
 
     /**
      * @return Returns the listernId.
      */
     protected long getListenerId()
     {
         return listenerId;
     }
 }