- All Implemented Interfaces:
GDSFactoryPlugin
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe default protocol prefix for this type (for example, for PURE_JAVA, it's"jdbc:firebirdsql:"
.List of JDBC supported protocol prefixes, includingdefaultProtocol
.String[]
Deprecated, for removal: This API element is subject to removal in a future version.String[]
Deprecated, for removal: This API element is subject to removal in a future version.List of type aliases (in addition toGDSFactoryPlugin.getTypeName()
), for example the PURE_JAVA type has alias TYPE4.Methods inherited from class org.firebirdsql.gds.impl.BaseGDSFactoryPlugin
equals, getConnectionClass, getDatabasePath, getDatabasePath, hashCode, requirePath
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.firebirdsql.gds.impl.GDSFactoryPlugin
getDatabasePath
-
Field Details
-
PURE_JAVA_TYPE_NAME
- See Also:
-
-
Constructor Details
-
WireGDSFactoryPlugin
public WireGDSFactoryPlugin()
-
-
Method Details
-
getPluginName
- Returns:
- descriptive name of the plugin
-
getTypeName
- Returns:
- primary type name of the plugin
- See Also:
-
getTypeAliases
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:GDSFactoryPlugin
List of type aliases.Implementations with aliases are encouraged to explicitly implement
GDSFactoryPlugin.getTypeAliasList()
to return an immutable list and override this method to usereturn getTypeAliasList().toArray(new String[0])
or similar.- Returns:
- array with type aliases (empty array if there are no aliases)
- See Also:
-
getTypeAliasList
Description copied from interface:GDSFactoryPlugin
List of type aliases (in addition toGDSFactoryPlugin.getTypeName()
), for example the PURE_JAVA type has alias TYPE4.In general, we recommend not to define aliases for types, but instead only have a
typeName
.The default implementation wraps
GDSFactoryPlugin.getTypeAliases()
, but implementations are encouraged to implement this with an immutable list. This default implementation will be removed whenGDSFactoryPlugin.getTypeAliases()
is removed.- Returns:
- list of type aliases (empty list if there are no aliases)
-
getSupportedProtocols
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:GDSFactoryPlugin
List of JDBC supported protocol prefixes.Implementations with aliases are encouraged to explicitly implement
GDSFactoryPlugin.getSupportedProtocolList()
to return an immutable list and override this method to usereturn getSupportedProtocolList().toArray(new String[0])
or similar.- Returns:
- array with supported protocol prefixes (must include the value of
GDSFactoryPlugin.getDefaultProtocol()
). - See Also:
-
getSupportedProtocolList
Description copied from interface:GDSFactoryPlugin
List of JDBC supported protocol prefixes, includingdefaultProtocol
. For example the PURE_JAVA type has supported protocols["jdbc:firebirdsql:java:", "jdbc:firebird:java:", "jdbc:firebird:", "jdbc:firebirdsql:"]
.In general, one protocol should suffice. An exception can be made if the default is
"jdbc:firebirdsql:subtype:"
to also define"jdbc:firebird:subtype"
.The default implementation wraps
GDSFactoryPlugin.getSupportedProtocols()
, but implementations are encouraged to implement this with an immutable list. This default implementation will be removed whenGDSFactoryPlugin.getSupportedProtocols()
is removed.- Returns:
- list of type aliases (must include the value of
GDSFactoryPlugin.getDefaultProtocol()
)
-
getDefaultProtocol
Description copied from interface:GDSFactoryPlugin
The default protocol prefix for this type (for example, for PURE_JAVA, it's"jdbc:firebirdsql:"
.The protocol prefix must be distinct from other plugins.
- Specified by:
getDefaultProtocol
in interfaceGDSFactoryPlugin
- Overrides:
getDefaultProtocol
in classBaseGDSFactoryPlugin
- Returns:
- default protocol name
-
getDatabaseFactory
- Returns:
- instance of
FbDatabaseFactory
for this implementation
-