AbstractBusinessContextFactory

java.lang.Object
- com.ibm.commerce.context.factory.AbstractBusinessContextFactory

All Implemented Interfaces:

BusinessContextFactory

Direct Known Subclasses:

com.ibm.commerce.context.factory.SimpleBusinessContextFactory
```
public abstract class AbstractBusinessContextFactory
extends java.lang.Object
implements BusinessContextFactory
```
This class provides an abstract implementation of the business context factory. This factory class is used to create service provider interface objects for a specified business context. It also provides some helper methods that concrete business context factory class can use.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`ATTR_NAME` Attribute name in the business context configuration file for the name.
`protected static java.lang.String`	`ATTR_VALUE` Attribute name in the business context configuration file for the value.
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description
`AbstractBusinessContextFactory()` The do-nothing zero-argument constructor.
`AbstractBusinessContextFactory(java.util.List paramList)` This method constructs an `AbstractBusinessContextFactory` object with the given parameters.

Method Summary

Methods
Modifier and Type	Method and Description
`ContextSPI`	`createContextSPI(ActivityToken token, ActivityData initData)` This method creates a service provider interface object for the context associated with a given activity and initialization data.
`protected ContextSPI`	`createContextSPIClass(java.lang.String strImplClassname)` This method retrieves an instance of a given implementation class from its object pool.
`void`	`destroyContextSPI(ContextSPI ctxSPI)` This method returns a given context service provider interface object to the pool.
`protected abstract java.lang.String`	`getContextSPIImplClassname(ActivityToken token, ActivityData initData)` This method returns the service provider interface implementation for a given activity and initialization data.
`protected java.util.List`	`getParameters()` This method gets this factory's parameters, as specified in the business context configuration file.

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

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - ATTR_NAME
```
protected static final java.lang.String ATTR_NAME
```
    Attribute name in the business context configuration file for the name.
    
    See Also:
    
    Constant Field Values
  - ATTR_VALUE
```
protected static final java.lang.String ATTR_VALUE
```
    Attribute name in the business context configuration file for the value.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractBusinessContextFactory
```
public AbstractBusinessContextFactory()
```
    The do-nothing zero-argument constructor.
  - AbstractBusinessContextFactory
```
public AbstractBusinessContextFactory(java.util.List paramList)
```
    This method constructs an AbstractBusinessContextFactory object with the given parameters.
    
    Parameters:
    
    paramList - the list of parameters for this factory
- Method Detail
  - getContextSPIImplClassname
```
protected abstract java.lang.String getContextSPIImplClassname(ActivityToken token,
                                          ActivityData initData)
```
    This method returns the service provider interface implementation for a given activity and initialization data.
    
    Parameters:
    
    token - the token of the activity that the context is to be associated with
    
    initData - the data that will determine which implementation class to use. If the factory class is not attribute-based, this parameter is ignored.
    
    Returns:
    
    The name of the implementation class.
  - createContextSPIClass
```
protected ContextSPI createContextSPIClass(java.lang.String strImplClassname)
```
    This method retrieves an instance of a given implementation class from its object pool.
    
    Parameters:
    
    strImplClassname - the name of the implementation class
    
    Returns:
    
    An instance of the implementation class.
  - createContextSPI
```
public ContextSPI createContextSPI(ActivityToken token,
                          ActivityData initData)
```
    This method creates a service provider interface object for the context associated with a given activity and initialization data. As there could be more than one context implementation, this method first calls the getContextSPIImplClassname(ActivityToken, ActivityData) method. The getContextSPIImplClassname(ActivityToken, ActivityData) method uses the initialization data to determine which implementation class to use. Once the appropriate implementation class is known, this method calls the createContextSPIClass(String) method to retrieve its instance.
    
    Specified by:
    
    createContextSPI in interface BusinessContextFactory
    
    Parameters:
    
    token - the token of the activity that the context is to be associated with
    
    initData - the data that will determine which implementation class to use. If the factory class is not attribute-based, this parameter is ignored.
    
    Returns:
    
    The service provider interface object.
  - destroyContextSPI
```
public void destroyContextSPI(ContextSPI ctxSPI)
```
    This method returns a given context service provider interface object to the pool.
    
    Specified by:
    
    destroyContextSPI in interface BusinessContextFactory
    
    Parameters:
    
    ctxSPI - the service provider interface object to be returned
  - getParameters
```
protected java.util.List getParameters()
```
    This method gets this factory's parameters, as specified in the business context configuration file.
    
    Returns:
    
    This factory's parameter list.

Class AbstractBusinessContextFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

ATTR_NAME

ATTR_VALUE

Constructor Detail

AbstractBusinessContextFactory

AbstractBusinessContextFactory

Method Detail

getContextSPIImplClassname

createContextSPIClass

createContextSPI

destroyContextSPI

getParameters