24 Profile Service Provider Configuration Reference (profile.xml)

This chapter describes a profile provider configuration file, profile.xml:

• Overview of profile.xml

• Graphical Representation

• Editing profile.xml

• XML Schema

• Example profile.xml File

• XML Element Description

Overview of profile.xml

The profile.xml file configures attributes of a profile service provider, such as:

• The name of the provider

• The class name of the provider implementation

• Optional arguments passed to the provider

• Mapping rules for using the provider

The profile.xml file is located in the CAS_home/config/custom subdirectory where CAS_home is the root directory of the Oracle Communications Converged Application Server domain.

Graphical Representation

Figure 24-1 shows the element hierarchy of the profile.xml file.

Figure 24-1 Element Hierarchy of profile.xml

Editing profile.xml

Oracle recommends using the Administration Console profile service extension to modify profile.xml indirectly, rather than editing the file manually using a text editor or other XML editing application. Using the Administration Console ensures that the profile.xml document always contains valid XML. See "Configuring Profile Providers Using the Administration Console" in the Converged Application Server Application Developer's Guide.

You may need to manually view or edit profile.xml to troubleshoot problem configurations, repair corrupted files, or to roll out custom profile provider configurations to a large number of machines when installing or upgrading Converged Application Server. When you manually edit profile.xml, you must reboot servers to apply your changes.

Steps for Editing profile.xml

If you need to modify profile.xml on a production system, follow these steps:

1. Use a text editor to open the CAS_home/config/custom/profile.xml file, where CAS_home is the root directory of the Converged Application Server domain.

2. Modify the profile.xml file as necessary. See "XML Element Description" for a full description of the XML elements.

3. Save your changes and exit the text editor.

4. Reboot or start servers to have your changes take effect:

5. Test the updated system to validate the configuration.

XML Schema

The full schema for the profile.xml file is bundled within the profile-service-descriptor-binding.jar library, located in WL_home/sip/server/lib, where WL_home is the path to the directory where WebLogic Server is installed.

Example profile.xml File

See "Developing Custom Profile Providers" in the Converged Application Server Application Developer's Guide for examples of profile.xml configuration files.

XML Element Description

The following sections describe each XML element in profile.xml.

profile-service

The top level profile-service element contains the entire profile service configuration.

mapping

Specifies how requests for profile data are mapped to profile provider implementations.

map-by

Specifies the technique used for mapping documents to providers:

• router uses a custom router class, specified by map-by-router, to determine the provider.

• prefix uses the specified map-by-prefix entry to map documents to a provider.

• provider-name uses the specified name element in the provider entry to map documents to a provider.

map-by-prefix

Specifies the prefix used to map documents to profile providers when mapping by prefix.

map-by-router

Specifies the router class (implementing com.bea.wcp.profile.ProfileRouter) used to map documents to profile providers with router-based mapping.

provider

Configures the profile provider implementation and startup options.

name

Specifies a name for the provider configuration. The name element is also used for mapping documents to the provider if you specify the provider-name mapping technique.

provider-class

Specifies the profile provider class (implementing com.bea.wcp.profile.ProfileServiceSpi).

param

Uses the name and value elements to specify optional parameters to the provider implementation.