Interface IStringAttributesMixin

All Known Subinterfaces:
IAuthenticatorConfig, IAuthenticatorConfigWrapper
All Known Implementing Classes:
AAuthenticatorConfig, AConfigViewModel, AnonymousConfigViewModel, AnonymousConfigWrapper, AnyoneConfigWrapper, BaseConfigViewModel, DistinctUserConfigWrapper, EntityConfigWrapper, FormConfigWrapper, GeneratedPasswordConfigViewModel, GeneratedPasswordConfigWrapper, KerberosConfigWrapper, NtlmConfigWrapper, PasswordConfigViewModel, PasswordConfigWrapper, ProjectAuthenticatorConfig, UserPortalAuthConfig, VirtualAuthenticatorConfig, WorkflowStateAuthenticatorConfig
public interface IStringAttributesMixin
Mixin providing utility methods for storing values in a string map
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getAttributes

      Map<String,String> getAttributes()
      Returns:
      the string attributes

    • getAttributeValue

      default String getAttributeValue(String key)
      Get the String value of the attribute with the given key
      Parameters:
      key - String attribute name
      Returns:
      String value of the requested attribute

    • getAttributeValueList

      default List<String> getAttributeValueList(String key)
      Get the List value of the attribute with the given key
      Parameters:
      key - String attribute name
      Returns:
      List value of the requested attribute or null if the attribute does not exist or can't be parsed to a list.

    • getAttributeValueMap

      default Map<String,String> getAttributeValueMap(String key)
      Get the Map value of the attribute with the given key
      Parameters:
      key - String attribute name
      Returns:
      Map value of the requested attribute or null if the attribute does not exist or can't be parsed to a map.

    • putAttribute

      default void putAttribute(String key, String value)
      Puts the given String value for the given key in the attribute map. If the value is empty then the key will be removed from the map
      Parameters:
      key - String attribute name
      value - String value of the attribute

    • putAttributes

      default void putAttributes(String key, List<String> values)
      Puts the given List value for the given key in the attribute map. If the value is empty then the key will be removed from the map
      Parameters:
      key - String attribute name
      values - List value of the attribute

    • putAttributes

      default void putAttributes(String key, Map<String,String> valueMap)
      Puts the given Map value for the given key in the attribute map. If the value is empty then the key will be removed from the map
      Parameters:
      key - String attribute name
      valueMap - Map value of the attribute

    • removeAttribute

      default String removeAttribute(String key)
      Removes the attributes for the given key
      Parameters:
      key - String key in the attribute map
      Returns:
      true if the attribute was removed