org.firebirdsql.gds.ng.wire.auth

Class LegacyAuthenticationPlugin

java.lang.Object

org.firebirdsql.gds.ng.wire.auth.LegacyAuthenticationPlugin

All Implemented Interfaces:

AuthenticationPlugin

public class LegacyAuthenticationPlugin
extends java.lang.Object
implements AuthenticationPlugin

Authentication plugin for the Firebird legacy authentication (as defined in Firebird 3).

Since:

3.0

Author:

Mark Rotteveel

Nested Class Summary

Nested classes/interfaces inherited from interface org.firebirdsql.gds.ng.wire.auth.AuthenticationPlugin

AuthenticationPlugin.AuthStatus

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LEGACY_AUTH_NAME
static java.lang.String	LEGACY_PASSWORD_SALT

Constructor Summary

Constructors

Constructor and Description
LegacyAuthenticationPlugin()

Method Summary

Modifier and Type	Method and Description
AuthenticationPlugin.AuthStatus	authenticate(ClientAuthBlock clientAuthBlock) Authenticate using the plugin.
byte[]	getClientData()
java.lang.String	getName()
boolean	hasServerData()
void	setServerData(byte[] serverData) Sets data received from the server.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LEGACY_AUTH_NAME

public static final java.lang.String LEGACY_AUTH_NAME

See Also:

Constant Field Values

LEGACY_PASSWORD_SALT

public static final java.lang.String LEGACY_PASSWORD_SALT

See Also:

Constant Field Values

Constructor Detail

LegacyAuthenticationPlugin

public LegacyAuthenticationPlugin()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface AuthenticationPlugin

Returns:

Name of the plugin as used by Firebird

authenticate

public AuthenticationPlugin.AuthStatus authenticate(ClientAuthBlock clientAuthBlock)
                                             throws java.sql.SQLException

Description copied from interface: AuthenticationPlugin

Authenticate using the plugin.

The data generated by this method should be stored and available for calls from AuthenticationPlugin.getClientData().

The method authenticate may be called multiple times depending on the state of the authentication (as indicated by the returned AuthenticationPlugin.AuthStatus.

Specified by:

authenticate in interface AuthenticationPlugin

Parameters:

clientAuthBlock - Client authentication block.

Returns:

Status of the authentication

Throws:

java.sql.SQLException - For authentication failures

getClientData

public byte[] getClientData()

Specified by:

getClientData in interface AuthenticationPlugin

Returns:

The data generated by a call to AuthenticationPlugin.authenticate(ClientAuthBlock).

setServerData

public void setServerData(byte[] serverData)

Description copied from interface: AuthenticationPlugin

Sets data received from the server.

Specified by:

setServerData in interface AuthenticationPlugin

Parameters:

serverData - Server data

hasServerData

public boolean hasServerData()

Specified by:

hasServerData in interface AuthenticationPlugin

Returns:

true if plugin has non-null and non-empty server data

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object