Access Management 7.3.1

Troubleshoot node development

This page offers solutions to issues that may occur when developing authentication nodes.

  1. I installed my node in AM. Why doesn’t it appear in the authentication tree designer?

    The authNodeName.properties file for your node must include a nodeDescription property to ensure that that your node appears in the authentication tree designer.

    AM uses the nodeDescription property value as the name of your node.

  2. How do I get new attributes to appear in the node after the service has been loaded once?

    See Upgrade nodes and change node configuration.

  3. What type of exception should I throw so that the framework handles it gracefully?

    To display a custom message to the user, exceptions must be handled inside the node and an appropriate information callback returned.

    For more information, see Handle errors.

  4. Do I need multiple projects/jars for multiple nodes?

    No - you can bundle multiple nodes into one plugin, which should be deployed in one single .jar file.

    See Build and install nodes.

  5. What ForgeRock utilities exist for me to use to assist in the node building experience?

    A number of utilities are available for use in your integrations and custom nodes.

    See the AM Public API Javadoc.

  6. Transient State vs Shared State - When should I use one or the other?

    Transient state is used for secret values that should not persist.

    See Store values in shared tree state.

  7. If my service collects a username in a different way from the Username Collector node, where do I put the username from the framework to get the principal?

    See Access an identity’s profile.

  8. Where do I go for examples of authentication nodes?

    There are many public examples of ForgeRock community nodes at https://github.com/ForgeRock.

    Examples of community nodes written by third parties may be found on the ForgeRock Marketplace.

    For source access to the authentication nodes builtin to AM, see How do I access and build the sample code provided for AM/OpenAM (All versions)? in the ForgeRock Knowledge Base.