/*
* IronJacamar, a Java EE Connector Architecture implementation
* Copyright 2013, Red Hat Inc, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the Eclipse Public License 1.0 as
* published by the Free Software Foundation.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Eclipse
* Public License for more details.
*
* You should have received a copy of the Eclipse Public License
* along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package javax.resource.spi;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.ObjectStreamField;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.EventObject;
/** The ConnectionEvent class provides information about the source of
* a connection related event.A ConnectionEvent instance contains the
* following information:
* <UL>
* <LI>Type of the connection event
* <LI>ManagedConnection instance that generated the connection event.
* A ManagedConnection instance is returned from the method
* ConnectionEvent.getSource.
* <LI>Connection handle associated with the ManagedConnection instance;
* required for the CONNECTION_CLOSED event and optional for the
* other event types.
* <LI>Optionally, an exception indicating the connection related error.
* Note that exception is used for CONNECTION_ERROR_OCCURRED.
* </UL>
*
* <p>This class defines following types of event notifications:
* <UL>
* <LI>CONNECTION_CLOSED
* <LI>LOCAL_TRANSACTION_STARTED
* <LI>LOCAL_TRANSACTION_COMMITTED
* <LI>LOCAL_TRANSACTION_ROLLEDBACK
* <LI>CONNECTION_ERROR_OCCURRED
* </UL>
*
* @version 0.5
* @author Rahul Sharma
* @see javax.resource.spi.ConnectionEventListener
*/
public class ConnectionEvent extends EventObject
{
/** Serial version uid */
private static final long serialVersionUID;
/** Persistence field information */
private static final ObjectStreamField[] serialPersistentFields;
private static final int ID_IDX = 0;
private static final int EXCEPTION_IDX = 1;
private static final int CONN_HANDLE_IDX = 2;
/** Event notification that an application component has closed the
* connection
**/
public static final int CONNECTION_CLOSED = 1;
/** Event notification that a Resource Manager Local Transaction was
* started on the connection
**/
public static final int LOCAL_TRANSACTION_STARTED = 2;
/** Event notification that a Resource Manager Local Transaction was
* committed on the connection
**/
public static final int LOCAL_TRANSACTION_COMMITTED = 3;
/** Event notification that a Resource Manager Local Transaction was
* rolled back on the connection
**/
public static final int LOCAL_TRANSACTION_ROLLEDBACK = 4;
/** Event notification that an error occurred on the connection.
* This event indicates that the ManagedConnection instance is
* now invalid and unusable.
**/
public static final int CONNECTION_ERROR_OCCURRED = 5;
/** Exception associated with the <code>ConnectionEvent</code>
* instance.
*
* @serial
**/
private Exception e;
/** Type of the event
**/
protected int id;
private Object connectionHandle;
static
{
Boolean legacy = (Boolean)AccessController.doPrivileged(new PrivilegedAction()
{
public Boolean run()
{
try
{
if (System.getProperty("org.jboss.j2ee.LegacySerialization") != null)
return Boolean.TRUE;
}
catch (Throwable ignored)
{
// Ignore
}
return Boolean.FALSE;
}
});
if (Boolean.TRUE.equals(legacy))
{
serialVersionUID = 2776168349823367611L;
serialPersistentFields = new ObjectStreamField[] {
/** @serialField id int */
new ObjectStreamField("id", int.class),
/** @serialField e Exception */
new ObjectStreamField("e", Exception.class),
/** @serialField connectionHandle Object */
new ObjectStreamField("connectionHandle", Object.class)
};
}
else
{
serialVersionUID = 5611772461379563249L;
serialPersistentFields = new ObjectStreamField[] {
/** @serialField id int */
new ObjectStreamField("id", int.class),
/** @serialField exception Exception */
new ObjectStreamField("exception", Exception.class),
/** @serialField connectionHandle Object */
new ObjectStreamField("connectionHandle", Object.class)
};
}
}
/**
* Construct a ConnectionEvent object. Exception defaults to null.
*
* @param source ManagedConnection that is the
* source of the event
* @param eid type of the Connection event
*/
public ConnectionEvent(ManagedConnection source, int eid)
{
super(source);
this.id = eid;
}
/**
* Construct a ConnectionEvent object.
*
* @param source ManagedConnection that is the
* source of the event
* @param exception exception about to be thrown to the application
* @param eid type of the Connection event
*/
public ConnectionEvent(ManagedConnection source,
int eid,
Exception exception)
{
super(source);
this.e = exception;
this.id = eid;
}
/**Get the connection handle associated with the Managed
* Connection instance. Used for CONNECTION_CLOSED event.
*
* @return the connection handle. May be null
*/
public Object getConnectionHandle()
{
return connectionHandle;
}
/**
* Set the connection handle. Used for CONNECTION_CLOSED event
* @param connectionHandle The connection handle
*/
public void setConnectionHandle(Object connectionHandle)
{
this.connectionHandle = connectionHandle;
}
/**
* Get the exception. May be null.
*
* @return the exception about to be thrown.
*/
public Exception getException()
{
return e;
}
/**
* Get the type of event
* @return The id
*/
public int getId()
{
return id;
}
/**
* Read object
* @param ois The object input stream
* @exception ClassNotFoundException If a class can not be found
* @exception IOException Thrown if an error occurs
*/
private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException
{
ObjectInputStream.GetField fields = ois.readFields();
String name = serialPersistentFields[ID_IDX].getName();
this.id = fields.get(name, CONNECTION_ERROR_OCCURRED);
name = serialPersistentFields[EXCEPTION_IDX].getName();
this.e = (Exception) fields.get(name, null);
name = serialPersistentFields[CONN_HANDLE_IDX].getName();
this.connectionHandle = fields.get(name, null);
}
/**
* Write object
* @param oos The object output stream
* @exception IOException Thrown if an error occurs
*/
private void writeObject(ObjectOutputStream oos) throws IOException
{
ObjectOutputStream.PutField fields = oos.putFields();
String name = serialPersistentFields[ID_IDX].getName();
fields.put(name, id);
name = serialPersistentFields[EXCEPTION_IDX].getName();
fields.put(name, e);
name = serialPersistentFields[CONN_HANDLE_IDX].getName();
fields.put(name, connectionHandle);
oos.writeFields();
}
}