com.hidglobal.ia.service.transaction

Interface Key

public interface Key

Method Summary

Modifier and Type	Method and Description
String	getAlgorithm() Gets the standard algorithm name for the key.
OTPGenerator	getDefaultOTPGenerator() Returns property for that key.
byte[]	getEncoded() Gets the key in its primary encoding format.
byte[]	getEncoded(char[] password) Gets the key in its primary encoding format.
String	getFormat() Gets the name of the primary encoding format of this key.
KeyId	getId() Gets the keyId associated with key.
OTPGenerator	getOTPGenerator(String name) Returns the OTP generator with specified name associated with a key.
String[]	getOTPGeneratorNames() Returns the list of supported OTP generators associated with the key.
char[]	getProperty(String attribute) Returns property for that key.
ProtectionPolicy	getProtectionPolicy() Gets the protection policy associated with key.
boolean	isExtractable() Returns true when the key is extractable.

Method Detail

getId

KeyId getId()

Gets the keyId associated with key.

Returns:

the keyId, null if not set.

getProtectionPolicy

ProtectionPolicy getProtectionPolicy()
                              throws InternalException

Gets the protection policy associated with key.

Returns:

The ProtectionPolicy used to protect the key.

Throws:

InternalException - if an unexpected error occurred.

getProperty

char[] getProperty(String attribute)
            throws LostCredentialsException

Returns property for that key.

Parameters:

attribute - attribute name The property name may be any of the following: KEY_PROPERTY_USAGE KEY_PROPERTY_LABEL KEY_PROPERTY_CREATE KEY_PROPERTY_EXPIRY

Returns:

The key property value.

Throws:

LostCredentialsException - if provisioning key data has been corrupted or lost.

getDefaultOTPGenerator

OTPGenerator getDefaultOTPGenerator()
                             throws InternalException

Returns property for that key.

Returns:

The key property value.

Throws:

InternalException - if an unexpected error occurred.

getOTPGenerator

OTPGenerator getOTPGenerator(String name)
                      throws NotImplementedException

Returns the OTP generator with specified name associated with a key.

Parameters:

name - one of OTP generators names see getOTPGeneratorNames().

Returns:

The OTP generator.

Throws:

NotImplementedException - if the operation is not implemented and reserved for future use.

getOTPGeneratorNames

String[] getOTPGeneratorNames()
                       throws NotImplementedException

Returns the list of supported OTP generators associated with the key.

Returns:

The list of OTP generators.

Throws:

NotImplementedException - if the operation is not implemented and reserved for future use.

isExtractable

boolean isExtractable()
               throws LostCredentialsException,
                      InternalException,
                      UnsupportedDeviceException

Returns true when the key is extractable.

Returns:

true or false depending on whether the key is extractable or not.

Throws:

LostCredentialsException - if provisioning key data has been corrupted or lost.

InternalException - if an unexpected error occurred.

UnsupportedDeviceException - if device is not supported by policy.

getAlgorithm

String getAlgorithm()
             throws InternalException,
                    UnsupportedDeviceException,
                    LostCredentialsException

Gets the standard algorithm name for the key.

Returns:

The algorithm name.

Throws:

InternalException - if an unexpected error occurred.

UnsupportedDeviceException - if device is not supported by policy.

LostCredentialsException - if provisioning key data has been corrupted or lost.

getFormat

String getFormat()
          throws InternalException,
                 UnsupportedDeviceException,
                 LostCredentialsException

Gets the name of the primary encoding format of this key.

Returns:

The encoding format name.

Throws:

InternalException - if an unexpected error occurred.

UnsupportedDeviceException - if device is not supported by policy.

LostCredentialsException - if provisioning key data has been corrupted or lost.

getEncoded

byte[] getEncoded()
           throws UnsupportedDeviceException,
                  AuthenticationException,
                  InvalidPasswordException,
                  LostCredentialsException,
                  InternalException,
                  FingerprintAuthenticationRequiredException,
                  FingerprintNotEnrolledException

Gets the key in its primary encoding format.

Returns:

the encoded key, or null if the key does not support encoding.

Throws:

UnsupportedDeviceException - if device is not supported by policy.

AuthenticationException - if password is incorrect.

InvalidPasswordException - if password validation fails.

LostCredentialsException - if provisioning key data has been corrupted or lost.

InternalException - if an unexpected error occurred.

FingerprintAuthenticationRequiredException - if fingerprint authentication is required by policy.

FingerprintNotEnrolledException - if fingerprint enrollment is required.

getEncoded

byte[] getEncoded(char[] password)
           throws UnsupportedDeviceException,
                  AuthenticationException,
                  InvalidPasswordException,
                  LostCredentialsException,
                  InternalException,
                  FingerprintAuthenticationRequiredException,
                  FingerprintNotEnrolledException,
                  PasswordRequiredException

Gets the key in its primary encoding format.

Parameters:

password - the key password.

Returns:

The key in its primary encoding format.

Throws:

UnsupportedDeviceException - if device is not supported by policy.

AuthenticationException - if password is incorrect.

InvalidPasswordException - if password validation fails.

LostCredentialsException - if provisioning key data has been corrupted or lost.

InternalException - if an unexpected error occurred.

FingerprintAuthenticationRequiredException - if fingerprint authentication is required by policy.

FingerprintNotEnrolledException - if fingerprint enrollment is required.

PasswordRequiredException - if required password was not provided and cached password is not available.