Package com.yubico.yubikit.piv

Enum PinPolicy

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PinPolicy>
    public enum PinPolicy
extends java.lang.Enum<PinPolicy>
    The PIN policy of a private key defines whether or not a PIN is required to use the key.

    Setting a PIN policy other than DEFAULT requires YubiKey 4 or later.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALWAYS
      The PIN must be verified each time the key is to be used, just prior to using it.
      DEFAULT
      The default behavior for the particular key slot is used.
      NEVER
      The PIN is never required for using the key.
      ONCE
      The PIN must be verified for the session, prior to using the key.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      int value  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static PinPolicy fromValue​(int value)
      Returns the PIN policy corresponding to the given PIV application constant.
      static PinPolicy valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PinPolicy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • DEFAULT

        public static final PinPolicy DEFAULT
        The default behavior for the particular key slot is used.

      • NEVER

        public static final PinPolicy NEVER
        The PIN is never required for using the key.

      • ONCE

        public static final PinPolicy ONCE
        The PIN must be verified for the session, prior to using the key.

      • ALWAYS

        public static final PinPolicy ALWAYS
        The PIN must be verified each time the key is to be used, just prior to using it.

    • Field Detail

      • value

        public final int value

    • Method Detail

      • values

        public static PinPolicy[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (PinPolicy c : PinPolicy.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static PinPolicy valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • fromValue

        public static PinPolicy fromValue​(int value)
        Returns the PIN policy corresponding to the given PIV application constant.