org.jboss.resource.adapter.jms

Class JmsManagedConnectionFactory

java.lang.Object

org.jboss.resource.adapter.jms.JmsManagedConnectionFactory

All Implemented Interfaces:

Serializable, ManagedConnectionFactory

public class JmsManagedConnectionFactory
extends Object
implements ManagedConnectionFactory

Jms ManagedConectionFactory

Author:

Peter Antman ., Adrian Brock

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JmsManagedConnectionFactory()

Method Summary

Methods

Modifier and Type	Method and Description
Object	createConnectionFactory() Create a "non managed" connection factory.
Object	createConnectionFactory(ConnectionManager cxManager) Create a ConnectionFactory with appserver hook
ManagedConnection	createManagedConnection(Subject subject, ConnectionRequestInfo info) Create a new connection to manage in pool
boolean	equals(Object obj) Checks for equality ower the configured properties.
String	getClientID() Get client id, may be null.
String	getConnectionFactory()
String	getJndiParameters()
PrintWriter	getLogWriter() Get the log writer for this ManagedConnectionFactory instance.
ConnectionMetaData	getMetaData()
String	getPassword() Get password, may be null.
protected JmsMCFProperties	getProperties()
String	getSessionDefaultType()
String	getUserName() Get userName, may be null.
Integer	getUseTryLock() Get the useTryLock.
int	hashCode() Returns the hash code for the ManagedConnectionFactory
Boolean	isDeleteTemporaryDestinations()
Boolean	isStrict()
ManagedConnection	matchManagedConnections(Set connectionSet, Subject subject, ConnectionRequestInfo info) Match a set of connections from the pool
void	setClientID(String clientID) Set client id, null by default.
void	setConnectionFactory(String connectionFactory)
void	setDeleteTemporaryDestinations(Boolean deleteTemporaryDestinations)
void	setJndiParameters(String jndiParameters)
void	setLogWriter(PrintWriter out) Set the log writer for this ManagedConnectionFactory instance.
void	setPassword(String password) Set password, null by default.
void	setSessionDefaultType(String type) Set the default session typ
void	setStrict(Boolean strict)
void	setUserName(String userName) Set userName, null by default.
void	setUseTryLock(Integer useTryLock) Set the useTryLock.

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsManagedConnectionFactory

public JmsManagedConnectionFactory()

Method Detail

createConnectionFactory

public Object createConnectionFactory()
                               throws ResourceException

Create a "non managed" connection factory. No appserver involved

Specified by:

createConnectionFactory in interface ManagedConnectionFactory

Returns:

EIS-specific Connection Factory instance or javax.resource.cci.ConnectionFactory instance

Throws:

ResourceException - Generic exception

ResourceAdapterInternalException - Resource adapter related error condition

createConnectionFactory

public Object createConnectionFactory(ConnectionManager cxManager)
                               throws ResourceException

Create a ConnectionFactory with appserver hook

Specified by:

createConnectionFactory in interface ManagedConnectionFactory

Parameters:

cxManager - ConnectionManager to be associated with created EIS connection factory instance

Returns:

EIS-specific Connection Factory instance or javax.resource.cci.ConnectionFactory instance

Throws:

ResourceException - Generic exception

ResourceAdapterInternalException - Resource adapter related error condition

createManagedConnection

public ManagedConnection createManagedConnection(Subject subject,
                                        ConnectionRequestInfo info)
                                          throws ResourceException

Create a new connection to manage in pool

Specified by:

createManagedConnection in interface ManagedConnectionFactory

Parameters:

subject - Caller's security information

info - Additional resource adapter specific connection request information

Returns:

ManagedConnection instance

Throws:

ResourceException - generic exception

SecurityException - security related error

ResourceAllocationException - failed to allocate system resources for connection request

ResourceAdapterInternalException - resource adapter related error condition

EISSystemException - internal error condition in EIS instance

matchManagedConnections

public ManagedConnection matchManagedConnections(Set connectionSet,
                                        Subject subject,
                                        ConnectionRequestInfo info)
                                          throws ResourceException

Match a set of connections from the pool

Specified by:

matchManagedConnections in interface ManagedConnectionFactory

Parameters:

connectionSet - candidate connection set

subject - caller's security information

info - additional resource adapter specific connection request information

Returns:

ManagedConnection if resource adapter finds an acceptable match otherwise null

Throws:

ResourceException - generic exception

SecurityException - security related error

ResourceAdapterInternalException - resource adapter related error condition

NotSupportedException - if operation is not supported

setLogWriter

public void setLogWriter(PrintWriter out)
                  throws ResourceException

Description copied from interface: ManagedConnectionFactory

Set the log writer for this ManagedConnectionFactory instance.

The log writer is a character output stream to which all logging and tracing messages for this ManagedConnectionfactory instance will be printed.

ApplicationServer manages the association of output stream with the ManagedConnectionFactory. When a ManagedConnectionFactory object is created the log writer is initially null, in other words, logging is disabled. Once a log writer is associated with a ManagedConnectionFactory, logging and tracing for ManagedConnectionFactory instance is enabled.

The ManagedConnection instances created by ManagedConnectionFactory "inherits" the log writer, which can be overridden by ApplicationServer using ManagedConnection.setLogWriter to set ManagedConnection specific logging and tracing.

Specified by:

setLogWriter in interface ManagedConnectionFactory

Parameters:

out - PrintWriter - an out stream for error logging and tracing

Throws:

ResourceException - generic exception

ResourceAdapterInternalException - resource adapter related error condition

getLogWriter

public PrintWriter getLogWriter()
                         throws ResourceException

Description copied from interface: ManagedConnectionFactory

Get the log writer for this ManagedConnectionFactory instance.

The log writer is a character output stream to which all logging and tracing messages for this ManagedConnectionFactory instance will be printed

ApplicationServer manages the association of output stream with the ManagedConnectionFactory. When a ManagedConnectionFactory object is created the log writer is initially null, in other words, logging is disabled.

Specified by:

getLogWriter in interface ManagedConnectionFactory

Returns:

PrintWriter

Throws:

ResourceException - generic exception

equals

public boolean equals(Object obj)

Checks for equality ower the configured properties.

Specified by:

equals in interface ManagedConnectionFactory

Overrides:

equals in class Object

Parameters:

obj - The other object

Returns:

true if two instances are equal

hashCode

public int hashCode()

Description copied from interface: ManagedConnectionFactory

Returns the hash code for the ManagedConnectionFactory

Specified by:

hashCode in interface ManagedConnectionFactory

Overrides:

hashCode in class Object

Returns:

hash code for the ManagedConnectionFactory

setJndiParameters

public void setJndiParameters(String jndiParameters)

getJndiParameters

public String getJndiParameters()

setConnectionFactory

public void setConnectionFactory(String connectionFactory)

getConnectionFactory

public String getConnectionFactory()

setUserName

public void setUserName(String userName)

Set userName, null by default.

getUserName

public String getUserName()

Get userName, may be null.

setPassword

public void setPassword(String password)

Set password, null by default.

getPassword

public String getPassword()

Get password, may be null.

getClientID

public String getClientID()

Get client id, may be null.

setClientID

public void setClientID(String clientID)

Set client id, null by default.

isStrict

public Boolean isStrict()

setStrict

public void setStrict(Boolean strict)

setSessionDefaultType

public void setSessionDefaultType(String type)
                           throws ResourceException

Set the default session typ

Parameters:

type - either javax.jms.Topic or javax.jms.Queue

Throws:

ResourceException - if type was not a valid type.

getSessionDefaultType

public String getSessionDefaultType()

getUseTryLock

public Integer getUseTryLock()

Get the useTryLock.

Returns:

the useTryLock.

setUseTryLock

public void setUseTryLock(Integer useTryLock)

Set the useTryLock.

Parameters:

useTryLock - the useTryLock.

setDeleteTemporaryDestinations

public void setDeleteTemporaryDestinations(Boolean deleteTemporaryDestinations)

isDeleteTemporaryDestinations

public Boolean isDeleteTemporaryDestinations()

getMetaData

public ConnectionMetaData getMetaData()

getProperties

protected JmsMCFProperties getProperties()