AbstractManagedConnectionFactory

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.bea.adapter.spi
Class AbstractManagedConnectionFactory

java.lang.Object
  com.bea.adapter.spi.AbstractManagedConnectionFactory

All Implemented Interfaces:: javax.resource.spi.ManagedConnectionFactory, Serializable

Direct Known Subclasses:: AbstractBEAManagedConnectionFactory

public abstract class AbstractManagedConnectionFactory
extends Object
implements javax.resource.spi.ManagedConnectionFactory, Serializable

A ManagedConnectionFactory creates physical connections to the underlying EIS for the application server. A physical connection is encapsulated by a ManagedConnection instance. This class encapsulates functionality that is generic across all types of adapters. It provides the following features:

Initializes the ADK logging framework with root context, priority level, and locale information.
Initializes a ResourceBundle using the base message bundle property.
Hides the complexity around creating and matching connections

Each instance of this class is configured with properties set in the app-server specific descriptor for the RAR module as deployed in the app server.

Author:: Copyright (c) 1998-2000 by BEA Systems, Inc. All Rights Reserved.
See Also:: Serialized Form

Field Summary
`protected char[]`	`m_achPassword` Standard connection parameters; treated as optional
`protected PropertyChangeSupport`	`m_changes`
`protected String`	`m_strAdapterDescription` Basic adapter metadata; these come from a resource bundle
`protected String`	`m_strAdapterName` Basic adapter metadata; these come from a resource bundle
`protected String`	`m_strAdapterVendorName` Basic adapter metadata; these come from a resource bundle
`protected String`	`m_strAdapterVersion` Basic adapter metadata; these come from a resource bundle
`protected String`	`m_strAdditionalLogContext` This value associates "this" with an application component in the runtime environment.
`protected String`	`m_strConnectionURL` Standard connection parameters; treated as optional
`protected String`	`m_strCountryCode` Associates a country code for determining the locale for logging
`protected String`	`m_strLanguageCode` Associates a language code for determining the locale for logging
`protected String`	`m_strLogConfigFile` This value provides the name of the log configuration file
`protected String`	`m_strLogLevel` Log level - warning by default
`protected String`	`m_strMessageBundleBase` Base name for message bundle
`protected String`	`m_strPortNumber` Standard connection parameters; treated as optional
`protected String`	`m_strRootLogContext` Allows for the categorization of log messages for this adapter.
`protected String`	`m_strServerName` Standard connection parameters; treated as optional
`protected String`	`m_strUserName` Standard connection parameters; treated as optional
`protected VetoableChangeSupport`	`m_vetos`

Constructor Summary
`AbstractManagedConnectionFactory()` Constructs a managed connection factory instance.

Method Summary
`void`	`addPropertyChangeListener(PropertyChangeListener l)` To support JavaBeans constrained properties
`void`	`addVetoableChangeListener(VetoableChangeListener l)` To support JavaBeans constrained properties
`protected void`	`appendField(StringBuffer sb, String strPropertyName, Object objValue)`
`protected void`	`assertValidLicense()` Verifies the existence of a valid license for this adapter; if there is no valid license available, this method throws an exception to prevent the instantiation of a `ManagedConnectionFactory` object.
`protected void`	`assertValidState()` Verifies that "this" is in a valid state that allows "this" to perform its factory responsibilities successfully.
`protected ValidationResult`	`checkLicense()` Returns true if the adapter can locate a valid license in the runtime environment.
`protected boolean`	`checkState()` Returns true if all the members of this class are set correctly.
`protected boolean`	`compareCharArrays(char[] achMyProperty, char[] achOtherProperty)` Compares two property arrays for equality.
`protected boolean`	`comparePropertyValues(Object myProperty, Object otherProperty)` Compares two properties for equality.
`Object`	`createConnectionFactory()` This method is invoked in the non-managed case.
`Object`	`createConnectionFactory(javax.resource.spi.ConnectionManager connectionManager)` Creates an EIS-specific connection factory.
`protected abstract Object`	`createConnectionFactory(javax.resource.spi.ConnectionManager connectionManager, String strAdapterName, String strAdapterDescription, String strAdapterVersion, String strAdapterVendorName)` Creates a new instance of a connection factory using the supplied parameters.
`boolean`	`equals(Object other)`
`String`	`getAdapterDescription()`
`String`	`getAdapterName()`
`String`	`getAdapterVendor()`
`String`	`getAdapterVersion()`
`String`	`getAdditionalLogContext()`
`String`	`getConnectionURL()` Retrieves the ConnectionURL; a "standard" connection property as suggested by the J2EE Connector Architecture
`String`	`getCountryCode()`
`String`	`getLanguageCode()`
`String`	`getLogConfigFile()`
`protected LogContext`	`getLogContext()` Retrieves an object that determines the logging configuration for this instance in the logging framework.
`protected ILogger`	`getLogger()` Retrieves an object used to log information to.
`String`	`getLogLevel()`
`PrintWriter`	`getLogWriter()`
`String`	`getMessageBundleBase()`
`String`	`getPassword()` Retrieves the Password; a "standard" connection property as suggested by the J2EE Connector Architecture
`javax.resource.spi.security.PasswordCredential`	`getPasswordCredential(Subject subject, javax.resource.spi.ConnectionRequestInfo info)` Returns an object that encapsulates a user name and password, gathered from either the JAAS Subject object or the connection request info object.
`protected String`	`getPasswordFromRequestInfo(javax.resource.spi.ConnectionRequestInfo info)` Retrieves the password from the supplied connection request info object.
`String`	`getPortNumber()` Retrieves the PortNumber; a "standard" connection property as suggested by the J2EE Connector Architecture
`String`	`getRootLogContext()`
`String`	`getServerName()` Retrieves the ServerName; a "standard" connection property as suggested by the J2EE Connector Architecture.
`String`	`getUserName()` Retrieves the UserName; a "standard" connection property as suggested by the J2EE Connector Architecture
`protected String`	`getUserNameFromRequestInfo(javax.resource.spi.ConnectionRequestInfo info)` Retrieves the user name from the supplied connection request info object.
`int`	`hashCode()` Calculates an integer code for use in lookup from hash tables.
`protected boolean`	`hasSameBaseProperties(AbstractManagedConnectionFactory otherMcf)` Compares all the non-connection related properties provided by `com.bea.adapter.spi.AbstractManagedConnectionFactory`
`protected boolean`	`hasSameConnectionProperties(AbstractManagedConnectionFactory otherMcf)` Adapter developers should override this method if they have connection properties other than the standard ones provided by this implementation.
`protected void`	`initAdapterMetaData(ResourceBundle resourceBundle)` Retrieves metadata about the resource adapter from a message bundle.
`protected void`	`initializeLogResources()` Initializes resources needed by this instance to support localized logging after all base member variables have been initialized correctly by the application server.
`protected boolean`	`isValidState()` The application server creates an instance of this class and then calls the setter methods.
`protected void`	`logInfo()` Writes information about 'this' instance to the underlying logger as a info message.
`javax.resource.spi.ManagedConnection`	`matchManagedConnections(Set connectionSet, Subject subject, javax.resource.spi.ConnectionRequestInfo info)` This method gets called by the ConnectionManager to try to find a valid connection in the pool it is managing.
`void`	`removePropertyChangeListener(PropertyChangeListener l)` To support JavaBeans constrained properties
`void`	`removeVetoableChangeListener(VetoableChangeListener l)` To support JavaBeans constrained properties
`void`	`setAdapterDescription(String strAdapterDescription)` Sets the adapter description; this overrides the setting provided by the message bundle for this instance if the adapter_description key is mapped to a value in the message bundle.
`void`	`setAdapterName(String strAdapterName)` Sets the adapter name; this overrides the setting provided by the message bundle for this instance if the adapter_name key is mapped to a value in the message bundle.
`void`	`setAdapterVendor(String strAdapterVendor)` Sets the adapter vendor; this overrides the setting provided by the message bundle for this instance if the adapter_vendor key is mapped to a value in the message bundle.
`void`	`setAdapterVersion(String strAdapterVersion)` Sets the adapter version; this overrides the setting provided by the message bundle for this instance if the adapter_version key is mapped to a value in the message bundle.
`void`	`setAdditionalLogContext(String strAdditionalLogContext)` Sets additional context information for identifying logging configuration.
`void`	`setConnectionURL(String strConnectionURL)` Sets the ConnectionURL for connecting to the underlying EIS.
`void`	`setCountryCode(String strCountryCode)` Sets the country code for enabling I18N log and exception messages from instances of this class.
`void`	`setLanguageCode(String strLanguageCode)` Sets the language code for enabling I18N log and exception messages from instances of this class.
`void`	`setLogConfigFile(String strLogConfigFile)` Sets the name for the log configuration file used by this instance.
`void`	`setLogLevel(String strLogLevel)` Sets the log priority level for 'this' instance.
`void`	`setLogWriter(PrintWriter out)`
`void`	`setMessageBundleBase(String strMessageBundleBase)` Sets the base name for the message bundle used by this instance.
`void`	`setPassword(String strPassword)` Sets the Password for connecting to the underlying EIS.
`void`	`setPortNumber(String strPortNumber)` Sets the PortNumber for connecting to the underlying EIS.
`void`	`setRootLogContext(String strRootLogContext)` Sets the root log context for this factory.
`void`	`setServerName(String strServerName)` Sets the ServerName for connecting to the underlying EIS.
`void`	`setUserName(String strUserName)` Sets the UserName for connecting to the underlying EIS.
`String`	`toString()`

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.resource.spi.ManagedConnectionFactory

createManagedConnection

Field Detail

m_vetos

protected VetoableChangeSupport m_vetos

m_changes

protected PropertyChangeSupport m_changes

m_strRootLogContext

protected String m_strRootLogContext

Allows for the categorization of log messages for this adapter.

m_strAdditionalLogContext

protected String m_strAdditionalLogContext

This value associates "this" with an application component in the runtime environment.

m_strLogConfigFile

protected String m_strLogConfigFile

This value provides the name of the log configuration file

m_strLogLevel

protected String m_strLogLevel

Log level - warning by default

m_strMessageBundleBase

protected String m_strMessageBundleBase

Base name for message bundle

m_strLanguageCode

protected String m_strLanguageCode

Associates a language code for determining the locale for logging

m_strCountryCode

protected String m_strCountryCode

Associates a country code for determining the locale for logging

m_strAdapterName

protected String m_strAdapterName

Basic adapter metadata; these come from a resource bundle

m_strAdapterDescription

protected String m_strAdapterDescription

Basic adapter metadata; these come from a resource bundle

m_strAdapterVersion

protected String m_strAdapterVersion

Basic adapter metadata; these come from a resource bundle

m_strAdapterVendorName

protected String m_strAdapterVendorName

Basic adapter metadata; these come from a resource bundle