Package africa.absa.inception.security

Class UserDirectoryParameter

java.lang.Object
africa.absa.inception.security.UserDirectoryParameter
All Implemented Interfaces:
Serializable
public class UserDirectoryParameter extends Object implements Serializable
The UserDirectoryParameter class stores a parameter for a user directory as a name-value pair.
Author:
Marcus Portmann
See Also:

  • Constructor Details

    • UserDirectoryParameter

      public UserDirectoryParameter()
      Constructs a new UserDirectoryParameter.

    • UserDirectoryParameter

      public UserDirectoryParameter(String name, BigDecimal value)
      Constructs a new UserDirectoryParameter.
      Parameters:
      name - the name of the user directory parameter
      value - the BigDecimal value for the user directory parameter

    • UserDirectoryParameter

      public UserDirectoryParameter(String name, africa.absa.inception.core.util.BinaryBuffer value)
      Constructs a new UserDirectoryParameter.
      Parameters:
      name - the name of the user directory parameter
      value - the binary value for the user directory parameter

    • UserDirectoryParameter

      public UserDirectoryParameter(String name, byte[] value)
      Constructs a new UserDirectoryParameter.
      Parameters:
      name - the name of the user directory parameter
      value - the binary value for the user directory parameter

    • UserDirectoryParameter

      public UserDirectoryParameter(String name, double value)
      Constructs a new UserDirectoryParameter.
      Parameters:
      name - the name of the user directory parameter
      value - the double value for the user directory parameter

    • UserDirectoryParameter

      public UserDirectoryParameter(String name, long value)
      Constructs a new UserDirectoryParameter.
      Parameters:
      name - the name of the user directory parameter
      value - the long value for the user directory parameter

    • UserDirectoryParameter

      public UserDirectoryParameter(String name, String value)
      Constructs a new UserDirectoryParameter.
      Parameters:
      name - the name of the user directory parameter
      value - the String value for the user directory parameter

  • Method Details

    • contains

      public static boolean contains(List<UserDirectoryParameter> parameters, String name)
      Returns whether the list of user directory parameters contains a user directory parameter whose name matches the specified name.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      Returns:
      true if the list of user directory parameters contains a user directory parameter whose name matches the specified name or false otherwise

    • getBinaryValue

      public static byte[] getBinaryValue(List<UserDirectoryParameter> parameters, String name) throws UserDirectoryParameterException
      Returns the binary value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      Returns:
      the binary value for the user directory parameter with the specified name in the specified list
      Throws:
      UserDirectoryParameterException - if the binary value could not be retrieved for the user directory parameter

    • getBooleanValue

      public static boolean getBooleanValue(List<UserDirectoryParameter> parameters, String name) throws UserDirectoryParameterException
      Returns the boolean value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      Returns:
      the boolean value for the user directory parameter with the specified name in the specified list
      Throws:
      UserDirectoryParameterException - if the boolean value could not be retrieved for the user directory parameter

    • getDecimalValue

      public static BigDecimal getDecimalValue(List<UserDirectoryParameter> parameters, String name) throws UserDirectoryParameterException
      Returns the BigDecimal value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      Returns:
      the BigDecimal value for the user directory parameter with the specified name in the specified list
      Throws:
      UserDirectoryParameterException - if the decimal value could not be retrieved for the user directory parameter

    • getDoubleValue

      public static double getDoubleValue(List<UserDirectoryParameter> parameters, String name) throws UserDirectoryParameterException
      Returns the double value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      Returns:
      the double value for the user directory parameter with the specified name in the specified list
      Throws:
      UserDirectoryParameterException - if the double value could not be retrieved for the user directory parameter

    • getIntegerValue

      public static int getIntegerValue(List<UserDirectoryParameter> parameters, String name) throws UserDirectoryParameterException
      Returns the int value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      Returns:
      the int value for the user directory parameter with the specified name in the specified list
      Throws:
      UserDirectoryParameterException - if the integer value could not be retrieved for the user directory parameter

    • getLongValue

      public static long getLongValue(List<UserDirectoryParameter> parameters, String name) throws UserDirectoryParameterException
      Returns the long value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      Returns:
      the long value for the user directory parameter with the specified name in the specified list
      Throws:
      UserDirectoryParameterException - if the long value could not be retrieved for the user directory parameter

    • getStringValue

      public static String getStringValue(List<UserDirectoryParameter> parameters, String name) throws UserDirectoryParameterException
      Returns the String value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      Returns:
      the String value for the user directory parameter with the specified name in the specified list
      Throws:
      UserDirectoryParameterException - if the string value could not be retrieved for the user directory parameter

    • setBinaryValue

      public static void setBinaryValue(List<UserDirectoryParameter> parameters, String name, africa.absa.inception.core.util.BinaryBuffer value) throws UserDirectoryParameterException
      Set the binary value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      value - the binary value for the user directory parameter
      Throws:
      UserDirectoryParameterException - if the binary value could not be set for the user directory parameter

    • setBinaryValue

      public static void setBinaryValue(List<UserDirectoryParameter> parameters, String name, byte[] value) throws UserDirectoryParameterException
      Set the binary value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      value - the binary value for the user directory parameter
      Throws:
      UserDirectoryParameterException - if the binary value could not be set for the user directory parameter

    • setDecimalValue

      public static void setDecimalValue(List<UserDirectoryParameter> parameters, String name, BigDecimal value) throws UserDirectoryParameterException
      Set the BigDecimal value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      value - the BigDecimal value for the user directory parameter
      Throws:
      UserDirectoryParameterException - if the decimal value could not be set for the user directory parameter

    • setDoubleValue

      public static void setDoubleValue(List<UserDirectoryParameter> parameters, String name, double value) throws UserDirectoryParameterException
      Set the double value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      value - the double value for the user directory parameter
      Throws:
      UserDirectoryParameterException - if the double value could not be set for the user directory parameter

    • setIntegerValue

      public static void setIntegerValue(List<UserDirectoryParameter> parameters, String name, int value) throws UserDirectoryParameterException
      Set the int value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      value - the int value for the user directory parameter
      Throws:
      UserDirectoryParameterException - if the integer value could not be set for the user directory parameter

    • setLongValue

      public static void setLongValue(List<UserDirectoryParameter> parameters, String name, long value) throws UserDirectoryParameterException
      Set the long value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      value - the long value for the user directory parameter
      Throws:
      UserDirectoryParameterException - if the long value could not be set for the user directory parameter

    • setStringValue

      public static void setStringValue(List<UserDirectoryParameter> parameters, String name, String value) throws UserDirectoryParameterException
      Set the String value for the user directory parameter with the specified name in the specified list.
      Parameters:
      parameters - the user directory parameters to search
      name - the name of the user directory parameter to search for
      value - the String value for the user directory parameter
      Throws:
      UserDirectoryParameterException - if the string value could not be set for the user directory parameter

    • getBinaryValue

      public byte[] getBinaryValue() throws UserDirectoryParameterException
      Returns the binary value for the user directory parameter.
      Returns:
      the binary value for the user directory parameter
      Throws:
      UserDirectoryParameterException - if the binary value could not be retrieved for the user directory parameter

    • getDecimalValue

      public BigDecimal getDecimalValue() throws UserDirectoryParameterException
      Returns the BigDecimal value for the user directory parameter.
      Returns:
      the BigDecimal value for the user directory parameter
      Throws:
      UserDirectoryParameterException - if the decimal value could not be retrieved for the user directory parameter

    • getDoubleValue

      public double getDoubleValue() throws UserDirectoryParameterException
      Returns the double value for the user directory parameter.
      Returns:
      the double value for the user directory parameter
      Throws:
      UserDirectoryParameterException - if the double value could not be retrieved for the user directory parameter

    • getIntegerValue

      public int getIntegerValue() throws UserDirectoryParameterException
      Returns the int value for the user directory parameter.
      Returns:
      the int value for the user directory parameter
      Throws:
      UserDirectoryParameterException - if the integer value could not be retrieved for the user directory parameter

    • getLongValue

      public long getLongValue() throws UserDirectoryParameterException
      Returns the long value for the user directory parameter.
      Returns:
      the long value for the user directory parameter
      Throws:
      UserDirectoryParameterException - if the long value could not be retrieved for the user directory parameter

    • getName

      public String getName()
      Returns the name of the user directory parameter.
      Returns:
      the name of the user directory parameter

    • getStringValue

      public String getStringValue()
      Returns the String value for the user directory parameter.
      Returns:
      the String value for the user directory parameter

    • getValue

      public String getValue()
      Returns the String value for the user directory parameter.
      Returns:
      the String value for the user directory parameter

    • setBinaryValue

      public void setBinaryValue(africa.absa.inception.core.util.BinaryBuffer value)
      Set the binary value for the user directory parameter.
      Parameters:
      value - the binary value for the user directory parameter

    • setBinaryValue

      public void setBinaryValue(byte[] value)
      Set the binary value for the user directory parameter.
      Parameters:
      value - the binary value for the user directory parameter

    • setBooleanValue

      public void setBooleanValue(boolean value)
      Set the boolean value for the user directory parameter.
      Parameters:
      value - the boolean value for the user directory parameter

    • setDecimalValue

      public void setDecimalValue(BigDecimal value)
      Set the BigDecimal value for the user directory parameter.
      Parameters:
      value - the BigDecimal value for the user directory parameter

    • setDoubleValue

      public void setDoubleValue(double value)
      Set the double value for the user directory parameter.
      Parameters:
      value - the double value for the user directory parameter

    • setIntegerValue

      public void setIntegerValue(int value)
      Set the int value for the user directory parameter.
      Parameters:
      value - the int value for the user directory parameter

    • setLongValue

      public void setLongValue(long value)
      Set the long value for the user directory parameter.
      Parameters:
      value - the long value for the user directory parameter

    • setName

      public void setName(String name)
      Set the name of the user directory parameter.
      Parameters:
      name - the name of the user directory parameter

    • setStringValue

      public void setStringValue(String value)
      Set the String value for the user directory parameter.
      Parameters:
      value - the String value for the user directory parameter

    • setValue

      public void setValue(String value)
      Set the String value for the user directory parameter.
      Parameters:
      value - the String value for the user directory parameter