Managing Connection Factories in the LDAP Directory
Info*Engine supplies the com.infoengine.connector.AdminTool Java class for managing connection factories in the LDAP directory. This tool allows you to bind a new connection factory or unbind an existing connection factory.
The variables and actions used by the tool are supplied as parameters on the Java command. The properties file containing the connections configuration properties must also be supplied.
Variables
principal
The username.
password
The password for the user.
|
|
Any parameters being specified from the variables section must precede a single parameter from the actions section.
|
Actions
The following actions are available from the tool:
-bindConnectionFactory provider object ConnectionImplementation PropertiesFile
Where:
◦ provider is the LDAP system providing the connection.
◦ object is the connection factory being bound.
◦ ConnectionImplementation is the connection implementation specified in the properties file.
◦ PropertiesFile is the name of the Java properties file that contains the connection configuration properties. This properties file is discussed below.
-unbindConnectionFactory provider object
Where:
◦ provider is the LDAP system providing the connection.
◦ object is the connection factory being unbound.
Configuration Properties
The following configuration properties can be specified in the Java properties file:
HTTP Connection Implementation
This property applies to an HTTP connection implementation:
ConnectionURL
Specifies the endpoint of the Info*Engine SOAP service. For example:
http://<host>/<Windchill>/servlet/RPC
JMS Connection Implementation
These properties apply to a JMS connection implementation:
in.queue
Specifies the queue to which the SOAP requests are submitted. This property is required.
out.queue
Specifies the queue on which to wait for the SOAP responses. This property is required.
out.queue.wait
Specifies how long, in milliseconds, to wait for the SOAP response. The default value for this property is -1, which means to wait indefinitely for a response.
provider.url
Specifies the LDAP URL for the location of the subtree containing administered objects. For example:
ldap://localhost/cn=MQSeries,o=MyCompany
This property is required.
provider.principal
If required by your LDAP access controls, specifies the participant needed to bind to provider.url. For example: cn=Manager.
provider.credentials
The password for provider.principal, if required by your LDAP access controls.
queueConnectionFactory
Specifies the relative distinguished name (dn) of the queue connection factory administered object. This property is required.
queueConnectionFactory.user
If required, specifies the username needed to connect to queueConnectionFactory.
queueConnectionFactory.password
If required by your LDAP access controls, specifies the password associated with queueConnectionFactory.user.
Non-Connection Implementation Specific
The following properties are not connection implementation specific:
signRequests
Enables or disables digital signing of SOAP requests. Possible values are TRUE and FALSE, with FALSE being the default value.
keyStoreType
Specifies the type of keystore. The default value for this property is JKS.
keyStorePackageProvider
Specifies the keystore package provider. This property is optional.
keyStoreFilename
Specifies the path to the keystore. The default value for this property is .keystore in the user’s home directory.
keyStorePassword
Specifies the password for the keystore. This property is required.
certificateAlias
Specifies the alias of certificate to use. The default value for this property is iesoap.
privateKeyAlias
Specifies the alias of the private key. The default value for this property is value of the certificateAlias property.
privateKeyPassword
Specifies the private key password. The default value for this property is value of the keyStorePassword property.
Java Properties File
When creating a connection factory you must supply a Java properties file that contains the connection’s configuration properties.
An example of an HTTP connection factory configuration is:
#ConnectionImplementation=com.infoengine.connector.HTTPConnection
ConnectionURL=http://host/Windchill/servlet/RPC
An example of a JMS connection factory configuration is:
#ConnectionImplementation=com.infoengine.connector.JMSConnection
in.queue=cn=SOAP.in
out.queue=cn=SOAP.out
out.queue.wait=60000
queueConnectionFactory=cn=SOAP.qcf
provider.url=ldap://localhost/cn=MQSeries,o=MyCompany
provider.principal=cn=Manager
provider.credentials=admin
Assuming the properties listed previously for an HTTP connection factory were stored in a properties file named http.properties, the following command could be used to bind a new connection factory to an object at the distinguished name cn=cxFactory.HTTP,o=MyCompany:
java com.infoengine.connector.AdminTool -principal=cn=Manager
-password=admin -bindConnectionFactory "ldap://localhost/o=MyCompany"
cxFactory.HTTP com.infoengine.connector.HTTPConnection
./http.properties
The following command could then be used to unbind the connection factory just created:
java com.infoengine.connector.AdminTool -principal=cn=Manager -password=admin
-unbindConnectionFactory "ldap://localhost/o=MyCompany" cxFactory.HTTP
