Package org.opengrok.indexer.history

Class RepositoryFactory

java.lang.Object

org.opengrok.indexer.history.RepositoryFactory

public final class RepositoryFactory
extends Object

This is a factory class for the different repositories.

Author:

austvik

Method Summary

Modifier and Type	Method	Description
static List<Class<? extends Repository>>	getDisabledRepositoryClasses()	Gets a list of all disabled repository handlers.
static Repository	getRepository(File file)	Calls getRepository(File, CommandTimeoutType) with file and false.
static Repository	getRepository(File file, CommandTimeoutType cmdType)	Calls getRepository(File, CommandTimeoutType, boolean) with file, interactive, and false.
static Repository	getRepository(File file, CommandTimeoutType cmdType, boolean isNested)	Returns a repository for the given file, or null if no repository was found.
static Repository	getRepository(RepositoryInfo info, CommandTimeoutType cmdType)	Returns a repository for the given file, or null if no repository was found.
static List<Class<? extends Repository>>	getRepositoryClasses()	Get a list of all available repository handlers.
static void	initializeIgnoredNames(RuntimeEnvironment env)	Go through all supported repository types, and add their ignored items to the environment's lists of ignored files/directories -- but skip any repository types which are named in RuntimeEnvironment.getDisabledRepositories() ()}.
static String	matchRepositoryByName(String name)	Tries to match a supported repositories by name or nickname -- e.g.

Methods inherited from class java.lang.Object

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

Method Details

getRepositoryClasses

public static List<Class<? extends Repository>> getRepositoryClasses()

Get a list of all available repository handlers.

Returns:

a list that contains non-null values only

getDisabledRepositoryClasses

public static List<Class<? extends Repository>> getDisabledRepositoryClasses()

Gets a list of all disabled repository handlers.

Returns:

a list that contains non-null values only

getRepository

public static Repository getRepository(File file)
                                throws InstantiationException,
IllegalAccessException,
NoSuchMethodException,
InvocationTargetException,
IOException,
ForbiddenSymlinkException

Calls getRepository(File, CommandTimeoutType) with file and false.

Throws:

InstantiationException

IllegalAccessException

NoSuchMethodException

InvocationTargetException

IOException

ForbiddenSymlinkException

getRepository

public static Repository getRepository(File file,
 CommandTimeoutType cmdType)
                                throws IllegalAccessException,
InvocationTargetException,
ForbiddenSymlinkException,
InstantiationException,
NoSuchMethodException,
IOException

Calls getRepository(File, CommandTimeoutType, boolean) with file, interactive, and false.

Parameters:

file - file

cmdType - command timeout type

Returns:

repository object

Throws:

IllegalAccessException - on error

InvocationTargetException - on error

ForbiddenSymlinkException - on error

InstantiationException - on error

NoSuchMethodException - on error

IOException - on error

getRepository

public static Repository getRepository(File file,
 CommandTimeoutType cmdType,
 boolean isNested)
                                throws InstantiationException,
IllegalAccessException,
NoSuchMethodException,
InvocationTargetException,
IOException,
ForbiddenSymlinkException

Returns a repository for the given file, or null if no repository was found.

Note that the operations performed by this method take quite a long time thanks to external commands being executed. For that reason, when run on multiple files, it should be parallelized (e.g. like it is done in invalidateRepositories()) and the commands run within should use interactive command timeout (as specified in Configuration).

Parameters:

file - File that might contain a repository

cmdType - command timeout type

isNested - a value indicating if a nestable Repository is required

Returns:

Correct repository for the given file or null

Throws:

InstantiationException - in case we cannot create the repository object

IllegalAccessException - in case no permissions to repository file

NoSuchMethodException - in case we cannot create the repository object

InvocationTargetException - in case we cannot create the repository object

IOException - when resolving repository path

ForbiddenSymlinkException - when resolving repository path

getRepository

public static Repository getRepository(RepositoryInfo info,
 CommandTimeoutType cmdType)
                                throws InstantiationException,
IllegalAccessException,
NoSuchMethodException,
InvocationTargetException,
IOException,
ForbiddenSymlinkException

Returns a repository for the given file, or null if no repository was found.

Parameters:

info - Information about the repository

cmdType - command timeout type

Returns:

Correct repository for the given file

Throws:

InstantiationException - in case we cannot create the repository object

IllegalAccessException - in case no permissions to repository

NoSuchMethodException - in case we cannot create the repository object

InvocationTargetException - in case we cannot create the repository object

IOException - when resolving repository path

ForbiddenSymlinkException - when resolving repository path

initializeIgnoredNames

public static void initializeIgnoredNames(RuntimeEnvironment env)

Go through all supported repository types, and add their ignored items to the environment's lists of ignored files/directories -- but skip any repository types which are named in RuntimeEnvironment.getDisabledRepositories() ()}. This way per-repository ignored entries are set inside repository classes rather than globally in IgnoredFiles/Dirs.

(Should be called after RuntimeEnvironment.setConfiguration(Configuration).)

matchRepositoryByName

public static String matchRepositoryByName(String name)

Tries to match a supported repositories by name or nickname -- e.g. "CVSRepository" or "CVS" or "cvs".

Returns:

a defined, class simple name (e.g. "CVSRepository" when "cvs" is passed); or null if no match found