# com.beasys.commerce.ebusiness.catalog.service
JdbcCatalogServiceImpl Class

public class JdbcCatalogServiceImpl
extends `CatalogServiceImpl`

This is the base service implementation for all JDBC-based Catalog services. It contains common functionality that all JDBC-based Catalog services must implement; therefore, all JDBC-based Catalog service implementations should extend this class.
The `JdbcCatalogService``` depends upon several environment variables to dictate its runtime behavior:

- This service uses a JDBC connection pool that is specified by the `jdbc/commercePool` environment property.
- This service utilizes a schema file that contains object relational mapping information. The name of this file is specified by the `SchemaFile` environment variable.
- This services utilizes a SQL manager class that is specified by the `SqlManagerClass` environment variable.

Related Topics

``JdbcCatalogService``
``JdbcCatalogServiceHome``
``CatalogSqlManager``

Hierarchy
  `Object`
  `SessionImpl`
  `CatalogServiceImpl`
  `JdbcCatalogServiceImpl`

All Implemented Interfaces
  `EnterpriseBean`, `Serializable`, `SessionBean`

Direct Known Subclasses
  `JdbcCatalogQueryManagerImpl`, `JdbcCategoryManagerImpl`, `JdbcProductItemManagerImpl`

## Field Summary

`protected static final `String`` | `DATA_SOURCE_NAME` The environment property that specifies JDBC pool that all JDBC services will access.
`protected static final `String`` | `SCHEMA_FILE_NAME` The environment property that specifies the schema file that all JDBC services will utilize.
`protected static final `String`` | `SQL_MANAGER_CLASS` The environment property that specifies the SQL manager class that all JDBC service will utilize.

Fields from com.beasys.commerce.ebusiness.catalog.service`.`CatalogServiceImpl``
``CATALOG_MANAGER_HOME``

Fields from com.beasys.commerce.foundation`.`SessionImpl``
``_ctx`, `_environmentNamingContext`, `_environmentPropertyCache`, `_isDirty``

## Constructor Summary

JdbcCatalogServiceImpl()

## Method Summary

`public void` | `ejbActivate`() ejbActivate method.
`public void` | `ejbCreate`() ejbCreate method.
`public void` | `ejbPassivate`() ejbPassivate method.
`public void` | `ejbPostCreate`() ejbPostCreate method.
`public void` | `ejbRemove`() ejbRemove method.
`protected `String`` | `getCatalogSchemaName`() Returns the name of the Catalog schema file.
`protected `CatalogSqlManager`` | `getCatalogSqlManager`() Returns an instance of the Catalog SQL manager assoicated with this service.
`protected static `CatalogSqlManager`` | `getCatalogSqlManager`(`String` catalogManagerClassName, `String` schemaName) Returns a specified `CatalogSqlManager` implementation class instance.
`protected `String`` | `getCatalogSqlManagerName`() Returns the class name of the SQL manager associated with this service.
`protected `Connection`` | `getDatabaseConnection`() Gets a database connection from the Commerce Server connection pool.
`protected `JdbcCatalogFactory`` | `getJdbcCatalogFactory`() Returns a JDBC-based Catalog factory.
`public void` | `setSessionContext`(`SessionContext` ctx) setSessionContext method.

Methods from `com.beasys.commerce.ebusiness.catalog.service.`CatalogServiceImpl``
``getCatalogManager`, `getCatalogManagerJndiName`, `validateAuthorization``

Methods from `com.beasys.commerce.foundation.`SessionImpl``
``clearRelationalBinding`, `clearRelationalBinding`, `clearRelationalBinding`, `clearRelationalBinding`, `doRelationalBinding`, `doRelationalBinding`, `doRelationalBindingOnElement`, `doRelationalBindingOnElement`, `doRelationalBindingOnElement`, `doRelationalBindingOnSingleton`, `doRelationalBindingOnSingleton`, `doRelationalBindingOnSingleton`, `doRelationalBindingWithMapKey`, `doRelationalBindingWithMapKey`, `doRelationalBindingWithMapKey`, `ejbActivate`, `ejbCreate`, `ejbPassivate`, `ejbPostCreate`, `ejbRemove`, `enumerateRelationalBinding`, `enumerateRelationalBinding`, `getEnvironmentNamingContext`, `getEnvironmentProperty`, `getEnvironmentProperty`, `getEnvironmentPropertyCache`, `getPersistenceHelperPlugin`, `getSessionContext`, `setSessionContext``

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

Methods from interface `javax.ejb.`SessionBean``
`ejbActivate, ejbPassivate, ejbRemove, setSessionContext`

## Field Detail

### DATA_SOURCE_NAME

    protected static final String DATA_SOURCE_NAME

  The environment property that specifies JDBC pool that all JDBC services will access.

### SCHEMA_FILE_NAME

    protected static final String SCHEMA_FILE_NAME

  The environment property that specifies the schema file that all JDBC services will utilize.

### SQL_MANAGER_CLASS

    protected static final String SQL_MANAGER_CLASS

  The environment property that specifies the SQL manager class that all JDBC service will utilize.

## Constructor Detail

### JdbcCatalogServiceImpl

    public JdbcCatalogServiceImpl()

## Method Detail

### ejbActivate() Method

    public void ejbActivate()
         throws EJBException

Description copied from `SessionImpl.ejbActivate()`
ejbActivate method.

Overrides
  `CatalogServiceImpl.ejbActivate()`

#### Exceptions

``EJBException``

### ejbCreate() Method

    public void ejbCreate()
         throws CreateException

Description copied from `SessionImpl.ejbCreate()`
ejbCreate method.

Overrides
  `CatalogServiceImpl.ejbCreate()`

#### Exceptions

``CreateException``

### ejbPassivate() Method

    public void ejbPassivate()
         throws EJBException

Description copied from `SessionImpl.ejbPassivate()`
ejbPassivate method.

Overrides
  `CatalogServiceImpl.ejbPassivate()`

#### Exceptions

``EJBException``

### ejbPostCreate() Method

    public void ejbPostCreate()
         throws CreateException

Description copied from `SessionImpl.ejbPostCreate()`
ejbPostCreate method.

Overrides
  `CatalogServiceImpl.ejbPostCreate()`

#### Exceptions

``CreateException``

### ejbRemove() Method

    public void ejbRemove()
         throws EJBException

Description copied from `SessionImpl.ejbRemove()`
ejbRemove method.

Overrides
  `CatalogServiceImpl.ejbRemove()`

#### Exceptions

``EJBException``

### getCatalogSchemaName() Method

    protected String getCatalogSchemaName()
         throws SystemException

Returns the name of the Catalog schema file.

#### Returns

The Catalog schema filename.

#### Exceptions

``SystemException``

### getCatalogSqlManager() Method

    protected CatalogSqlManager getCatalogSqlManager()
         throws SystemException

Returns an instance of the Catalog SQL manager assoicated with this service.

#### Returns

An instance of the Catalog SQL manager.

#### Exceptions

``SystemException``

### getCatalogSqlManager(String, String) Method

    protected static CatalogSqlManager getCatalogSqlManager(String catalogManagerClassName,
                                                            String schemaName)
         throws SystemException

Returns a specified `CatalogSqlManager` implementation class instance.

#### Parameters

catalogManagerClassName
  The name of the `CatalogSqlManager` implementation class.

#### Exceptions

``SystemException``

### getCatalogSqlManagerName() Method

    protected String getCatalogSqlManagerName()
         throws SystemException

Returns the class name of the SQL manager associated with this service.

#### Returns

The SQL manager class name.

#### Exceptions

``SystemException``

### getDatabaseConnection() Method

    protected Connection getDatabaseConnection()
         throws CatalogDeploymentException

Gets a database connection from the Commerce Server connection pool.

#### Returns

A database connection from the CommerceServer connection pool.

#### Exceptions

``CatalogDeploymentException``
  if the connection pool is misconfigured.

### getJdbcCatalogFactory() Method

    protected JdbcCatalogFactory getJdbcCatalogFactory()
         throws SystemException

Returns a JDBC-based Catalog factory.

#### Returns

A JDBC-based Catalog factory.

#### Exceptions

``SystemException``

### setSessionContext(SessionContext) Method

    public void setSessionContext(SessionContext ctx)
         throws EJBException

Description copied from `SessionImpl.setSessionContext(SessionContext)`
setSessionContext method.

Overrides
  `CatalogServiceImpl.setSessionContext(SessionContext)`

#### Exceptions

``EJBException``