Troubleshoot node development
This page offers solutions to issues that may occur when developing authentication nodes.
I installed my node in AM. Why doesn’t it appear in the authentication tree designer?
authNodeName.propertiesfile for your node must include a
nodeDescriptionproperty to ensure that that your node appears in the authentication tree designer.
AM uses the
nodeDescriptionproperty value as the name of your node.
How do I get new attributes to appear in the node after the service has been loaded once?
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.
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
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.
Transient State vs Shared State - When should I use one or the other?
Transient state is used for secret values that should not persist.
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?
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.