Package org.apache.hadoop.fs.s3a

Enum Class S3AEncryptionMethods

java.lang.Object
java.lang.Enum<S3AEncryptionMethods>
org.apache.hadoop.fs.s3a.S3AEncryptionMethods
All Implemented Interfaces:
Serializable, Comparable<S3AEncryptionMethods>, Constable
public enum S3AEncryptionMethods extends Enum<S3AEncryptionMethods>
This enum is to centralize the encryption methods and the value required in the configuration.

  • Enum Constant Details

  • Field Details

  • Method Details

    • values

      public static S3AEncryptionMethods[] 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 S3AEncryptionMethods 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

    • getMethod

      public String getMethod()

    • isServerSide

      public boolean isServerSide()
      Flag to indicate this is a server-side encryption option.
      Returns:
      true if this is server side.

    • requiresSecret

      public boolean requiresSecret()
      Does this encryption algorithm require a secret?
      Returns:
      true if a secret must be retrieved.

    • getMethod

      public static S3AEncryptionMethods getMethod(String name) throws IOException
      Get the encryption mechanism from the value provided.
      Parameters:
      name - algorithm name
      Returns:
      the method
      Throws:
      IOException - if the algorithm is unknown