DatabaseRuntime (Database Explorer) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.db/0 1.20.0 4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.spi.db.explorer
Interface DatabaseRuntime

public interface DatabaseRuntime

Represents an instance of a database server, typically a local installation which can be started when a connection to this server is being made, or stopped upon IDE shutdown.

Implementations of this class should be put in the Databases/Runtimes folder in the default filesystem.

Method Summary

boolean acceptsDatabaseURL(String url)
          Returns whether this runtime accepts this database URL (the database URL would cause a connection to be made to the database server instance represented by this runtime).

boolean canStart()
          Returns whether the database server instance can be started by a call to the start() method.

String getJDBCDriverClass()
          Returns the JDBC driver class which is used to make connections to the represented database server instance.

boolean isRunning()
          Returns the state (running/not running) of the represented database server instance.

void start()
          Starts the database server instance represented by this runtime.

void stop()
          Stops the database server instance represented by this runtime.

Method Summary
`boolean`	`acceptsDatabaseURL(String url)` Returns whether this runtime accepts this database URL (the database URL would cause a connection to be made to the database server instance represented by this runtime).
`boolean`	`canStart()` Returns whether the database server instance can be started by a call to the `start()` method.
`String`	`getJDBCDriverClass()` Returns the JDBC driver class which is used to make connections to the represented database server instance.
`boolean`	`isRunning()` Returns the state (running/not running) of the represented database server instance.
`void`	`start()` Starts the database server instance represented by this runtime.
`void`	`stop()` Stops the database server instance represented by this runtime.

Method Detail

getJDBCDriverClass

String getJDBCDriverClass()

Returns the JDBC driver class which is used to make connections to the represented database server instance.

When a connection is being made, only the database runtimes which have the same JDBC driver as the driver used by this connection are considered for further usage (e.g., starting the database server instance).

Returns:: the fully-qualified class name of the driver used to make connections to the represented database server instance.

acceptsDatabaseURL

boolean acceptsDatabaseURL(String url)

Returns whether this runtime accepts this database URL (the database URL would cause a connection to be made to the database server instance represented by this runtime).

Parameters:: url - the database URL
Returns:: true if the runtime accepts this database URL; false otherwise.

isRunning

boolean isRunning()

Returns the state (running/not running) of the represented database server instance.

Returns:: true if the database server instance is running; false otherwise.

canStart

boolean canStart()

Returns whether the database server instance can be started by a call to the start() method.

Returns:: true if the database server instance can be started; false otherwise.

start

void start()

Starts the database server instance represented by this runtime.

stop

void stop()

Stops the database server instance represented by this runtime.