eu.id3.bioseal

Class UserAuthentication

java.lang.Object

eu.id3.bioseal.UserAuthentication

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable

public class UserAuthentication
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable

Represents the user authentication parameters.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserAuthentication() Creates a new instance of the UserAuthentication class.
UserAuthentication(long handle) Creates a new instance of the UserAuthentication class.

Method Summary

Modifier and Type	Method and Description
void	close() Releases all resources used by this UserAuthentication.
protected void	finalize() Finalizer for this class.
long	getHandle() Gets the native handle.
UserAuthenticationMethod	getMethod() Gets the the user authentication method.
java.lang.String	getPasswordFieldName() Gets the the name of the payload field containing the password value.
java.lang.String	getPasswordHashAlgorithm() Gets the the hash algorithm used to protect the password value.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserAuthentication

public UserAuthentication()
                   throws BiosealException

Creates a new instance of the UserAuthentication class.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

UserAuthentication

public UserAuthentication(long handle)
                   throws BiosealException

Creates a new instance of the UserAuthentication class.

Parameters:

handle - Handle to the UserAuthentication.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

Method Detail

close

public void close()

Releases all resources used by this UserAuthentication.

Specified by:

close in interface java.lang.AutoCloseable

finalize

protected void finalize()

Finalizer for this class. Finalizers are deprecated since Java 9+. This method is not guaranteed to be called. To release all memory held by this class please be sure to call the close() method.

Overrides:

finalize in class java.lang.Object

getHandle

public long getHandle()

Gets the native handle.

Returns:

The native handle.

getMethod

public UserAuthenticationMethod getMethod()
                                   throws BiosealException

Gets the the user authentication method.

Returns:

The user authentication method.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getPasswordFieldName

public java.lang.String getPasswordFieldName()
                                      throws BiosealException

Gets the the name of the payload field containing the password value.

Returns:

The name of the payload field containing the password value.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getPasswordHashAlgorithm

public java.lang.String getPasswordHashAlgorithm()
                                          throws BiosealException

Gets the the hash algorithm used to protect the password value. Possible values are: Sha256, Sha384, Sha512.

Returns:

The hash algorithm used to protect the password value. Possible values are: Sha256, Sha384, Sha512.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.