Package com.yubico.yubikit.piv

Enum TouchPolicy

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TouchPolicy>
    public enum TouchPolicy
extends java.lang.Enum<TouchPolicy>
    The touch policy of a private key defines whether or not a user presence check (physical touch) is required to use the key.

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

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALWAYS
      Touch is always required for using the key.
      CACHED
      Touch is required, but cached for 15s after use, allowing multiple uses.
      DEFAULT
      The default behavior for the particular key slot is used, which is always NEVER.
      NEVER
      Touch is never required for 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 TouchPolicy fromValue​(int value)
      Returns the touch policy corresponding to the given PIV application constant.
      static TouchPolicy valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TouchPolicy[] 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 TouchPolicy DEFAULT
        The default behavior for the particular key slot is used, which is always NEVER.

      • NEVER

        public static final TouchPolicy NEVER
        Touch is never required for using the key.

      • ALWAYS

        public static final TouchPolicy ALWAYS
        Touch is always required for using the key.

      • CACHED

        public static final TouchPolicy CACHED
        Touch is required, but cached for 15s after use, allowing multiple uses. This setting requires YubiKey 4.3 or later.

    • Field Detail

      • value

        public final int value

    • Method Detail

      • values

        public static TouchPolicy[] 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 (TouchPolicy c : TouchPolicy.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static TouchPolicy 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 TouchPolicy fromValue​(int value)
        Returns the touch policy corresponding to the given PIV application constant.