Package com.isode.dsapi

Class SASLParameters.SSF

  • Enclosing class:
    SASLParameters
    public static class SASLParameters.SSF
extends java.lang.Object
    A convenience class for managing a min/max SSF (Security Strength Factor) pair.
    Author:
    nh

    • Constructor Summary

      Constructors 
      Constructor Description
      SSF​(int min, int max)
      Construct a new object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)  
      int getMax()
      Returns max value in this object.
      int getMin()
      Returns min value in this object.
      int hashCode()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • SSF

        public SSF​(int min,
           int max)
    throws java.lang.IllegalArgumentException
        Construct a new object.

        The min and max parameters contain minimal and maximal SSF values. Each should be an integer in the range 0-256 that may be used to specify the desired approximate security layer strength. Values roughly correspond to the effective key length for encryption, where

        • 0 means no protection
        • 1 means integrity protection only
        • >1 means key length of the cipher.
        Note that the actual SSF value used at bind time may be constrained by the type of license installed on the system; for a system without a full HGE license, certain SSF values may disallowed.

        A value of -1 for either parameter means "do not specify a value".

        The constant SASLParameters.BEST_SSF may be used to request the "best available" security strength factor.

        Parameters:
        min - minimum desired SSF. A value of -1 means "do not specify a minimum value"
        max - maximum desired SSF. A value of -1 means "do not specify a maximum value"
        Throws:
        java.lang.IllegalArgumentException - if
        • min or max is less than -1, or greater than SASLParameters.BEST_SSF
        • min and max are positive and min is greater than max

    • Method Detail

      • getMin

        public int getMin()
        Returns min value in this object.
        Returns:
        min value

      • getMax

        public int getMax()
        Returns max value in this object.
        Returns:
        max value

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object