Show TOC

 Creating the Configuration File for Login ModulesLocate this document in the navigation structure

Use

The system uses the LoginModuleConfiguration.xml file to automatically register a deployed login module in the user store of the AS Java.

To create this file you use the SAP NetWeaver Developer Studio.

Procedure
  1. From the menu path, choose File → New → Other.
  2. In the dialog that appears, choose XML → XML. Choose Next.
  3. Specify the location where you want to create the configuration file. Specify LoginModuleConfiguration.xml as the name of the file. Choose Finish.
    Caution

    The name of the file must be LoginModuleConfiguration.xml . Otherwise the system will not recognize the file.

  4. Open the configuration file. Delete any auto-generated content.
  5. Implement the code of the configuration file. The structure of the file is shown below:

XML Schema Description

Schema element / attribute Description

login-modules

This is the root element of the configuration file. It contains the descriptions of all login modules.

login-module

This element holds the description of one login module.

Caution

If you are deploying more than one login module in the same deployable archive, do not create different configuration files to describe each login module. Describe all login modules in one configuration file.

display-name

This element holds the display name of a login module. The display name must be unique in the user store and must not be the same as any class name on the AS Java.

Caution

If you are updating a previously deployed login module, do not change its display name.

class-name

This element holds the full class path of the login module.

description

This element holds the description of the login module.

options

This element holds all the options of the login module. If you do not want to define any options you can omit this element.

Caution

If you change the options when you are updating a login module, the new options you define will override the previously defined options in the user store of the AS Java.

The new options will be inherited by the policy configurations that use this login module.

option

This element holds the name and the value of one option.

name

This element holds the name of an option.

value

This element holds the value of an option.

  1. Save the file.
  2.