RPM Web Services are configured using two property files: com.ibm.rpm.GeneralOptions.properties
and com.ibm.rpm.LdapOptions.properties. The files are located in the directory
where rpw-web-services.ear has been deployed.
Table 1. Application Servers and Configuration filesApplication Server |
Configuration Files’ Directory location |
Tomcat 5.0, 5.5 |
{TomcatInstallDir}\webapps\rpm\WEB-INF\classes |
WebSphere 6.0 |
{WebSphereInstallDir}\profiles\{profile}\installedApps\{cell}\rpm-web-services.ear\rpm-web-services.war\WEB-INF\classes |
General Options
The file com.ibm.rpm.GeneralOptions.properties
contains the set of general options for RPM Web Services. The values of these
options must be edited as required for your application.
Authentication
Type
- Property name: authenticationType
- Type: String
- Default Value: Database
- Description: Specifies the type of authentication used when the RPM Web
Services’ client calls Authenticate.login(username,
password, dsn). Valid values are: Database, LDAP.
- When using Database authentication, the username and password supplied
are matched with the username and password specified in the Resource Management
section of RPM’s database.
Note: When Database authentication is specified,
the file com.ibm.rpm.LdapOptions.properties is ignored.
- When using LDAP authentication, the username supplied is matched with
the one specified in the Resource Management section of RPM’s database, then
the password is matched with the one specified on the configured LDAP server.
The Ldap configuration is located in com.ibm.rpm.LdapOptions.properties .
Note: The changePassword method is not available when LDAP authentication is specified.
Use Session Timeout
- Property name: useSessionTimeout
- Type: boolean
- Default Value: false
- Description: If this value is set to true, the RPM Web Services
will automatically disable sessions which have remained inactive for a period
of time greater than is specified in the parameter sessionTimeoutDelayInSeconds.
Session Timeout Delay In Seconds
- Property name: sessionTimeoutDelayInSeconds
- Type: Integer
- Default Value: 600 seconds
- Description: This value specifies the lapse of time in seconds during
which a session can remain inactive before it times out. This parameter is
not used if the useSessionTimeout parameter is set
to false. The value range of this parameter is 1 to 2147483647. If
an invalid value is detected, the default value is applied.
Use Api security flag on login
- Property name: useApiSecurityFlagOnLogin
- Type: String
- Default Value: no
- Description: If the value is set to yes, only users that have the security
right to use the Web Services API will be able to login when RPM Web Services’
client calls Authenticate.login(username, password, dsn).
Valid values are: on, off.
Ldap Options
The file com.ibm.rpm.LdapOptions.properties
contains the set of LDAP options for RPM Web Services. It is used only if
the general option
authenticationType is set to LDAP.
Edit the values of these options as required for your application.
Note: The
content of this file should be identical to the content of the RPM Middleware
configuration file com.ibm.rpm.auth.jndi.JNDIController.properties.
Search
Context
- Property name: com.ibm.rpm.auth.jndi.ldapsearchcontext
- Type: String
- Default Value: CN=Users,DC=corp,DC=hq,DC=ibm,DC=com
- Description: Defines the subset of the LDAP server to be searched for
the specified username. It is used as a filter during the directory search.
User ID Attribute
- Property name: com.ibm.rpm.auth.jndi.ldapuseridattr
- Type: String
- Default Value: uid
- Description: LDAP attribute that will be used to match Authenticate.login’s
username parameter.
User Authentication Distinguished Name
- Property name: com.ibm.rpm.auth.jndi.ldapuserauthdn
- Type: String
- Default Value: dn
- Description: Unique name for an entry in the LDAP directory.
LDAP Server URL
LDAP Context Implementation
LDAP Version
Security Protocol
- Property name: java.naming.security.protocol
- Type: String
- Default Value: simple
- Description: Security protocol to be used, valid values are: simple, ssl.
Security Authentication
SSL Key Store
- Property name: javax.net.ssl.keyStore
- Type: String
- Default Value: No default value
- Description: Specifies the location of where to find key material for
the default KeyManager.
SSL Key Store Type
- Property name: javax.net.ssl.keyStoreType
- Type: String
- Default Value: jks
- Description: Specifies the KeyStore file type for key material for the
default KeyManager.
SSL Key Store Password
- Property name: javax.net.ssl.keyStorePassword
- Type: String
- Default Value: No default value
- Description: Specifies the password to be used with this KeyStore.
SSL Trust Store
- Property name: javax.net.ssl.trustStore
- Type: String
- Default Value: No default value
- Description: Specifies the location of where to find key material for
the default TrustManager.
SSL Trust Store Type
- Property name: javax.net.ssl.trustStoreType
- Type: String
- Default Value: jks
- Description: Specifies the KeyStore file type for key material for the
default TrustManager.
SSL Trust Store Password
- Property name: javax.net.ssl.trustStorePassword
- Type: String
- Default Value: No default value
- Description: Specifies the password to be used with this KeyStore.
Data Source Recommended Settings
The following settings
are recommended for the RPMDATASOURCE connection pool:
- Connection timeout: 600 seconds
- Maximum connections: 50
- Minimum connections: 10
- Reap time: 180 seconds
- Unused timeout: 1800 seconds
It is recommended to keep the maximum connections number
equal or higher to the number of concurrent threads configured on the web
server.