com.hidglobal.ia.service.transaction.Key Interface Reference

Key instance More...

Public Member Functions
String	getAlgorithm () throws InternalException, UnsupportedDeviceException, LostCredentialsException
OTPGenerator	getDefaultOTPGenerator () throws InternalException
byte []	getEncoded () throws UnsupportedDeviceException, LostCredentialsException, InternalException
byte []	getEncoded (char[] password) throws UnsupportedDeviceException, AuthenticationException, LostCredentialsException, InternalException, FingerprintAuthenticationRequiredException, FingerprintNotEnrolledException, PasswordRequiredException, PasswordExpiredException
String	getFormat () throws InternalException, UnsupportedDeviceException, LostCredentialsException
KeyId	getId ()
OTPGenerator	getOTPGenerator (String name) throws NotImplementedException
String []	getOTPGeneratorNames () throws NotImplementedException
char []	getProperty (String attribute) throws LostCredentialsException, InvalidParameterException, InternalException
ProtectionPolicy	getProtectionPolicy () throws InternalException
boolean	isExtractable () throws LostCredentialsException, InternalException, UnsupportedDeviceException

Detailed Description

Key instance

Key instance.

Member Function Documentation

getAlgorithm()

String com.hidglobal.ia.service.transaction.Key.getAlgorithm

(

)

throws InternalException, UnsupportedDeviceException, LostCredentialsException

Gets the standard algorithm name for the key.

Returns

The algorithm name.

Exceptions

InternalException	if an unexpected error occurred.
UnsupportedDeviceException	if device is not supported by policy.
LostCredentialsException	if provisioning key data has been corrupted or lost.

getDefaultOTPGenerator()

OTPGenerator com.hidglobal.ia.service.transaction.Key.getDefaultOTPGenerator

(

)

throws InternalException

Returns the OTP generator for the associated with the key.

Returns

The key property value.

Exceptions

InternalException

if an unexpected error occurred.

getEncoded() [1/2]

byte [] com.hidglobal.ia.service.transaction.Key.getEncoded

(

)

throws UnsupportedDeviceException, LostCredentialsException, InternalException

Gets the key in its primary encoding format.

Returns

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

Exceptions

UnsupportedDeviceException	if device is not supported by policy.
LostCredentialsException	if provisioning key data has been corrupted or lost.
InternalException	if an unexpected error occurred.

getEncoded() [2/2]

byte [] com.hidglobal.ia.service.transaction.Key.getEncoded

(

char []

password

)

throws UnsupportedDeviceException, AuthenticationException, LostCredentialsException, InternalException, FingerprintAuthenticationRequiredException, FingerprintNotEnrolledException, PasswordRequiredException, PasswordExpiredException

Gets the key in its primary encoding format.

Parameters

password

the key password.

Returns

The key in its primary encoding format.

Exceptions

UnsupportedDeviceException	if device is not supported by policy.
AuthenticationException	if password is incorrect.
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.
PasswordExpiredException	if expired password is given (changePassword required).

getFormat()

String com.hidglobal.ia.service.transaction.Key.getFormat

(

)

throws InternalException, UnsupportedDeviceException, LostCredentialsException

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

Returns

The encoding format name.

Exceptions

InternalException	if an unexpected error occurred.
UnsupportedDeviceException	if device is not supported by policy.
LostCredentialsException	if provisioning key data has been corrupted or lost.

getId()

KeyId com.hidglobal.ia.service.transaction.Key.getId

(

)

Gets the keyId associated with key.

Returns

the keyId, null if not set.

getOTPGenerator()

OTPGenerator com.hidglobal.ia.service.transaction.Key.getOTPGenerator

(

String

name

)

throws NotImplementedException

Returns the OTP generator with specified name associated with the key. (RFU)

Parameters

name	one of OTP generators names see getOTPGeneratorNames().

Returns

The OTP generator.

Exceptions

NotImplementedException

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

getOTPGeneratorNames()

String [] com.hidglobal.ia.service.transaction.Key.getOTPGeneratorNames

(

)

throws NotImplementedException

Returns the list of supported OTP generators associated with the key. (RFU)

Returns

The list of OTP generators.

Exceptions

NotImplementedException

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

getProperty()

char [] com.hidglobal.ia.service.transaction.Key.getProperty

(

String

attribute

)

throws LostCredentialsException, InvalidParameterException, InternalException

Returns property for that key.

Parameters

attribute

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

Returns

The key property value.

Exceptions

LostCredentialsException	if provisioning key data has been corrupted or lost.
InvalidParameterException	if the given parameters are invalid or required parameters are missing.
InternalException	if an unexpected error occurred.

getProtectionPolicy()

ProtectionPolicy com.hidglobal.ia.service.transaction.Key.getProtectionPolicy

(

)

throws InternalException

Gets the protection policy associated with key.

Returns

The ProtectionPolicy used to protect the key.

Exceptions

InternalException

if an unexpected error occurred.

isExtractable()

boolean com.hidglobal.ia.service.transaction.Key.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.

Exceptions

LostCredentialsException	if provisioning key data has been corrupted or lost.
InternalException	if an unexpected error occurred.
UnsupportedDeviceException	if device is not supported by policy.