mq5.0-source.main.mq-client.src.main.java.com.sun.messaging.jmq.jmsclient.XASessionImpl Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2000-2012 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.
*/
/*
* @(#)XASessionImpl.java 1.8 06/27/07
*/
package com.sun.messaging.jmq.jmsclient;
import javax.jms.*;
import javax.transaction.xa.XAResource;
import com.sun.messaging.AdministeredObject;
import com.sun.messaging.jms.ra.api.JMSRAManagedConnection;
/**
* An XASession provides a regular Session which can be used to
* create QueueReceivers, QueueSenders and QueueBrowsers (optional).
*
* XASession extends the capability of Session by adding access to a JMS
* provider's support for JTA (optional). This support takes the form of a
* javax.transaction.xa.XAResource object. The functionality of
* this object closely resembles that defined by the standard X/Open XA
* Resource interface.
*
*
An application server controls the transactional assignment of an
* XASession by obtaining its XAResource. It uses the XAResource to assign
* the session to a transaction; prepare and commit work on the
* transaction; etc.
*
*
An XAResource provides some fairly sophisticated facilities for
* interleaving work on multiple transactions; recovering a list of
* transactions in progress; etc. A JTA aware JMS provider must fully
* implement this functionality. This could be done by using the services
* of a database that supports XA or a JMS provider may choose to implement
* this functionality from scratch.
*
*
A client of the application server is given what it thinks is a
* regular JMS Session. Behind the scenes, the application server controls
* the transaction management of the underlying XASession.
*
* @see javax.jms.XASession javax.jms.XASession
* @see javax.jms.XAQueueSession javax.jms.XAQueueSession
*/
public class XASessionImpl extends UnifiedSessionImpl implements XASession {
private static boolean imqRecreateConsumerEnabled = false;
//flag to indicate if RA encounter remote ack failed.
private volatile boolean raRemoteAckFailedFlag = false;
//for RA remote ack failed notify/re-create consumer sync usage.
private Object remoteAckSyncObj = new Object();
private XAResourceImpl xar;
public XASessionImpl
(ConnectionImpl connection, boolean transacted, int ackMode) throws JMSException {
super (connection, transacted, ackMode);
xar = new XAResourceImpl(this);
}
public XASessionImpl
(ConnectionImpl connection, boolean transacted,
int ackMode, JMSRAManagedConnection mc) throws JMSException {
super (connection, transacted, ackMode, mc);
xar = new XAResourceImpl(this);
}
/**
* Return an XA resource to the caller.
*
* @return an XA resource to the caller
*/
public XAResource
getXAResource() {
return (XAResource) xar;
}
/**
* Is the session in transacted mode?
*
* @return true
*
* @exception JMSException if JMS fails to return the transaction
* mode due to internal error in JMS Provider.
*/
public boolean
getTransacted() throws JMSException {
checkSessionState();
if (xaTxnMode) {
return true;
}
return isTransacted;
}
/**
* Throws TransactionInProgressException since it should not be called
* for an XASession object.
*
* @exception TransactionInProgressException if method is called on
* a XASession.
*
*/
public void
commit() throws JMSException {
if (xaTxnMode) {
String error = AdministeredObject.cr.getKString(AdministeredObject.cr.X_COMMIT_ROLLBACK_XASESSION);
throw new TransactionInProgressException(error);
}
super.commit();
}
@Override
public void close() throws JMSException {
super.close();
if (xar != null) xar.close();
}
/**
* Throws TransactionInProgressException since it should not be called
* for an XASession object.
*
* @exception TransactionInProgressException if method is called on
* a XASession.
*
*/
public void
rollback() throws JMSException {
if (xaTxnMode) {
String error = AdministeredObject.cr.getKString(AdministeredObject.cr.X_COMMIT_ROLLBACK_XASESSION);
throw new TransactionInProgressException(error);
}
super.rollback();
}
/**
* Get the queue session associated with this XAQueueSession.
*
* @return the queue session object.
*
* @exception JMSException if a JMS error occurs.
*/
public Session
getSession() throws JMSException {
return (Session) this;
}
/**
* Perform recreate consumer for RA.
*
* Called by [email protected] when detects that remoteAckFailedFlag
* is set to true.
*
* @throws JMSException
*/
public void recreateConsumerForRA () {
//1. sync on some object -- objA.
//2. call this.recreateConsumers()
//3. reset remoteAckFailedFlag to false.
synchronized (this.remoteAckSyncObj) {
try {
sessionLogger.log(java.util.logging.Level.FINEST, "Re-create message consumer for RA starting ...");
recreateConsumers();
sessionLogger.log(java.util.logging.Level.FINEST, "Re-create message consumer for RA finished ...");
this.raRemoteAckFailedFlag = false;
} catch (Exception jmse) {
sessionLogger.log(java.util.logging.Level.SEVERE, jmse.getMessage(), jmse);
}
}
}
/**
* This is called from XAResourceForRA when a remote ack failed occurred.
*
* @param rae the remote exception that contains consumer UID
*/
public void notifyRemoteAcknowledgeException (RemoteAcknowledgeException rae) {
//if (imqRecreateConsumerEnabled == false) {
// return;
//}
//1. sync on some object -- objA.
//2. check if remoteAckFailedFlag is set. If already set, return.
//3. If not, check if the current CID in session matches the one in rae.
//4. If yes, set the flag to true, else return.
if ( this.raRemoteAckFailedFlag) {
return;
}
synchronized (this.remoteAckSyncObj) {
//if already set, simply return.
if (this.raRemoteAckFailedFlag) {
return;
}
/**
* This is to prevent multiple re-create consumers.
* After consumer(s) are re-created, the match will return false.
*/
boolean matched = matchConsumerIDs(rae, consumers, sessionLogger);
if (matched) {
this.raRemoteAckFailedFlag = true;
}
}
}
public boolean isRemoteAckFailed() {
return this.raRemoteAckFailedFlag;
}
public void stopSession() throws JMSException {
super.stopSession();
}
public void logException (Exception ex) {
sessionLogger.log (java.util.logging.Level.SEVERE , ex.getMessage(), ex);
}
}