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?
The
authNodeName.properties
file for your node must include anodeDescription
property for your node to appear in the authentication tree designer.AM uses the
nodeDescription
property 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?
Learn more in Upgrade nodes and change node configuration.
-
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.
Learn more in Handle errors.
-
Do I need multiple projects/jars for multiple nodes?
No — you can bundle multiple nodes into one plugin and deploy that plugin in a single
.jar
file.Learn more in Build and install nodes.
-
What 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.
Learn more in the AM Public API Javadoc.
-
Transient state vs shared state — when should I use one or the other?
Use transient state for secret values that should not persist.
Learn more in Store values in shared tree state.
-
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?
Learn more in Access an identity’s profile.
-
Where do I go for examples of authentication nodes?
There are many public examples of community nodes at https://github.com/ForgeRock.
Find sample community nodes written by third parties in the Marketplace website.
For source access to the authentication nodes included with AM, read How do I access and build the sample code provided for PingAM?.