Package org.forgerock.openam.auth.node.api

Annotation Type Node.Metadata

@Retention(RUNTIME)
@Target(TYPE)
public static @interface Node.Metadata

Annotation that describes the metadata of the node.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
Class<?>	configClass	An interface describing the configuration of the node.
Class<? extends OutcomeProvider>	outcomeProvider	A provider for the possible outcomes of the node.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<?>	configValidator	A validator for the entire service configuration.
Class<?>	extensions	A class that will be serialised to JSON that a node can specify to return additional "metadata" to the client for presenting the node.
org.forgerock.openam.auth.node.api.Namespace	namespace	Prepended to a node's name to differentiate it from other nodes with the same name.
String[]	tags	A list of tags, which can be categories, keywords or synonyms.

Element Detail

outcomeProvider

Class<? extends OutcomeProvider> outcomeProvider

A provider for the possible outcomes of the node.

Returns:

the outcome provider.

configClass

Class<?> configClass

An interface describing the configuration of the node. The interface should contain methods annotated with Attribute.

Returns:

The config class.

configValidator

Class<?> configValidator

A validator for the entire service configuration.

Returns:

The config validator class.

Default:

java.lang.Void.class

tags

String[] tags

A list of tags, which can be categories, keywords or synonyms.

Returns:

The list of tags.

Default:

{}

namespace

org.forgerock.openam.auth.node.api.Namespace namespace

Prepended to a node's name to differentiate it from other nodes with the same name. This was introduced to allow integration of Marketplace nodes into the core AM product with backwards compatibility.

Returns:

The state namespace.

Default:

org.forgerock.openam.auth.node.api.Namespace.NONE

extensions

Class<?> extensions

A class that will be serialised to JSON that a node can specify to return additional "metadata" to the client for presenting the node.

For example "provider" metadata attribute for a set of nodes written by the same external provider.

Jackson is used to serialise the class instance to JSON.

Returns:

The extensions.

Default:

java.lang.Void.class