org.cyclopsgroup.gitcon

Interface Source

All Known Implementing Classes:

JGitLocalResourceRepository, JGitSource

public interface Source

A source that gets files from a logical repository into physical local file system

Method Summary

Methods

Modifier and Type	Method and Description
File	initWorkingDirectory(File workingDirectory) Get files from logical source into local working directory when application starts
void	updateWorkingDirectory(File workingDirectory) Get modified files from logic source into local working directory.

Method Detail

initWorkingDirectory

File initWorkingDirectory(File workingDirectory)
                          throws Exception

Get files from logical source into local working directory when application starts

Parameters:

workingDirectory - Local working directory, the root of local repository

Returns:

The root of copied files from logical source under working directory. It's not necessarily the same working directory, since the implementation of Source may choose to download remote files into a subdirectory under working directory, in which case the subdirectory is returned.

Throws:

Exception - Allows any exception

updateWorkingDirectory

void updateWorkingDirectory(File workingDirectory)
                            throws Exception

Get modified files from logic source into local working directory. This call gets remote incremental modifications and is expected to be called repeatedly.

Parameters:

workingDirectory - Local working directory

Throws:

Exception - Allows any exception