net.sf.regain.crawler.access
Interface CrawlerAccessController

public interface CrawlerAccessController

Identifies the groups that are are allowed to read a document. These groups will be stored in the index and will be used by the SearchAccessController which is the counter-part to this class.

This interface is a part of the access control system that ensures that only those documents are shown in the search results that the user is allowed to read.

Author:

Tilman Schneider, STZ-IDA an der FH Karlsruhe

See Also:

SearchAccessController

Method Summary

String[]	getDocumentGroups(RawDocument document) Gets the names of the groups that are allowed to read the given document.
void	init(Properties config) Initializes the CrawlerAccessController.

Method Detail

init

void init(Properties config)
          throws RegainException

Initializes the CrawlerAccessController.

This method is called once right after the CrawlerAccessController instance was created.

Parameters:

config - The configuration.

Throws:

RegainException - If loading the config failed.

getDocumentGroups

String[] getDocumentGroups(RawDocument document)
                           throws RegainException

Gets the names of the groups that are allowed to read the given document.

Note: The group array must not be null and the group names must not contain whitespace.

Parameters:

document - The document to get the groups for.

Returns:

The groups that are allowed to read the given document.

Throws:

RegainException - If getting the groups failed.