Authentication Application Success Plug-ins

About the Authentication Application Success Callout Handler

The Authentication Application is one of (if not the most) integral part of DirX Access. As it represents the user interface and provides the user experience, it is expected to be customized not only when it comes to styling, but also with different screen flows. The customizations represent one of the major blockers for a smooth and fast migration process.

The Authentication Application Success callout provides the extension point for any customization operating with the successful authentication. E.g., printing different screens based on request injection parameters (such as having the prompt for password reset before the actual password expiration).

For the exact way of how to implement custom Authentication Application Success Callout Handler to provide intended functionality, please, see the JavaDoc of the interface.

Developing an Authentication Application Success Callout Handler

This section describes the tasks necessary for developing a custom Authentication Application success callout handler.

Externalizing Authentication Application Success flow from the DirX Access Server

The DirX Access Server allows externalizing Authentication Application Success flow through a plug-in interface. This method requires creating an Authentication Application Success callout handler that implements the AuthnAppSuccessCallout interface (com.siemens.dxa.applications.web.authn.api.callout.AuthnAppSuccessCallout). The implementing class must be contained within an exported package of an OSGi bundle.

Employing an Authentication Application Success Callout Handler

The steps needed to employ the custom callout handler are outlined in the section Employing External Plug-in Modules.

Using an Authentication Application Success Callout Handler

This section describes the tasks that need to be performed to use an Authentication Application callout handler. Before starting to configure the DirX Access Server, make sure to run through all the steps in the section Employing External Plug-in Modules.

Prerequisites

To successfully employ the custom Authentication Application Success callout handler, the OSGi bundle exporting the package containing the callout implementation must be installed on the DirX Access Server. To accomplish this task, make sure you have performed all of the steps described in the section Employing External Plug-in Modules.

Configuring the Custom Authentication Application Success Callout Handler at the DirX Access Server

To configure the custom Authentication Application Success callout handler at the DirX Access Server:

  • In DirX Access Manager, go to Configuration | Extension modules.

  • Create the callout handler <CalloutIdentifier>:

    • Go to Callout handlers and click the “add” icon to create a new callout handler.

    • Identifier: <CalloutIdentifier>.

    • Description: arbitrary.

    • Type: select AuthnAppSuccessEvents.

    • Class name: enter the fully-qualified Java class name of the callout implementation.

    • Click Save.

  • In DirX Access Manager, go to Authentication | Applications:

    • Select an Authentication Application to which the custom handler should be assigned.

    • In the Authentication Application Success Callout handler identifier drop-down box, select the desired <CalloutIdentifier>.

    • Click Save.