org.forgerock.openam.secrets

Class SecretIdChoiceValues

java.lang.Object

com.sun.identity.sm.ChoiceValues

org.forgerock.openam.secrets.SecretIdChoiceValues

public class SecretIdChoiceValues
extends ChoiceValues

A ChoiceValues implementation that fetches the names of all known purposes.

Since:

AM 6.5.0

Warning: Evolving API

This type (including all methods, constructors and fields) is continuing to evolve and so should be expected to change, potentially in backwards-incompatible ways even in a minor release. Changes are documented at the time of product release.

Constructor Summary

Constructors

Constructor and Description
SecretIdChoiceValues(SecretIdRegistry secretIdRegistry)

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getChoiceValues() Abstract method that must be implemented by a class extending this class, and should return the choice values and their corresponding I18N key, for the attribute.
Map<String,String>	getChoiceValues(Map envParams) Returns the choice values for attribute for the given environment parameters.

Methods inherited from class com.sun.identity.sm.ChoiceValues

getAttributeName, getAttributeSchemaNode, getConfiguredKeyValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecretIdChoiceValues

@Inject
public SecretIdChoiceValues(SecretIdRegistry secretIdRegistry)

Method Detail

getChoiceValues

public Map<String,String> getChoiceValues()

Description copied from class: ChoiceValues

Abstract method that must be implemented by a class extending this class, and should return the choice values and their corresponding I18N key, for the attribute.

Specified by:

getChoiceValues in class ChoiceValues

Returns:

choice values for the attribute as a java.util.Map. Key being the choice and the value being the I18N key

getChoiceValues

public Map<String,String> getChoiceValues(Map envParams)

Description copied from class: ChoiceValues

Returns the choice values for attribute for the given environment parameters. The default implementation calls the interface getChoiceValues without the parameter. A class extending this class can override this method to return the choice values and their corresponding I18N key, for the attribute.

Overrides:

getChoiceValues in class ChoiceValues

Parameters:

envParams - environment parameters

Returns:

choice values for the attribute as a java.util.Map. Key being the choice and the value being the I18N key