/**
    * Copyright (C) 2010-14 pvmanager developers. See COPYRIGHT.TXT
    * All rights reserved. Use is subject to license terms. See LICENSE.TXT
    */
   /*
    * To change this template, choose Tools | Templates
    * and open the template in the editor.
    */
   package org.epics.pvmanager.jca;
  
  import gov.aps.jca.Channel;
  import gov.aps.jca.dbr.DBRType;
  import org.epics.util.time.Timestamp;
  
  /**
   * Represents the connection payload, which consists of the actual JCA
   * Channel and the JCADataSource (which can be used to extract
   * configuration parameters).
   *
   * @author carcassi
   */
  public class JCAConnectionPayload {
      private final JCADataSource jcaDataSource;
      private final Channel channel;
      private final boolean connected;
      private final boolean longString;
      private final DBRType fieldType;
      private final Timestamp eventTime = Timestamp.now();
  
      public JCAConnectionPayload(JCAChannelHandler channleHandler, Channel channel, JCAConnectionPayload previousPayload) {
          this.jcaDataSource = channleHandler.getJcaDataSource();
          this.channel = channel;
          this.connected = channel != null && channel.getConnectionState() == Channel.ConnectionState.CONNECTED;
          this.longString = channleHandler.isLongString();
          if (channel.getFieldType().getClass() == null && previousPayload != null) {
              // JNI sets the type to unknown on disconnect. We need
              // to remember the type before the disconnection
              this.fieldType = previousPayload.fieldType;
          } else {
              this.fieldType = channel.getFieldType();
          }
      }
  
      /**
       * The JCADataSource that is using the channel.
       * 
       * @return the JCA data source
       */
      public JCADataSource getJcaDataSource() {
          return jcaDataSource;
      }
  
      /**
       * The JCA channel.
       * 
       * @return JCA channel
       */
      public Channel getChannel() {
          return channel;
      }
      
      public DBRType getFieldType() {
          return fieldType;
      }
      
      /**
       * True if the channel is not null and the connection state is connected.
       * 
       * @return ture if channel exists and is connected
       */
      public boolean isChannelConnected() {
          return connected;
      }
      
      /**
       * True if the channel is not null, connected, and can be written to.
       * 
       * @return true if the channel is ready for write
       */
      public boolean isWriteConnected() {
          return isChannelConnected() && channel.getWriteAccess();
      }
  
      /**
       * Whether the message payload should be handled as a long string.
       * 
       * @return true if long string support should be used
       */
      public boolean isLongString() {
          return longString;
      }
  
      /**
       * Returns the local time of the connection event.
       * 
       * @return client connection/disconnection time
       */
      public Timestamp getEventTime() {
          return eventTime;
     }
 
     @Override
     public String toString() {
         return "JCAConnection [connected: " +isChannelConnected() + " writeConnected: " + isWriteConnected() + " channel: " + channel + "]";
     }
     
 }