org.treetank.filelistener.file

Class Filelistener

java.lang.Object

org.treetank.filelistener.file.Filelistener

public class Filelistener
extends Object

Author:

Andreas Rain

Constructor Summary

Constructors

Constructor and Description
Filelistener()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	addFilelistener(String pResourcename, String pListenerPath) Add a new filelistener to the system.
static Map<String,String>	getFilelisteners() A utility method to get all filelisteners that are already defined and stored.
FilesystemNotificationObserver	getObserver() Get the observer for this filelistener
IFilelistenerWriteTrx	getTrx(String key) Get the desired transaction.
boolean	removeFilelistener(String pResourcename) You can remove a filelistener from the system identifying it with it's Storagename.
void	setObserver(FilesystemNotificationObserver pObserver) Set the observer for this filelistener
void	shutDownListener() Shutdown listening to the defined folders and release all bonds to Treetank.
void	startListening() Start listening to the defined folders.
void	watchDir(File dir)

Methods inherited from class java.lang.Object

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

Constructor Detail

Filelistener

public Filelistener()
             throws IOException

Throws:

IOException

Method Detail

getObserver

public FilesystemNotificationObserver getObserver()

Get the observer for this filelistener

Returns:

observer

setObserver

public void setObserver(FilesystemNotificationObserver pObserver)

Set the observer for this filelistener

watchDir

public void watchDir(File dir)
              throws IOException

Parameters:

dir -

Throws:

IOException

startListening

public void startListening()
                    throws FileNotFoundException,
                           ClassNotFoundException,
                           IOException,
                           ResourceNotExistingException,
                           TTException

Start listening to the defined folders.

Throws:

FileNotFoundException

ClassNotFoundException

IOException

ResourceNotExistingException

TTException

shutDownListener

public void shutDownListener()
                      throws TTException,
                             IOException

Shutdown listening to the defined folders and release all bonds to Treetank.

Throws:

TTException

IOException

getFilelisteners

public static Map<String,String> getFilelisteners()
                                           throws FileNotFoundException,
                                                  IOException,
                                                  ClassNotFoundException

A utility method to get all filelisteners that are already defined and stored.

Returns:

returns a map of relative paths to the folders as the keyset and the resourcenames that point to the configurations in the valueset.

Throws:

FileNotFoundException

IOException

ClassNotFoundException

addFilelistener

public static boolean addFilelistener(String pResourcename,
                      String pListenerPath)
                               throws FileNotFoundException,
                                      IOException,
                                      ClassNotFoundException

Add a new filelistener to the system.

Parameters:

pResourcename -

pListenerPath -

Returns:

return true if there has been a success.

Throws:

FileNotFoundException

IOException

ClassNotFoundException

removeFilelistener

public boolean removeFilelistener(String pResourcename)
                           throws IOException,
                                  TTException,
                                  ResourceNotExistingException

You can remove a filelistener from the system identifying it with it's Storagename. The listeners have to be shutdown to do this task.

Parameters:

pResourcename -

Returns:

true if resource could be removed

Throws:

IOException

TTException

ResourceNotExistingException

getTrx

public IFilelistenerWriteTrx getTrx(String key)

Get the desired transaction. Primarily used by the workers to operate.

Parameters:

key -

Returns:

the transaction for the given resource key