Package org.apache.zookeeper.common
Enum KeyStoreFileType
- java.lang.Object
-
- java.lang.Enum<KeyStoreFileType>
-
- org.apache.zookeeper.common.KeyStoreFileType
-
- All Implemented Interfaces:
Serializable,Comparable<KeyStoreFileType>
public enum KeyStoreFileType extends Enum<KeyStoreFileType>
This enum represents the file type of a KeyStore or TrustStore. Currently, JKS (Java keystore), PEM, PKCS12, and BCFKS types are supported.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static KeyStoreFileTypefromFilename(String filename)Detects the type of KeyStore / TrustStore file from the file extension.static KeyStoreFileTypefromPropertyValue(String propertyValue)Converts a property value to a StoreFileType enum.static KeyStoreFileTypefromPropertyValueOrFileName(String propertyValue, String filename)IfpropertyValueis not null or empty, returns the result ofKeyStoreFileType.fromPropertyValue(propertyValue).StringgetDefaultFileExtension()The file extension that is associated with this file type.StringgetPropertyValue()The property string that specifies that a key store or trust store should use this store file type.static KeyStoreFileTypevalueOf(String name)Returns the enum constant of this type with the specified name.static KeyStoreFileType[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
JKS
public static final KeyStoreFileType JKS
-
PEM
public static final KeyStoreFileType PEM
-
PKCS12
public static final KeyStoreFileType PKCS12
-
BCFKS
public static final KeyStoreFileType BCFKS
-
-
Method Detail
-
values
public static KeyStoreFileType[] 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 (KeyStoreFileType c : KeyStoreFileType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static KeyStoreFileType valueOf(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:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
getPropertyValue
public String getPropertyValue()
The property string that specifies that a key store or trust store should use this store file type.
-
getDefaultFileExtension
public String getDefaultFileExtension()
The file extension that is associated with this file type.
-
fromPropertyValue
public static KeyStoreFileType fromPropertyValue(String propertyValue)
Converts a property value to a StoreFileType enum. If the property value isnullor an empty string, returnsnull.- Parameters:
propertyValue- the property value.- Returns:
- the KeyStoreFileType, or
nullifpropertyValueisnullor empty. - Throws:
IllegalArgumentException- ifpropertyValueis not one of "JKS", "PEM", "BCFKS", "PKCS12", or empty/null.
-
fromFilename
public static KeyStoreFileType fromFilename(String filename)
Detects the type of KeyStore / TrustStore file from the file extension. If the file name ends with ".jks", returnsStoreFileType.JKS. If the file name ends with ".pem", returnsStoreFileType.PEM. If the file name ends with ".p12", returnsStoreFileType.PKCS12. If the file name ends with ".bckfs", returnsStoreFileType.BCKFS. Otherwise, throws an IllegalArgumentException.- Parameters:
filename- the filename of the key store or trust store file.- Returns:
- a KeyStoreFileType.
- Throws:
IllegalArgumentException- if the filename does not end with ".jks", ".pem", "p12" or "bcfks".
-
fromPropertyValueOrFileName
public static KeyStoreFileType fromPropertyValueOrFileName(String propertyValue, String filename)
IfpropertyValueis not null or empty, returns the result ofKeyStoreFileType.fromPropertyValue(propertyValue). Else, returns the result ofKeyStoreFileType.fromFileName(filename).- Parameters:
propertyValue- property value describing the KeyStoreFileType, or null/empty to auto-detect the type from the file name.filename- file name of the key store file. The file extension is used to auto-detect the KeyStoreFileType whenpropertyValueis null or empty.- Returns:
- a KeyStoreFileType.
- Throws:
IllegalArgumentException- ifpropertyValueis not one of "JKS", "PEM", "PKCS12", "BCFKS", or empty/null.IllegalArgumentException- ifpropertyValueis empty or null and the type could not be determined from the file name.
-
-