com.sleepycat.client

Class BdbServerAdmin

java.lang.Object

com.sleepycat.client.BdbServerAdmin

public class BdbServerAdmin
extends java.lang.Object

BdbServerAdmin is used to perform administrative operations on a BDB server.

Method Summary

Modifier and Type	Method and Description
void	closeDatabaseHandles(java.lang.String envHome, java.lang.String fileName, java.lang.String databaseName, long minIdleInMilli) Close database handles which are opened for the specified file and database name under the specified environment and which have not been accessed for at least the specified idle time.
void	closeEnvironmentHandles(java.lang.String home, long minIdleInMilli) Close environment handles which are opened for the specified environment and which have not been accessed for at least the specified idle time.
void	deleteEnvironmentAndDatabases(java.lang.String home, boolean force) Delete all files created for the environment at the specified home directory, and all database files created under the environment.
java.lang.String	getServerBdbVersion() Return the BDB library release version hosted by the server.
default <V> V	handleRuntimeExceptions(com.sleepycat.client.RemoteServiceCallable<V> remote)
void	ping() Check if the server is reachable and responsive.
default <V> V	remoteCall(com.sleepycat.client.RemoteServiceCallable<V> remote)
default <V> V	remoteCallWithIOException(com.sleepycat.client.RemoteServiceCallable<V> remote)
void	shutdownServer() Request to shutdown the server.

Methods inherited from class java.lang.Object

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

Method Detail

ping

public void ping()
          throws SDatabaseException

Check if the server is reachable and responsive.

Throws:

SDatabaseException - if any error occurs

getServerBdbVersion

public java.lang.String getServerBdbVersion()
                                     throws SDatabaseException

Return the BDB library release version hosted by the server.

Returns:

the BDB library release version

Throws:

SDatabaseException - if any error occurs

shutdownServer

public void shutdownServer()
                    throws SDatabaseException

Request to shutdown the server.

After this method. All connections to the server and all objects created from them must be discarded.

Throws:

SDatabaseException - if any error occurs

closeEnvironmentHandles

public void closeEnvironmentHandles(java.lang.String home,
                                    long minIdleInMilli)
                             throws SDatabaseException

Close environment handles which are opened for the specified environment and which have not been accessed for at least the specified idle time.

Before an environment handle is closed, all handles that depend on it are close first. If a close operation fails, this method continues to close the rest of handles and throw the first exception occurred.

Parameters:

home - the environment's home directory as a relative path

minIdleInMilli - the idle time in milliseconds, environment handles which have not been accessed for at least this time are closed

Throws:

SDatabaseException - if any error occurs

deleteEnvironmentAndDatabases

public void deleteEnvironmentAndDatabases(java.lang.String home,
                                          boolean force)
                                   throws java.io.IOException,
                                          SDatabaseException

Delete all files created for the environment at the specified home directory, and all database files created under the environment.

If force is true, all handles opened for the environment and all handles created from them are closed before files are deleted. If force is false and there is at least one handle opened for the environment, SResourceInUseException is thrown.

Parameters:

home - the environment's home directory as a relative path

force - if true, open handles for the environments are closed so that environment files can be deleted; otherwise, this operation fails with a SResourceInUseException if there is at least one open handle for the environment

Throws:

java.io.FileNotFoundException - if no environment exists at the specified home directory

java.io.IOException - if any I/O error occurs

SResourceInUseException - if force is false and there is at least one open handle for the environment

SDatabaseException - if any error occurs

closeDatabaseHandles

public void closeDatabaseHandles(java.lang.String envHome,
                                 java.lang.String fileName,
                                 java.lang.String databaseName,
                                 long minIdleInMilli)
                          throws SDatabaseException

Close database handles which are opened for the specified file and database name under the specified environment and which have not been accessed for at least the specified idle time. If databaseName is not specified, handles for all databases in the file are closed if they have not been accessed for at least the specified idle time.

Before a database handle is closed, all handles that depend on it are close first. If a close operation fails, this method continues to close the rest of handles and throw the first exception occurred.

Parameters:

envHome - the environment home directory as a relative path

fileName - the database file name

databaseName - the database name

minIdleInMilli - the idle time in milliseconds, database handles which have not been accessed for at least this time are closed

Throws:

SDatabaseException - if any error occurs

remoteCallWithIOException

public <V> V remoteCallWithIOException(com.sleepycat.client.RemoteServiceCallable<V> remote)
                                throws java.io.IOException

Throws:

java.io.IOException

remoteCall

public <V> V remoteCall(com.sleepycat.client.RemoteServiceCallable<V> remote)

handleRuntimeExceptions

public <V> V handleRuntimeExceptions(com.sleepycat.client.RemoteServiceCallable<V> remote)
                              throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException