org.jwall.web.audit.util

Interface RFICollectorService

All Superinterfaces:

Remote

All Known Implementing Classes:

RFICollectorServer

public interface RFICollectorService
extends Remote

This interface defines all methods which are neccessary for creating a new collector, exploring the list of available listeners and stopping existing ones.

Author:

Christian Bockermann <chris@jwall.org>

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	listCollectors() This method returns a list of all currently running listeners.
void	registerCollector(String file, Properties props) This method registers a new collector instance which tracks the given log file.
void	unregisterCollector(String file) This method stops the collector listening on the given file.

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

registerCollector

void registerCollector(String file,
                     Properties props)
                       throws RemoteException

This method registers a new collector instance which tracks the given log file.

Parameters:

file -

props -

Throws:

RemoteException - In case an error occurs such as the file does not exist or the file-format is not supported. Since currently only one collector can listen on a file, an exception is also thrown if a new collector is registered on a already observed file.

unregisterCollector

void unregisterCollector(String file)
                         throws RemoteException

This method stops the collector listening on the given file.

Parameters:

file - The file on which the collector listens.

Throws:

RemoteException - In case an error occurs.

listCollectors

List<String> listCollectors()
                            throws RemoteException

This method returns a list of all currently running listeners.

Returns:

A list of textual descriptions of all listeners.

Throws:

RemoteException - In case an error occurs.