Creating user exits

To create user exits, you must develop OSGi bundles with the provided user exit APIs.

Before you begin

You must be an experienced programmer in Java™, Open Services Gateway Initiative (OSGi) services, and OSGi bundles. User exits require at least one of the available public user exit Java APIs exported as an OSGi service in your OSGi bundle. User exits can be developed to provide external operational actions in the message process flow for authentication, authorization, virus checking, file validation, audit logging, and usage logging.

About this task

To create user exit OSGi bundles:

Procedure

  1. Locate the Members\resources\userexits installation directory.
  2. Set up your development environment.
    1. Download the user exit API JAR file from the Members\resources\userexits installation directory.
    2. Verify that your integrated development environment (IDE) is configured for OSGi development.
    3. Optional: Download the latest Eclipse IDE and either Equinox SDK or Apache Aries: Maven Plug-in.
    4. Optional: Download the latest WebSphere Application Server V7 Feature pack for OSGi Applications and JPA 2.0.
    5. Modify your /META-INF/MANIFEST.MF file to match your implementation.
    6. Optional: For Maven plug-in implementations, modify your /META-INF/pom.xml and META-INF/pom.properties files to match your implementation.
    7. Optional: For Blueprint Container implementations, modify your /OSGI-INF/blueprint.xml file to match your implementation.
  3. Implement the appropriate user exit API.
    PreProcessUserExitHandler
    The PreProcessUserExitHandler is used in the receiver process flow before a message enters the receiver process flow.
    PostProcessUserExitHandler
    The PostProcessUserExitHandler is used in the receiver process flow after a message exits the receiver process flow.
    PreDeliveryUserExitHandler
    The PreDeliveryUserExitHandler is used in the destination process flow before a message enters the destination process flow.
    PostDeliveryUserExitHandler
    The PostDeliveryUserExitHandler is used in the destination process flow after a message exits the destination process flow.
    BusinessDocument
    The BusinessDocument is used to handle the message, payload, attachments, transport headers, and message properties in the process flow.
    AuthenticationUserExitHandler
    The AuthenticationUserExitHandler is used to handle authentication for embedded (full) X.509 certificate, SAML token, or user name token during the inbound and outbound authentication process flow.
  4. Debug your OSGi standard components in your local IDE.
    Restriction: The user exit OSGi services that you develop cannot be tested in your local environment, you must deploy the user exit OSGi services on the system for testing.
  5. Assemble your user exit OSGi services bundle and prepare your userexit_bundle-SymbolicName.jar OSGi bundle for deployment on the system.
    Remember: There can be more than one OSGi service in your OSGi bundle.

What to do next

You can now deploy your user exit OSGi services as an OSGi bundle with the available commands.