Package org.mariadb.jdbc.plugin
Interface CredentialPlugin
-
- All Superinterfaces:
java.util.function.Supplier<Credential>
- All Known Implementing Classes:
EnvCredentialPlugin
,PropertiesCredentialPlugin
public interface CredentialPlugin extends java.util.function.Supplier<Credential>
Credential plugin definition, to permit providing Credential to server
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default java.lang.String
defaultAuthenticationPluginType()
Indicate authentication plugin type to use for authenticationdefault CredentialPlugin
initialize(Configuration conf, java.lang.String userName, HostAddress hostAddress)
Permit initializing plugin if overriddendefault boolean
mustUseSsl()
Indicate if plugin must throw an error if SSL is not enabledjava.lang.String
type()
credential identifier
-
-
-
Method Detail
-
type
java.lang.String type()
credential identifier- Returns:
- type
-
mustUseSsl
default boolean mustUseSsl()
Indicate if plugin must throw an error if SSL is not enabled- Returns:
- if ssl is required
-
defaultAuthenticationPluginType
default java.lang.String defaultAuthenticationPluginType()
Indicate authentication plugin type to use for authentication- Returns:
- plugin type to use for authentication, or null for default
-
initialize
default CredentialPlugin initialize(Configuration conf, java.lang.String userName, HostAddress hostAddress) throws java.sql.SQLException
Permit initializing plugin if overridden- Parameters:
conf
- configurationuserName
- userhostAddress
- host information- Returns:
- credential plugin
- Throws:
java.sql.SQLException
- if any error occurs
-
-