com.aquafold.openapi.vcs
Interface AQVersionControl

public interface AQVersionControl

This interface provides version control functionality to aquascripts.

An object implementing this interface is available to aquascript via aqua.vcs alias.

Method Summary

AQWorkspace	checkoutCVS(String folder, String url, String module, String revision, Object username, Object password, boolean verbose) Checks out a CVS module to the local filesystem.
AQWorkspace	checkoutSubversion(String folder, String url, String revision, Object username, Object password, boolean verbose) Checks out a Subversion module to the local filesystem.
void	commit(String path, String comment, Object username, Object password) A convenience method which performs a version control commit of a specified file or folder in the local file system.
AQWorkspace	getWorkspaceSubversion(String path) Returns the parent workspace of the specified file.
AQGit	newGit() Returns an unconnected GIT object.
AQPerforce	newPerforce() Returns an unconnected Perforce object.
AQWorkspace	newWorkspaceCVS() Returns a CVS workspace object for the purpose of checking out a working copy.
AQWorkspace	newWorkspaceSubversion() Returns a Subversion workspace object for the purpose of checking out a working copy.
void	update(String path, Object username, Object password) A convenience method which performs a version control update to the latest (HEAD) revision of the specified file or folder on the local file system.

Method Detail

newWorkspaceSubversion

AQWorkspace newWorkspaceSubversion()

Returns a Subversion workspace object for the purpose of checking out a working copy. This object may require user credentials and additional configuration options set prior to use.

newWorkspaceCVS

AQWorkspace newWorkspaceCVS()

Returns a CVS workspace object for the purpose of checking out a working copy. This object may require user credentials and additional configuration options set prior to use.

newPerforce

AQPerforce newPerforce()

Returns an unconnected Perforce object. This object may require user credentials and additional configuration options set prior to use.

newGit

AQGit newGit()

Returns an unconnected GIT object. This object may require user credentials and additional configuration options set prior to use.

commit

void commit(String path,
            String comment,
            Object username,
            Object password)
            throws Exception

A convenience method which performs a version control commit of a specified file or folder in the local file system.

Parameters:

path - Full path in the local file system.

comment - Commit comment.

username - A String or a AQOpaqueObject containing the user name.

password - A String password or a AQOpaqueObject containing the password.

Throws:

Exception

update

void update(String path,
            Object username,
            Object password)
            throws Exception

A convenience method which performs a version control update to the latest (HEAD) revision of the specified file or folder on the local file system.

Parameters:

path - Full path in the local file system.

username - A String or a AQOpaqueObject containing the user name.

password - A String password or a AQOpaqueObject containing the password.

Throws:

Exception

getWorkspaceSubversion

AQWorkspace getWorkspaceSubversion(String path)
                                   throws Exception

Returns the parent workspace of the specified file.

Parameters:

path - Full path in the local file system.

Throws:

Exception - if the file is not under version control.

checkoutCVS

AQWorkspace checkoutCVS(String folder,
                        String url,
                        String module,
                        String revision,
                        Object username,
                        Object password,
                        boolean verbose)
                        throws Exception

Checks out a CVS module to the local filesystem.

Parameters:

folder - Destination folder on the local filesystem.

url - Remote URL. Remote URL is of the form :pserver:<hostname>:/<repository>

module - CVS module (directory).

revision - Revision number or a tag. A null is equivalent to HEAD revision.

username - A String or a AQOpaqueObject containing the user name.

password - A String password or a AQOpaqueObject containing the password.

verbose - When true, the output of checkout operation will be sent to the console.

Throws:

Exception

checkoutSubversion

AQWorkspace checkoutSubversion(String folder,
                               String url,
                               String revision,
                               Object username,
                               Object password,
                               boolean verbose)
                               throws Exception

Checks out a Subversion module to the local filesystem.

Parameters:

folder - Destination folder on the local filesystem.

url - Remote URL.

revision - Revision number or a tag. A null is equivalent to HEAD revision.

username - A String or a AQOpaqueObject containing the user name.

password - A String password or a AQOpaqueObject containing the password.

verbose - When true, the output of checkout operation will be sent to the console.

Throws:

Exception