org.figure8.join.services.vcs
Class AbstractVCSAccessor

java.lang.Object
  org.figure8.join.services.vcs.AbstractVCSAccessor

All Implemented Interfaces:

java.io.Serializable, VCSAccessor

Direct Known Subclasses:

CVSAccessor, SubversionAccessor

public abstract class AbstractVCSAccessor
extends java.lang.Object
implements VCSAccessor

Support implementation of VCSAccessor.

Version:

$Revision: 1.2 $

Author:

Laurent Broudoux

See Also:

Serialized Form

Field Summary

protected java.lang.String	module VCS module to connect to
protected java.lang.String	password Password for connecting to VCS
protected java.lang.String	protocol Protocol used for connection
protected java.lang.String	rootRepository VCS remote root repository to connect
protected java.lang.String	user User for connecting to VCS

Constructor Summary

AbstractVCSAccessor()

Method Summary

protected org.apache.tools.ant.taskdefs.ExecuteStreamHandler	getExecuteStreamHandler() This method is useful for extensions that want to use the Jakarta Ant command line interface for native executables.
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	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)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.figure8.join.services.vcs.VCSAccessor

checkout, login, logout

Field Detail

user

protected java.lang.String user

User for connecting to VCS

password

protected java.lang.String password

Password for connecting to VCS

module

protected java.lang.String module

VCS module to connect to

protocol

protected java.lang.String protocol

Protocol used for connection

rootRepository

protected java.lang.String rootRepository

VCS remote root repository to connect

Constructor Detail

AbstractVCSAccessor

public AbstractVCSAccessor()

Method Detail

getUser

public java.lang.String getUser()

Specified by:

getUser in interface VCSAccessor

Returns:

The user for connecting to VCS implementation

setUser

public void setUser(java.lang.String user)

Specified by:

setUser in interface VCSAccessor

Parameters:

user - The user for connecting to VCS implementation

getPassword

public java.lang.String getPassword()

Specified by:

getPassword in interface VCSAccessor

Returns:

The password for user who is connecting to VCS

setPassword

public void setPassword(java.lang.String password)

Specified by:

setPassword in interface VCSAccessor

Parameters:

password - The password for uer who is connecting to VCS

getModule

public java.lang.String getModule()

Module of version and configuration management system used by this accessor

Specified by:

getModule in interface VCSAccessor

Returns:

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

setModule

public 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.

Specified by:

setModule in interface VCSAccessor

Parameters:

module - Module of VCS used by this accessor

getProtocol

public java.lang.String getProtocol()

Specified by:

getProtocol in interface VCSAccessor

Returns:

The protocol used for connecting VCS

setProtocol

public void setProtocol(java.lang.String protocol)

Specified by:

setProtocol in interface VCSAccessor

Parameters:

protocol - The protocole used for connecting VCS

getRootRepository

public 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.

Specified by:

getRootRepository in interface VCSAccessor

Returns:

The VCS remote repository path

setRootRepository

public void setRootRepository(java.lang.String repository)

Check getRootRepository() comments for details.

Specified by:

setRootRepository in interface VCSAccessor

Parameters:

repository - The VCS remote repository path

getExecuteStreamHandler

protected org.apache.tools.ant.taskdefs.ExecuteStreamHandler getExecuteStreamHandler()

This method is useful for extensions that want to use the Jakarta Ant command line interface for native executables. This CLI needs some handler for the execution streams and that is just what this method is prodviding !
Get a default ExecuteStreamHandler which is the PumpStreamHandler constructs with no arguments. This means that output stream handler is System.out and error stream handler is System.err.

Returns:

A default ExecuteStreamHandler that uses System.out and System.err streams