com.sun.enterprise.resource

Class ResourceHandle

java.lang.Object

com.sun.enterprise.resource.ResourceHandle

All Implemented Interfaces:

ResourceHandle, TransactionalResource

Direct Known Subclasses:

AssocWithThreadResourceHandle

public class ResourceHandle
extends Object
implements ResourceHandle, TransactionalResource

ResourceHandle encapsulates a resource connection. Equality on the handle is based on the id field

Author:

Tony Ng

Field Summary

Fields

Modifier and Type	Field and Description
Object	lock

Constructor Summary

Constructors

Constructor and Description
ResourceHandle(Object resource, ResourceSpec spec, ResourceAllocator alloc, ClientSecurityInfo info)

Method Summary

Modifier and Type	Method and Description
void	closeUserConnection()
void	decrementCount()
void	destroyResource()
void	enlistedInTransaction(Transaction tran) Indicates that a resource has been enlisted in the transaction.
boolean	equals(Object other)
void	fillInResourceObjects(Object userConnection, XAResource xaRes)
ClientSecurityInfo	getClientSecurityInfo()
Object	getComponentInstance()
long	getId()
long	getLastValidated()
javax.resource.spi.ConnectionEventListener	getListener()
String	getName()
int	getPartition()
Object	getResource()
ResourceAllocator	getResourceAllocator()
ResourceSpec	getResourceSpec()
ResourceState	getResourceState()
int	getShareCount()
Subject	getSubject()
int	getUsageCount()
Object	getUserConnection()
XAResource	getXAResource()
boolean	hasConnectionErrorOccurred()
int	hashCode()
void	incrementCount()
void	incrementUsageCount()
boolean	isBusy()
boolean	isEnlisted()
boolean	isEnlistmentSuspended() To check whether lazy enlistment is suspended or not. If true, TM will not do enlist/lazy enlist.
boolean	isMarkedForReclaim() To check if the resourceHandle is marked for leak reclaim or not.
boolean	isShareable()
boolean	isTransactional() Does this resource need enlistment to transaction manager?
void	markForReclaim(boolean reclaim)
void	setBusy(boolean isBusy)
void	setComponentInstance(Object instance)
void	setConnectionErrorOccurred()
void	setEnlistmentSuspended(boolean enlistmentSuspended)
void	setLastValidated(long lastValidated)
void	setListener(javax.resource.spi.ConnectionEventListener l)
void	setPartition(int partition)
void	setResourceSpec(ResourceSpec spec)
void	setResourceState(ResourceState state)
void	setSubject(Subject subject)
boolean	supportsLazyAssociation()
boolean	supportsLazyEnlistment()
boolean	supportsXA()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

lock

public final Object lock

Constructor Detail

ResourceHandle

public ResourceHandle(Object resource,
                      ResourceSpec spec,
                      ResourceAllocator alloc,
                      ClientSecurityInfo info)

Method Detail

isTransactional

public boolean isTransactional()

Does this resource need enlistment to transaction manager?

Specified by:

isTransactional in interface ResourceHandle

Specified by:

isTransactional in interface TransactionalResource

isEnlistmentSuspended

public boolean isEnlistmentSuspended()

To check whether lazy enlistment is suspended or not.
If true, TM will not do enlist/lazy enlist.

Specified by:

isEnlistmentSuspended in interface ResourceHandle

Specified by:

isEnlistmentSuspended in interface TransactionalResource

Returns:

boolean

setEnlistmentSuspended

public void setEnlistmentSuspended(boolean enlistmentSuspended)

Specified by:

setEnlistmentSuspended in interface ResourceHandle

markForReclaim

public void markForReclaim(boolean reclaim)

isMarkedForReclaim

public boolean isMarkedForReclaim()

To check if the resourceHandle is marked for leak reclaim or not.

Returns:

boolean

supportsXA

public boolean supportsXA()

Specified by:

supportsXA in interface ResourceHandle

Specified by:

supportsXA in interface TransactionalResource

getResourceAllocator

public ResourceAllocator getResourceAllocator()

getResource

public Object getResource()

getClientSecurityInfo

public ClientSecurityInfo getClientSecurityInfo()

setResourceSpec

public void setResourceSpec(ResourceSpec spec)

getResourceSpec

public ResourceSpec getResourceSpec()

getXAResource

public XAResource getXAResource()

Specified by:

getXAResource in interface ResourceHandle

Specified by:

getXAResource in interface TransactionalResource

getUserConnection

public Object getUserConnection()

setComponentInstance

public void setComponentInstance(Object instance)

Specified by:

setComponentInstance in interface ResourceHandle

Specified by:

setComponentInstance in interface TransactionalResource

closeUserConnection

public void closeUserConnection()
                         throws PoolingException

Specified by:

closeUserConnection in interface ResourceHandle

Specified by:

closeUserConnection in interface TransactionalResource

Throws:

PoolingException

getComponentInstance

public Object getComponentInstance()

Specified by:

getComponentInstance in interface ResourceHandle

Specified by:

getComponentInstance in interface TransactionalResource

getId

public long getId()

fillInResourceObjects

public void fillInResourceObjects(Object userConnection,
                                  XAResource xaRes)

incrementCount

public void incrementCount()

decrementCount

public void decrementCount()

getShareCount

public int getShareCount()

setSubject

public void setSubject(Subject subject)

getSubject

public Subject getSubject()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

setConnectionErrorOccurred

public void setConnectionErrorOccurred()

hasConnectionErrorOccurred

public boolean hasConnectionErrorOccurred()

setResourceState

public void setResourceState(ResourceState state)

getResourceState

public ResourceState getResourceState()

setListener

public void setListener(javax.resource.spi.ConnectionEventListener l)

getListener

public javax.resource.spi.ConnectionEventListener getListener()

isShareable

public boolean isShareable()

Specified by:

isShareable in interface ResourceHandle

Specified by:

isShareable in interface TransactionalResource

destroyResource

public void destroyResource()

Specified by:

destroyResource in interface ResourceHandle

Specified by:

destroyResource in interface TransactionalResource

isEnlisted

public boolean isEnlisted()

Specified by:

isEnlisted in interface ResourceHandle

Specified by:

isEnlisted in interface TransactionalResource

getLastValidated

public long getLastValidated()

setLastValidated

public void setLastValidated(long lastValidated)

getUsageCount

public int getUsageCount()

incrementUsageCount

public void incrementUsageCount()

getPartition

public int getPartition()

setPartition

public void setPartition(int partition)

getName

public String getName()

Specified by:

getName in interface TransactionalResource

Returns:

the String that can identify this resource

supportsLazyEnlistment

public boolean supportsLazyEnlistment()

supportsLazyAssociation

public boolean supportsLazyAssociation()

enlistedInTransaction

public void enlistedInTransaction(Transaction tran)
                           throws IllegalStateException

Description copied from interface: TransactionalResource

Indicates that a resource has been enlisted in the transaction.

Specified by:

enlistedInTransaction in interface TransactionalResource

Parameters:

tran - Transaction to which the resource is enlisted

Throws:

IllegalStateException - when unable to enlist the resource

setBusy

public void setBusy(boolean isBusy)

isBusy

public boolean isBusy()