Work with CMP connection factory properties files

Use properties files to create, modify, or delete container managed persistence (CMP) connection factory properties.

Determine the changes to make to your CMP connection factor configuration or its configuration objects.

Start the wsadmin scripting tool...

profile_home/bin/wsadmin -lang Jython

Use a properties file to create, modify, or delete a CMP connection factory object.

Run administrative commands using wsadmin to apply a properties file for a CMP connection factory to the configuration, validate the properties, or delete them.

Action	Procedure
create	Set required properties and then run the applyConfigProperties command.
modify	Edit required properties and then run the applyConfigProperties command.
delete	To delete the entire CMPConnectorFactory object, uncomment #DELETE=true and then run the deleteConfigProperties command.
create Property	Not applicable
delete Property	Not applicable

Optionally, we can use interactive mode with the commands:

AdminTask.command_name('-interactive')

Tasks

• Create a properties file for a CMPConnectorFactory instance.

  1. Set CMPConnectorFactory properties as needed.

     Open an editor on a CMPConnectorFactory properties file. odify the Environment Variables section to match the system and set any property value that needs to be changed. An example CMPConnectorFactory properties file follows:

     #
     # Header 
     #
     ResourceType=CMPConnectorFactory
     ImplementingResourceType=J2CResourceAdapter
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:J2CResourceAdapter=myJ2CResourceAdapter:
     CMPConnectorFactory=jndiName#myCFJNDI
     #DELETE=true
     #
     
     #
     #Properties
     #
     name=myCF #required
     connectionDefinition=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:J2CResourceAdapter=
     myJ2CResourceAdapter:Connector=:ResourceAdapter=:OutboundResourceAdapter=:ConnectionDefinition=
     connectionFactoryImplClass#com.ibm.ws.rsadapter.cci.WSRdbConnectionFactoryImpl #ObjectName
     (ConnectionDefinition),required
     category=null
     authMechanismPreference=BASIC_PASSWORD #ENUM(BASIC_PASSWORD|KERBEROS),default(BASIC_PASSWORD)
     providerType=null
     jndiName=myCFJNDI #required
     diagnoseConnectionUsage=false #boolean,default(false)
     xaRecoveryAuthAlias=null
     authDataAlias=null
     manageCachedHandles=false #boolean,default(false)
     description=null
     logMissingTransactionContext=true #boolean,default(true)
     #
     
     EnvironmentVariablesSection
     #Environment Variables
     cellName=myCell
     nodeName=myNode
     serverName=myServer
     

  2. Run the applyConfigProperties command to create or change a CMP connection factory configuration.

     Running the applyConfigProperties command applies the properties file to the configuration. In this Jython example, the optional -reportFileName parameter produces a report named report.txt:

     AdminTask.applyConfigProperties(['-propertiesFileName myObjectType.props -reportFileName report.txt '])
     

• Modify an existing properties file.
  1. Obtain a properties file for the CMP connection factory to change.

     We can extract a properties file for a CMPConnectorFactory object using the extractConfigProperties command.

  2. Open the properties file in an editor and change the properties as needed.

     Ensure that the environment variables in the properties file match the system.

  3. Run the applyConfigProperties command.

• If we no longer need the CMP connection factory, we can delete the entire CMP connection factory object.

  Specify DELETE=true in the header section of the properties file and run the deleteConfigProperties command; for example:

  AdminTask.deleteConfigProperties('[-propertiesFileName myObjectType.props -reportFileName report.txt]') 
  

Use the properties file to configure and manage the CMP connection factory object and its properties.

What to do next

Save the changes to the configuration.

Subtopics

• Work with CMP connection factory mapping module properties files
  Use properties files to create, modify, or delete mapping module properties of container managed persistence (CMP) connection factories.

Extracting properties files

Create server, cluster, application, or authorization group objects using properties files and wsadmin scripting

Deleting server, cluster, application, or authorization group objects using properties files

PropertiesBasedConfiguration .