net.sf.basedb.core
Interface SecondaryStorageController

All Known Implementing Classes:

InternalStorageController

public interface SecondaryStorageController

This interface defines the methods that needs to be implemented by a class to be able to use it as a controller for seconday storage.

The core will create one object instance of the class specified by the configuration setting secondary.storage.driver. Leaving this setting empty disables the secondary storage.

When the object has been create the init(String) method is called to let the object initialise itself. The parameters for the method call is taken from the secondary.storage.init setting.

The run() method is invoked with an interval specified by the secondary.storage.interval setting. The interval is given in seconds. Alternatively the setting secondary.storage.time may contain a comma-separated list of time-points (hour:minutes) when the storage controller should be invoked. If time-points are given it overrides the interval setting which is ignored. Time-point valus must be given with time two-digit 24-based hour and two-digit minute values. For example: 03:10,09:00,23:59.

When BASE is stopped the close() method is called.

Version:

2.0

Author:

Nicklas

Last modified

$Date: 2009-04-06 14:52:39 +0200 (Mon, 06 Apr 2009) $

Method Summary

void	close() The core is now done with the storage controller.
void	init(String settings) Initialises the object.
void	run() Run the storage controller.

Method Detail

init

void init(String settings)
          throws BaseException

Initialises the object. The BASE core calls this method immediatly after the object has been created. The contents and syntax of the settings string should be defined by the implementing class. It may for example be the path to another directory of information about how to connect to a remote FTP server.

Parameters:

settings - A string containing initialisation parameters

Throws:

BaseException - If the parameters are invalid

run

void run()
         throws BaseException

Run the storage controller. It should:

• move files to the secondary storage if File.getAction() returns File.Action.MOVE_TO_SECONDARY
• restore files to the primary storage if File.getAction() returns File.Action.MOVE_TO_PRIMARY
• delete all files from the seconday storage which doesn't have a corresponding File item in the database (because it have been deleted)

Throws:

BaseException

close

void close()

The core is now done with the storage controller. Clean up and close.