PostgreSQL JDBC Driver 42.7.2 · org.postgresql.core.v3.AuthenticationPluginManager

Modifier and Type	Class and Description
public static interface	AuthenticationPluginManager.PasswordAction<T, R>

Modifier and Type	Field and Description
private static final Logger	LOGGER

Access	Constructor and Description
private	AuthenticationPluginManager()

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public static <T> T	withEncodedPassword(AuthenticationRequestType The authentication type that is being requested type, Properties The connection properties for the connection info, AuthenticationPluginManager.PasswordAction<byte[], T> The action to invoke with the encoded password action) Helper that wraps `withPassword(AuthenticationRequestType, Properties, PasswordAction)`, checks that it is not-null, and encodes it as a byte array.
public static <T> T	withPassword(AuthenticationRequestType The authentication type that is being requested type, Properties The connection properties for the connection info, AuthenticationPluginManager.PasswordAction<@Nullable char[], T> The action to invoke with the password action) If a password is requested by the server during connection initiation, this method will be invoked to supply the password.

public static <T> T

withEncodedPassword(AuthenticationRequestType

The authentication type that is being requested

type, Properties

The connection properties for the connection

info, AuthenticationPluginManager.PasswordAction<byte[], T>

The action to invoke with the encoded password

action)

Helper that wraps withPassword(AuthenticationRequestType, Properties, PasswordAction), checks that it is not-null, and encodes it as a byte array.

public static <T> T

withPassword(AuthenticationRequestType

The authentication type that is being requested

type, Properties

The connection properties for the connection

info, AuthenticationPluginManager.PasswordAction<@Nullable char[], T>

The action to invoke with the password

action)

If a password is requested by the server during connection initiation, this method will be invoked to supply the password.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

LOGGER	back to summary
private static final Logger LOGGER

AuthenticationPluginManager	back to summary
private AuthenticationPluginManager()

Method Detail

withEncodedPassword back to summary

withEncodedPassword	back to summary
public static <T> T withEncodedPassword(AuthenticationRequestType type, Properties info, AuthenticationPluginManager.PasswordAction<byte[], T> action) throws PSQLException, IOException Helper that wraps `withPassword(AuthenticationRequestType, Properties, PasswordAction)`, checks that it is not-null, and encodes it as a byte array. Used by internal code paths that require an encoded password that may be an empty string, but not null. The caller provides a callback method that will be invoked with the `byte[]` encoded password. After completion, for security reasons the `byte[]` array will be wiped by filling it with zeroes. Callers must not rely on being able to read the password `byte[]` after the callback has completed. Parameters type:AuthenticationRequestType The authentication type that is being requested info:Properties The connection properties for the connection action:AuthenticationPluginManager.PasswordAction<byte[], T> The action to invoke with the encoded password Exceptions PSQLException: Throws a PSQLException if the plugin class cannot be instantiated or if the retrieved password is null. IOException: Bubbles up any thrown IOException from the provided callback

public static <T> T withEncodedPassword(AuthenticationRequestType type, Properties info, AuthenticationPluginManager.PasswordAction<byte[], T> action) throws PSQLException, IOException

Helper that wraps withPassword(AuthenticationRequestType, Properties, PasswordAction), checks that it is not-null, and encodes it as a byte array. Used by internal code paths that require an encoded password that may be an empty string, but not null.

The caller provides a callback method that will be invoked with the byte[] encoded password. After completion, for security reasons the byte[] array will be wiped by filling it with zeroes. Callers must not rely on being able to read the password byte[] after the callback has completed.

Parameters

type:AuthenticationRequestType: The authentication type that is being requested
info:Properties: The connection properties for the connection
action:AuthenticationPluginManager.PasswordAction<byte[], T>: The action to invoke with the encoded password

Exceptions

PSQLException:: Throws a PSQLException if the plugin class cannot be instantiated or if the retrieved password is null.
IOException:: Bubbles up any thrown IOException from the provided callback

withPassword back to summary

withPassword	back to summary
public static <T> T withPassword(AuthenticationRequestType type, Properties info, AuthenticationPluginManager.PasswordAction<@Nullable char[], T> action) throws PSQLException, IOException If a password is requested by the server during connection initiation, this method will be invoked to supply the password. This method will only be invoked if the server actually requests a password, e.g. trust authentication will skip it entirely. The caller provides a action method that will be invoked with the `char[]` password. After completion, for security reasons the `char[]` array will be wiped by filling it with zeroes. Callers must not rely on being able to read the password `char[]` after the action has completed. Parameters type:AuthenticationRequestType The authentication type that is being requested info:Properties The connection properties for the connection action:AuthenticationPluginManager.PasswordAction<@Nullable char[], T> The action to invoke with the password Exceptions PSQLException: Throws a PSQLException if the plugin class cannot be instantiated IOException: Bubbles up any thrown IOException from the provided action

public static <T> T withPassword(AuthenticationRequestType type, Properties info, AuthenticationPluginManager.PasswordAction<@Nullable char[], T> action) throws PSQLException, IOException

If a password is requested by the server during connection initiation, this method will be invoked to supply the password. This method will only be invoked if the server actually requests a password, e.g. trust authentication will skip it entirely.

The caller provides a action method that will be invoked with the char[] password. After completion, for security reasons the char[] array will be wiped by filling it with zeroes. Callers must not rely on being able to read the password char[] after the action has completed.

Parameters

type:AuthenticationRequestType: The authentication type that is being requested
info:Properties: The connection properties for the connection
action:AuthenticationPluginManager.PasswordAction<@Nullable char[], T>: The action to invoke with the password

Exceptions

PSQLException:: Throws a PSQLException if the plugin class cannot be instantiated
IOException:: Bubbles up any thrown IOException from the provided action

pack-priv Class AuthenticationPluginManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface AuthenticationPluginManager.PasswordAction<T, R>

Method Summary

Method Detail