Configuring the connector

Connectors have two types of configuration properties: standard configuration properties and adapter-specific configuration properties. You must set the values of these properties using Connector Configurator before running the adapter. For further information, see Appendix B, Connector Configurator.

A connector obtains its configuration values at startup. During a run time session, you may want to change the values of one or more connector properties. Changes to some connector configuration properties, such as AgentTraceLevel, take effect immediately. Changes to other connector properties require connector component restart or system restart after a change. To determine whether a property is dynamic (taking effect immediately) or static (requiring either connector component restart or system restart), refer to the Update Method column in the Connector Properties window of the System Manager.

Standard connector properties

Standard connector configuration properties provide information that all adapters use. See Appendix A, Standard configuration properties for connectors for documentation of these properties.

The following table provides information specific to this connector about standard configuration properties listed in the appendix.

Property Description
DuplicateEvent Elimination The connector does not use this property.
Locale Because this connector has been internationalized, you can change the value of this property.
PollEndTime The connector does not use this property.
PollFrequency The connector does not use this property.
PollStartTime The connector does not use this property.

You must provide a value for the ApplicationName configuration property before running the connector.

Connector-specific properties

Connector-specific configuration properties provide information needed by the connector at run time. These properties also provide a way for you to change static information or logic within the connector without having to recode and rebuild it.

To configure connector-specific properties, use Connector Configurator. Click the Application Config Properties tab to add or modify configuration properties. For more information, see Appendix B, Connector Configurator.

Note that all the connector-specific properties are optional in that you can choose to set them based on your specific connector configuration requirements: Do you want the connector to create both factory objects and connections, only a factory object, or only connections?

Table 2 lists the connector-specific configuration properties for the connector, along with their descriptions and possible values. The + character indicates the entry's position in the property hierarchy. See the sections that follow for details about the properties, including a representation of the hierarchical relationship of the properties in Figure 3.

Table 2. Connector-specific configuration properties

Name Possible values Default value
+ Factory None None
+ + FactoryClass The class name None
+ + FactoryInitializer Method name of the initializer None
+ + + Arguments Any encrypted or non-encrypted strings None
+ + FactoryMethod Method name None
+ + + Arguments Any encrypted or non-encrypted strings None
+ ConnectionPool None None
+ + ConnectionClass Class name None
+ + ConnectionInitializer Method name of the initializer None
+ + + Arguments Any encrypted or non-encrypted strings None
+ + PoolSize Any integer 0
+ ThreadingModel Apartment, Free Free

Figure 3 illustrates the hierarchical relationship of the connector-specific properties.


Figure 3. Hierarchy of connector-specific properties

Factory

A hierarchical property that represents the Factory class information.

FactoryClass

The name of the factory class.

FactoryInitializer

The method name of the initializer for the FactoryClass. This method never acts as a constructor.

Arguments

String values representing the parameters of the FactoryInitializer method. These can be any encrypted or non-encrypted strings.

FactoryMethod

The method name of the FactoryMethod on the FactoryClass. If you specify a FactoryMethod, the connection pool obtains connections using the FactoryMethod. ConnectionInitializer is called after a connection object is created. The connection may or may not come from the FactoryMethod.

Arguments

The parameters of the FactoryMethod must be arguments (Argument1, Argument2, and so on) on the Factory, listed in proper sequential order. The property names are Argument1, Argument2, and so on, for as many parameters as the method takes. The value of each argument is any encrypted or non-encrypted string.

ConnectionPool

The property for the Connection class information.

ConnectionClass

The name of the poolable connection class.

The size of the pool (number of connections) is based on the value you specify in the PoolSize property.

Since a connection is a reference to an application with some kind of state information, note that if you use connection pooling on a single-use server, multiple instances of the application referenced by the connection are created. Each instance is called on a single BO handler thread.

Likewise, if you use connection pooling on a multi-use server (one instance of a server object can be re-used to create a connection), then you have to set up a factory and factory method call to create the connection pool. In this case, each BO handler thread pulls a discrete connection from the pool to be used during processing.

ConnectionInitializer

The name of the poolable ConnectionClass initializer method. This method never acts as a constructor.

ConnectionInitializer is called after the connection object is created, whether or not the connection comes from the Factory.

Arguments

String values representing parameters for the initializer. The values may be encrypted or non-encrypted strings.

PoolSize

Determines the size of the connection pool. This property is required if you specify a ConnectionClass.

ThreadingModel

Indicates whether the connector uses the Multi-Threaded Apartment (MTA) or the Single Threaded Apartment (STA) threading model. If this property is set to Apartment, the connector runs in STA mode (not threadsafe). STA mode causes the connector to be single-threaded.

If the property is set to Free, the connector runs in MTA mode. In MTA mode (threadsafe), multi-threaded clients can make direct calls to the object. The default value is Free (threadsafe, Multi-Threaded Apartment mode).

Note:
If you are running in Single-Threaded Apartment mode (you have set the property value to Apartment), the connection pool and factory are disabled.

Copyright IBM Corp. 1997, 2003