ConnectionEvent (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.resource.spi
Class ConnectionEvent

java.lang.Object
  java.util.EventObject
      javax.resource.spi.ConnectionEvent

All Implemented Interfaces:: Serializable

public class ConnectionEvent
extends EventObject
extends EventObject

The ConnectionEvent class provides information about the source of a connection related event.A ConnectionEvent instance contains the following information:

Type of the connection event
ManagedConnection instance that generated the connection event. A ManagedConnection instance is returned from the method ConnectionEvent.getSource.
Connection handle associated with the ManagedConnection instance; required for the CONNECTION_CLOSED event and optional for the other event types.
Optionally, an exception indicating the connection related error. Note that exception is used for CONNECTION_ERROR_OCCURRED.

This class defines following types of event notifications:

CONNECTION_CLOSED
LOCAL_TRANSACTION_STARTED
LOCAL_TRANSACTION_COMMITTED
LOCAL_TRANSACTION_ROLLEDBACK
CONNECTION_ERROR_OCCURRED

Version:: 0.5
Author:: Rahul Sharma
See Also:: ConnectionEventListener, Serialized Form

Field Summary

static int CONNECTION_CLOSED
          Event notification that an application component has closed the connection

static int CONNECTION_ERROR_OCCURRED
          Event notification that an error occurred on the connection.

protected int id
          Type of the event

static int LOCAL_TRANSACTION_COMMITTED
          Event notification that a Resource Manager Local Transaction was committed on the connection

static int LOCAL_TRANSACTION_ROLLEDBACK
          Event notification that a Resource Manager Local Transaction was rolled back on the connection

static int LOCAL_TRANSACTION_STARTED
          Event notification that a Resource Manager Local Transaction was started on the connection

Fields inherited from class java.util.EventObject

source

Constructor Summary

ConnectionEvent(ManagedConnection source, int eid)
          Construct a ConnectionEvent object.

ConnectionEvent(ManagedConnection source, int eid, Exception exception)
          Construct a ConnectionEvent object.

Method Summary

Object getConnectionHandle()
          Get the connection handle associated with the Managed Connection instance.

Exception getException()
          Get the exception.

int getId()
          Get the type of event

void setConnectionHandle(Object connectionHandle)
          Set the connection handle.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Summary
`static int`	`CONNECTION_CLOSED` Event notification that an application component has closed the connection
`static int`	`CONNECTION_ERROR_OCCURRED` Event notification that an error occurred on the connection.
`protected int`	`id` Type of the event
`static int`	`LOCAL_TRANSACTION_COMMITTED` Event notification that a Resource Manager Local Transaction was committed on the connection
`static int`	`LOCAL_TRANSACTION_ROLLEDBACK` Event notification that a Resource Manager Local Transaction was rolled back on the connection
`static int`	`LOCAL_TRANSACTION_STARTED` Event notification that a Resource Manager Local Transaction was started on the connection

Fields inherited from class java.util.EventObject
`source`

Constructor Summary
`ConnectionEvent(ManagedConnection source, int eid)` Construct a ConnectionEvent object.
`ConnectionEvent(ManagedConnection source, int eid, Exception exception)` Construct a ConnectionEvent object.

Method Summary
`Object`	`getConnectionHandle()` Get the connection handle associated with the Managed Connection instance.
`Exception`	`getException()` Get the exception.
`int`	`getId()` Get the type of event
`void`	`setConnectionHandle(Object connectionHandle)` Set the connection handle.

Methods inherited from class java.util.EventObject
`getSource, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

CONNECTION_CLOSED

public static final int CONNECTION_CLOSED

Event notification that an application component has closed the connection

See Also:: Constant Field Values

LOCAL_TRANSACTION_STARTED

public static final int LOCAL_TRANSACTION_STARTED

Event notification that a Resource Manager Local Transaction was started on the connection

See Also:: Constant Field Values

LOCAL_TRANSACTION_COMMITTED

public static final int LOCAL_TRANSACTION_COMMITTED

Event notification that a Resource Manager Local Transaction was committed on the connection

See Also:: Constant Field Values

LOCAL_TRANSACTION_ROLLEDBACK

public static final int LOCAL_TRANSACTION_ROLLEDBACK

Event notification that a Resource Manager Local Transaction was rolled back on the connection

See Also:: Constant Field Values

CONNECTION_ERROR_OCCURRED

public static final int CONNECTION_ERROR_OCCURRED

Event notification that an error occurred on the connection. This event indicates that the ManagedConnection instance is now invalid and unusable.

See Also:: Constant Field Values

id

protected int id

Type of the event

Constructor Detail