Package org.forgerock.openam.sm.annotations.subconfigs

Interface Multiple<T>

Type Parameters:

T - The type of the sub-configurations.

@Supported
public interface Multiple<T>

An object that gives access to multiple sub-configurations from an annotated service.

See Also:

• SubConfig

Method Summary

Modifier and Type	Method	Description
void	add(String name, T config)	Add the instance of sub-configuration provided.
T	defaults()	Gets the default attribute values for this configuration.
void	delete(String name)	Delete the instance of sub-configuration identified by the provided name, if it exists.
T	get(String name)	Get the instance of sub-configuration identified by the provided name.
default Set<T>	get(QueryFilter<String> queryFilter)	Gets all instances of sub-configuration which match the provided query filter.
Set<T>	get(QueryFilter<String> queryFilter, boolean allowWildcards)	Gets all instances of sub-configuration which match the provided query filter.
default Set<String>	idSet()	Deprecated. use nameSet() instead.
Set<String>	nameSet()	Get the set of names for instances that currently exist.
static <T> Multiple<T>	of(Map<String,T> config)	Creates a Multiple which can be used in ServiceComponent to build nested default SubConfigs easier.
void	update(String name, T config)	Update the values for the configuration identified by the provided name.

Method Details

of

@Supported
static <T> Multiple<T> of(Map<String,T> config)

Creates a Multiple which can be used in ServiceComponent to build nested default SubConfigs easier. Can only be used for SubConfigs inside of another SubConfig.

Parameters:

config - A map representing the instance values.

Returns:

The non-persistent instances.

get

@Supported
T get(String name)
throws SMSException,
SSOException

Get the instance of sub-configuration identified by the provided name.

Parameters:

name - The name of the configuration.

Returns:

The configuration instance, or null if none exists for the identifier.

Throws:

SMSException - From the downstream SMS API.

SSOException - From the downstream SMS API.

get

@Supported
default Set<T> get(QueryFilter<String> queryFilter)
            throws SMSException,
SSOException

Gets all instances of sub-configuration which match the provided query filter.

Parameters:

queryFilter - The filter to use for matching.

Returns:

The configuration instances.

Throws:

SMSException - From the downstream SMS API.

SSOException - From the downstream SMS API.

get

@Supported
Set<T> get(QueryFilter<String> queryFilter,
 boolean allowWildcards)
    throws SMSException,
SSOException

Gets all instances of sub-configuration which match the provided query filter.

Parameters:

queryFilter - The filter to use for matching.

allowWildcards - Whether to allow wildcard characters in the query filter. If false, wildcard characters will be treated as literal characters.

Returns:

The configuration instances.

Throws:

SMSException - From the downstream SMS API.

SSOException - From the downstream SMS API.

delete

@Supported
void delete(String name)
     throws SMSException,
SSOException

Delete the instance of sub-configuration identified by the provided name, if it exists.

Parameters:

name - The name of the configuration.

Throws:

SMSException - From the downstream SMS API.

SSOException - From the downstream SMS API.

nameSet

@Supported
Set<String> nameSet()
             throws SMSException,
SSOException

Get the set of names for instances that currently exist.

Returns:

The names

Throws:

SMSException - From the downstream SMS API.

SSOException - From the downstream SMS API.

idSet

@Supported
@Deprecated(since="8.1.0")
default Set<String> idSet()
                   throws SMSException,
SSOException

Deprecated.

use nameSet() instead.

Get the set of IDs for instances that currently exist.

Returns:

The IDs

Throws:

SMSException - From the downstream SMS API.

SSOException - From the downstream SMS API.

add

@Supported
void add(String name,
 T config)
  throws SMSException,
SSOException

Add the instance of sub-configuration provided.

Parameters:

name - The name of the configuration.

config - The configuration values.

Throws:

SMSException - From the downstream SMS API.

SSOException - From the downstream SMS API.

IllegalArgumentException - If the name is already in use.

update

@Supported
void update(String name,
 T config)
     throws SMSException,
SSOException

Update the values for the configuration identified by the provided name.

Parameters:

name - The name.

config - The instance values.

Throws:

SMSException - From the downstream SMS API.

SSOException - From the downstream SMS API.

IllegalArgumentException - If the name does not have an existing instance.

defaults

@Supported
T defaults()
    throws SMSException,
SSOException

Gets the default attribute values for this configuration.

Returns:

The default attribute values.

Throws:

SMSException - From the downstream SMS API.

SSOException - From the downstream SMS API.