Package com.isode.dsapi.config

Enum Class PeerAuthMode

java.lang.Object
java.lang.Enum<PeerAuthMode>
com.isode.dsapi.config.PeerAuthMode
All Implemented Interfaces:
Serializable, Comparable<PeerAuthMode>, Constable
public enum PeerAuthMode extends Enum<PeerAuthMode>
Authentication types for peer authentication, as used in attributes such as isodeDISPAuthModeISend. Note that the values here correspond with those defined in ./apps/d3/peer/PAC.h. Note that the elements are declared in the ascending order of priority, i.e. None < Name < Simple < Simple Protected < Strong
Since:
15.0

  • Enum Constant Details

    • None

      public static final PeerAuthMode None
      Anonymous

    • Name

      public static final PeerAuthMode Name
      Name only

    • Simple

      public static final PeerAuthMode Simple
      Simple

    • SimpleProtected

      public static final PeerAuthMode SimpleProtected
      Simple protected

    • Strong

      public static final PeerAuthMode Strong
      Strong

  • Method Details

    • values

      public static PeerAuthMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PeerAuthMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getMode

      public static PeerAuthMode getMode(Integer mode)
      Convert integer to enum.
      Parameters:
      mode - integer indicating auth mode
      Returns:
      corresponding enum value, NONE if not valid

    • userFriendlyStr

      public String userFriendlyStr()
      Returns the user-friendly name stored for the enumeration.
      Returns:
      non-null friendly string for the enum

    • getDescription

      public String getDescription()
      Returns the description name stored for the enumeration.
      Returns:
      non-null description string for the enum

    • toString

      public String toString()
      Returns a String representation of the mode for this enum. If you want the String representation of the enum, then use getName()
      Overrides:
      toString in class Enum<PeerAuthMode>
      Returns:
      a String representation of mode

    • getName

      public String getName()
      Return the String form of this enum (e.g. "Name" or "None" etc.). This would normally be done by the "toString" method but that's been used for something else.
      Returns:
      a String representation of this enum.

    • isPasswordRequired

      public boolean isPasswordRequired()
      Determines if a password needs to be associated with the authentication mode.
      Returns:
      TRUE if password is required for this authentication mode, FALSE if not