Before you begin
Before you begin this task, implement and build the UserRegistry interface. For more information on developing custom user registries refer to Developing custom user registries. The following steps are required to configure custom user registries through the administrative console.
Steps for this task
The file exists in the WebSphere Application Server class path preferably in the app_server_root/lib/ext directory.
This file exists in all the product processes. Thus, this file exists in the cell class path and in all of the node class paths.
Although the custom registry implements the com.ibm.websphere.security.UserRegistry interface, for backward compatibility, a user registry can alternately implement the com.ibm.websphere.security.CustomRegistry interface. The default is com.ibm.websphere.security.FileRegistrySample.
Property name | Property value |
---|---|
usersFile | ${USER_INSTALL_ROOT}/customer_sample /users.props |
groupsFile | ${USER_INSTALL_ROOT}/customer_sample /groups.props |
Samples of these two properties are available in users.props file and groups.props file.
The Description, Required, and Validation Expression fields are not used and can remain blank.
In a Network Deployment environment where multiple WebSphere Application Server processes exist such as cell and multiple nodes in different machines, these properties are available for each process. Use the USER_INSTALL_ROOT relative name to locate any files, as this name expands to the product installation directory. If this name is not used, ensure that the files exist in the same location in all the nodes.
Set the WAS_UseDisplayName property, which is predefined by WebSphere Application Server, only when it is required. When the property is set to true, the getCallerPrincipal, getUserPrincipal, and getRemoteUser methods return the display name. By default, the securityName of the user is returned. This property is primarily introduced to support backward compatibility with the Version 5 custom user registry.
Result
This set of steps is required to set up the custom user registry and to enable security in WebSphere Application Server.
What to do next
Related concepts
Custom user registries
Related tasks
Developing custom user registries
Migrating custom user registries
Selecting a user registry
Related reference
UserRegistry interface methods