SubConfig (OpenAM Server Only 7.0.2 Documentation)

```
@SupportedAll
@Retention(RUNTIME)
@Target(METHOD)
public @interface SubConfig
```
Indicates that a method contains rich sub-configuration(s) of the parent configuration (or sub-configuration).
The return type of the method must either be a org.forgerock.openam.sm.annotations.subconfigs.Singleton of the type (which is an interface) for a singleton sub-configuration, or a org.forgerock.openam.sm.annotations.subconfigs.Multiple of the type in the case of a collection.

As with Config the annotated methods of the interface are used to make the schema of the configuration. As such, all methods must be annotated with Attribute, Id or SubConfig, or have a default implementation.

The annotated method MUST NOT have any parameters.

See Also:

Config

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element	Description
`String`	`descriptionKey`	The key for the service description in the i18n bundle - defaults to `[sub-configuration name].description`.
`boolean`	`hiddenFromConfigUi`	Whether the config service should be hidden from the config UI.
`String`	`name`	The name of the sub-configuration - defaults to the name of the annotated method.
`String`	`resourceName`	The resource name of the sub configuration - defaults to the name of sub-configuration.
`Class<?>`	`validator`	A validator to apply to the entire configuration object.

- Element Detail
  - name
```
String name
```
    The name of the sub-configuration - defaults to the name of the annotated method.
    
    Returns:
    
    The override name.
    
    Default:
    
    ""
- - resourceName
```
String resourceName
```
    The resource name of the sub configuration - defaults to the name of sub-configuration.
    
    Returns:
    
    The override resource name.
    
    Default:
    
    ""
- - descriptionKey
```
String descriptionKey
```
    The key for the service description in the i18n bundle - defaults to [sub-configuration name].description.
    
    Returns:
    
    the i18n description key.
    
    Default:
    
    ""
- - validator
```
Class<?> validator
```
    A validator to apply to the entire configuration object.
    If set, the value must be a class implementing the ServiceConfigValidator interface.
    
    Returns:
    
    the validator class.
    
    Default:
    
    java.lang.Void.class
- - hiddenFromConfigUi
```
boolean hiddenFromConfigUi
```
    Whether the config service should be hidden from the config UI. Defaults to false.
    
    Returns:
    
    true if the service should be hidden.
    
    Default:
    
    false