org.figure8.join.services.vcs
Interface VCSAccessor

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractVCSAccessor, CVSAccessor, SubversionAccessor

public interface VCSAccessor
extends java.io.Serializable

Service interface defining an accessor for Version and Configuration management System. This interface defines operations for initializing this accessor (bunch of setX() methods), for retrieving this accessor properties (bunch of getX() methods) and for interacting with VCS system (login(), checkout() and logout() methods).

Version:

$Revision: 1.2 $

Author:

Laurent Broudoux

Method Summary

void	checkout(java.lang.String tag, java.lang.String destDirectory) Perform a checkout command (or equivalent) on the VCS using a specified baseline tag.
java.lang.String	getModule() Module of version and configuration management system used by this accessor
java.lang.String	getPassword()
java.lang.String	getProtocol()
java.lang.String	getRootRepository() The root remote repository path of VCS.
java.lang.String	getUser()
void	login() Login onto configuration management system.
void	logout() Logout from configuration management system.
void	setModule(java.lang.String module) Set the VCS module to used.
void	setPassword(java.lang.String password)
void	setProtocol(java.lang.String protocol)
void	setRootRepository(java.lang.String repository) Check getRootRepository() comments for details.
void	setUser(java.lang.String user)

Method Detail

getUser

java.lang.String getUser()

Returns:

The user for connecting to VCS implementation

setUser

void setUser(java.lang.String user)

Parameters:

user - The user for connecting to VCS implementation

getPassword

java.lang.String getPassword()

Returns:

The password for user who is connecting to VCS

setPassword

void setPassword(java.lang.String password)

Parameters:

password - The password for uer who is connecting to VCS

getModule

java.lang.String getModule()

Module of version and configuration management system used by this accessor

Returns:

The VCS implementation module name (ex: module for CVS, "trunk" for Subversion, ...)

setModule

void setModule(java.lang.String module)

Set the VCS module to used. This property has different meaning depending on the VCS implementation. It really describes a module in CVS but should be the trunk of a Subversion repository. Check the implementation documentation.

Parameters:

module - Module of VCS used by this accessor

getProtocol

java.lang.String getProtocol()

Returns:

The protocol used for connecting VCS

setProtocol

void setProtocol(java.lang.String protocol)

Parameters:

protocol - The protocol used for connecting VCS

getRootRepository

java.lang.String getRootRepository()

The root remote repository path of VCS. This property has different meaning depending on the VCS implemnetation. Typically, it is the valur of CVSROOT for CVS and an URL for Subversion. Check the implementation documentation.

Returns:

The VCS remote repository path

setRootRepository

void setRootRepository(java.lang.String repository)

Check getRootRepository() comments for details.

Parameters:

repository - The VCS remote repository path

login

void login()
           throws VCSAccessException

Login onto configuration management system.

Throws:

VCSAccessException - if login is not successfull

checkout

void checkout(java.lang.String tag,
              java.lang.String destDirectory)
              throws VCSAccessException

Perform a checkout command (or equivalent) on the VCS using a specified baseline tag. Extracted files are stored within destDirectory

Parameters:

tag - Baseline tag for retrieving module from VCS

destDirectory - Path of the destination directory where to put extracted files

Throws:

VCSAccessException - if cehckout command is not successfull

logout

void logout()
            throws VCSAccessException

Logout from configuration management system.

Throws:

VCSAccessException - if logout is not successfull