* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

*

* Copyright (c) 2000-2010 Oracle and/or its affiliates. All rights reserved.

*

* The contents of this file are subject to the terms of either the GNU

* General Public License Version 2 only ("GPL") or the Common Development

* and Distribution License("CDDL") (collectively, the "License").  You

* may not use this file except in compliance with the License.  You can

* obtain a copy of the License at

* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html

* or packager/legal/LICENSE.txt.  See the License for the specific

* language governing permissions and limitations under the License.

*

* When distributing the software, include this License Header Notice in each

* file and include the License file at packager/legal/LICENSE.txt.

*

* GPL Classpath Exception:

* Oracle designates this particular file as subject to the "Classpath"

* exception as provided by Oracle in the GPL Version 2 section of the License

* file that accompanied this code.

*

* Modifications:

* If applicable, add the following below the License Header, with the fields

* enclosed by brackets [] replaced by your own identifying information:

* "Portions Copyright [year] [name of copyright owner]"

*

* Contributor(s):

* If you wish your version of this file to be governed by only the CDDL or

* only the GPL Version 2, indicate your decision by adding "[Contributor]

* elects to include this software in this distribution under the [CDDL or GPL

* Version 2] license."  If you don't indicate a single choice of license, a

* recipient has the option to distribute your version of this file under

* either the CDDL, the GPL Version 2 or to extend the choice of license to

* its licensees as provided above.  However, if you add GPL Version 2 code

* and therefore, elected the GPL Version 2 license, then the option applies

* only if the new code is made subject to such option by the copyright

* holder.

*/

/*

*  @(#)ConnectionImpl.java  1.184 03/21/08

*/

  * It will typically allocate provider resources outside the Java virtual

  * machine.

  *

  * <P>Connections support concurrent use.

  *

  * <P>A Connection serves several purposes:

  *

  * <UL>

  *   <LI>It encapsulates an open connection with a JMS provider. It

  *       typically represents an open TCP/IP socket between a client and

  *       a provider service daemon.

  *   <LI>Its creation is where client authenticating takes place.

  *   <LI>It can specify a unique client identifier.

  *   <LI>It provides ConnectionMetaData.

  *   <LI>It supports an optional ExceptionListener.

  * </UL>

  *

  * <P>Due to the authentication and communication setup done when a

  * Connection is created, a Connection is a relatively heavy-weight JMS

  * object. Most clients will do all their messaging with a single Connection.

  * Other more advanced applications may use several Connections. JMS does

  * not architect a reason for using multiple connections; however, there may

  * be operational reasons for doing so.

  *

  * <P>A JMS client typically creates a Connection; one or more Sessions;

  * and a number of message producers and consumers. When a Connection is

  * created it is in stopped mode. That means that no messages are being

  * delivered.

  *

  * <P>It is typical to leave the Connection in stopped mode until setup

  * is complete. At that point the Connection's start() method is called

  * and messages begin arriving at the Connection's consumers. This setup

  * convention minimizes any client confusion that may result from

  * asynchronous message delivery while the client is still in the process

  * of setting itself up.

  *

  * <P>A Connection can immediately be started and the setup can be done

  * afterwards. Clients that do this must be prepared to handle asynchronous

  * message delivery while they are still in the process of setting up.

  *

  * <P>A message producer can send messages while a Connection is stopped.

  *

  * @see         javax.jms.ConnectionFactory

  * @see         javax.jms.QueueConnection

  * @see         javax.jms.TopicConnection

  */

    private static final String ENABLE_FAILOVER_PROP = "imq.enable_failover";

    protected static final Version version = new Version();

    private boolean daemonThreads = false;

    private boolean hasNamespace = false;

    private String raNamespaceUID = null;

    private Object nsSyncObj = new Object();

    ExceptionListener exceptionListener = null;

    protected String clientID = null;

    protected String clientIPAddress = null;

    protected ReadChannel readChannel = null;

    protected WriteChannel writeChannel = null;

    protected ProtocolHandler protocolHandler = null;

    private AuthenticationProtocolHandler authenticationHandler = null;

    // XXX PROTOCOL3.5 --

    protected FlowControl flowControl = null;

    // XXX PROTOCOL3.5 --

    // Improved reconnect and connection failover.

    protected ConnectionInitiator initiator = null;

    protected boolean reconnecting = false;

    private Object reconnectSyncObj = new Object();

    // XXX PROTOCOL3.5 --

    // All the producers for this connection. We need to quickly find

    // the producer object when we get RESUME_FLOW packets...

    protected Hashtable producers = new Hashtable();

    //exception handler

    protected ExceptionHandler exceptionHandler = null;

    //table to hold Consumer objects

    protected InterestTable interestTable = null;

    //table to hold SessionQueue objects.  pkts are put in SessionQueue based

    //on sessionID

    protected ReadQTable readQTable = null;

    //table to hold queues for acknowledgements. - XXX PROTOCOL2.1 change.

    protected ReadQTable ackQTable = null;

    //XXX PROTOCOL2.1 change.

    //table to hold RequestMetaData.  Such as interestID/consumer pair.

    protected Hashtable requestMetaData = null ;

    //bug 6172663

    //protected boolean isTopicConnection = true;

    protected boolean isTopicConnection = false;

    //bug 6172663

    protected boolean isQueueConnection = false;

    protected boolean isStopped = true;

    //XXX:GT TBF **** this is closed until opened !!!

    protected boolean isClosed = true;

    //bug 6189645 -- general blocking issues.

    //this flag is set to true when close() is called.

    protected boolean isCloseCalled = false;

    //protected boolean isClosing = false;

    protected boolean isSuspended = false;

    //table to hold Sessions.  When a session is created, it is put in here.

    protected Vector sessionTable = null;

    protected Vector connectionConsumerTable = null;

    protected Vector tempDestTable = null;

    //next available session ID

    protected long nextSessionId = 0;

    //if nextSessionId reached MAX_INTEREST_ID, this flag is set to true

    protected boolean sessionIdReset = false;

    //next available transactionID

    protected int nextTransactionID = 0;

    protected boolean openedFromXA = false;

    //max queue size in the session queue.

    //protected int maxQueueSize = 1000;

    //protected int minQueueSize = 10;

    //setting this to true if wanted to have session reader to check queue

    //sizes and protect the system from memory over flow.

    protected boolean protectMode = false;

    //default value for flow control message size

    protected int flowControlMsgSize = 100;

    //water mark - used in flow control

    //not used if protectMode == false

    protected int flowControlWaterMark = 1000;

    //XXX PROTOCOL3.5 New consumer flow control attributes.

    protected int prefetchMaxMsgCount = 100;

    protected int prefetchThresholdPercent = 50;

    //4.5

    protected boolean consumerFlowLimitPrefetch = true;

    //XXX PROTOCOL3.5 Connection reconnect & failover attributes.

    protected volatile boolean imqReconnect = false;

    protected boolean failoverEnabled = false;

    protected Hashtable licenseProps = null;

    //Enable Shared ClientID for this connection

    protected boolean imqEnableSharedClientID = false;

    //Enable Shared Subscriptions for this connection (non-durable)

    protected boolean imqEnableSharedSubscriptions = false;

    //dups ok limit.  default is 10

    protected int dupsOkLimit = 10;

    //if set, we check if unack msgs has exceeded the limit.

    protected boolean isAckLimited = false;

    //client ack limit.  default 100.

    protected int ackLimit = 100;

    //for temporary destination name generation.

    private int tempDestSequence = 0;

    //for connection recovery to check if this connection has associated

    //with temp destination.  We do not recover connection if there is

    //active temp destination for the connection.

    private int tempDestCounter = 0;

    //flag for session reader to check if the connection is broken

    //This flag is set by ReadChannel when connection is broken.

    protected volatile boolean connectionIsBroken = false;

    //flag to indicate connection recover is in process

    protected volatile boolean recoverInProcess = false;

    //connection ID - for thread naming purpose

    //XXX PROTOCOL2.1 from int to long.

    protected static long nextConnectionID = 0;

    //current connection ID

    protected Long connectionID = null;

    //local connection ID.  This is used for local ID. The connectionID

    //will be reassigned by broker.

    protected long localID = 0;

   

    // brokerSessionID (sent by broker in HELLO_REPLY)

    protected long brokerSessionID = 0;

    //Override flags and values for Administered JMS Msg Headers

    protected boolean jmqOverrideJMSMsgHeaders = false;

    protected boolean jmqOverrideJMSDeliveryMode = false;

    protected boolean jmqOverrideJMSExpiration = false;

    protected boolean jmqOverrideJMSPriority = false;

    protected boolean jmqOverrideMsgsToTempDests = false;

    protected int jmqJMSDeliveryMode = DeliveryMode.PERSISTENT;

    protected long jmqJMSExpiration = 0L;

    protected int jmqJMSPriority = 4;

    //dups ok ack time out properties - dupsOkPerf

    //if set, dups ok acks when reached unacked limit or session Q is empty.

    protected boolean dupsOkAckOnEmptyQueue = false;

    //The magic number from Dipol.

    protected long dupsOkAckTimeout = 7000L; //seven seconds.

    /**

     * flag used for setting client ID.

     * If set to false, API user can not set clientID.

     */

    protected boolean allowToSetClientID = true;

    protected boolean adminSetClientID = false;

    //sync object for synchronizing sequences

    private Object syncObj = new Object();

    //save this for reconnect.  'transient' is for paranoid.

    transient private String userName = null;

    transient private String password = null;

    private String ackOnProduce = null;

    private String ackOnAcknowledge = null;

    private String connectionType = ClientConstants.CONNECTIONTYPE_NORMAL;

    private boolean adminKeyUsed = false;

    protected ConnectionMetaDataImpl connectionMetaData = null;

    private boolean debug = Debug.debug;

    //package protect field, so that protocol handler can access it.

    Properties configuration = null;

    //ConnectionConsumer workaround for 4715054

    private boolean isDedicatedToConnectionConsumer = true;

    private volatile boolean negotiateProtocolLevel = false;

    private int brokerProtocolLevel = 0;

    private String brokerVersion = "Unknown";

    //ping interval -- default to 30 seconds.

    private long imqPingInterval = 30 * 1000;

    //event listener

    //private EventListener eventListener = null;

    //blocking wait timeout -- 30 secs.

    private static long WAIT_TIME_OUT = 30000;

    //event listener

    protected EventListener eventListener = null;

    protected EventHandler eventHandler = null;

    //HA variables.

    protected volatile boolean isConnectedToHABroker = false;

    protected String JMQClusterID = null;

    protected Long JMQStoreSession = null;

    protected String JMQBrokerList = null;

    protected String savedJMQBrokerList = null;

    protected String JMQStoreOwner = null;

    protected String lastContactedBrokerAddress = null;

    //if set to true, client runtime will notify the connection event listener

    //with all the MQ event available.  Such as broker address list changed.

    private boolean extendedEventNotification = false;

    private boolean _appTransactedAck = false;

    //root logging domain name

    public static final String ROOT_LOGGER_NAME = "javax.jms";

    //connection logging domain name.

    public static final String CONNECTION_LOGGER_NAME =

                               ROOT_LOGGER_NAME + ".connection";

    protected static final Logger connectionLogger =

        Logger.getLogger(CONNECTION_LOGGER_NAME,