com.togethersoft.openapi.vcs
Class DefaultVcsProvider

public class DefaultVcsProvider

implements VcsProvider, VcsProviderConstants

A default implementation of VcsProvider which defines basic functinality of the provider.
The implementation may inherit from this class to reuse this functionality.

Author:

TogetherSoft

Since: Together 4.0

private File myCurrentWorkingDirectory

private String myPassword

private String myRootProject

private File myRootWorkingDirectory

private String myUser

public void addListener(VcsProviderListener listener)

Adds provider event listenter

Stereotype new

public void changeWorkingDirectory(File workingDirectory)
                             throws VcsProviderException

Changes the value of internal current working directory field.

public void clearAdvancedOptions(String command)
                           throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public void endSession()
                 throws VcsProviderException

Clears all internal fields.

public int execAddFiles(String[] files, int[] fileTypes, String comment, boolean makeCheckedOut, boolean removeLocal)
                  throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execChangeFileType(String fileName, int newFileType)
                        throws VcsProviderException

public int execCheckInFiles(String[] files, String comment, boolean keepCheckedOut, boolean removeLocal, boolean wholeProject, boolean projectRecursively, VcsCommitInfo info)
                      throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execCheckOutFiles(String[] files, String comment, boolean wholeProject, boolean projectRecursively, VcsUpdateInfo updateInfo)
                       throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public VcsVersionInfo execFindVersionChangeAuthor(String fileName, String versionId, int lineNo)
                                            throws VcsProviderException

Find the first version in which specified string appears
A session must be started prior to call this method.

Parameters:

fileName - name of file in the current directory

versionId - identifier of version iof the file from which line is taken

lineNo - line number to be searched in the specified version of the file

Returns: information about the version where the specified line first appeared

public int execGetFileHistory(String file, List versions)
                        throws VcsProviderException

public int execGetFileInfo(String[] files, boolean wholeProject, boolean projectRecursively, List fileInfo)
                     throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execGetFiles(String[] files, boolean wholeProject, boolean projectRecursively, VcsUpdateInfo updateInfo)
                  throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execGetFilesStatuses(String[] files, int[] statuses)
                          throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execGetMissingFiles(Vector files)
                         throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execGetRawFileDiff(String fileName, boolean ignoreCase, boolean ignoreSpace, StringBuffer diff)
                        throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execGetRawFilesHistory(String[] files, boolean wholeProject, boolean projectRecursively, StringBuffer buffer)
                            throws VcsProviderException

public int execGetRawVersionsDiff(String versionID1, String versionID2, boolean ignoreCase, boolean ignoreSpace, StringBuffer buf)
                            throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execGetVersion(String versionID, java.io.OutputStream stream)
                    throws VcsProviderException

public int execLockFiles(String[] files, boolean wholeProject, boolean projectRecursively)
                   throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execRemoveFiles(String[] files, String comment, boolean removeLocal)
                     throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execRenameFile(String fileName, String newFileName)
                    throws VcsProviderException

This method should be overridden by subclass if the command is supported.

public int execSearchFileHistory(String file, String pattern, List searchResult)
                           throws VcsProviderException

public int execSelectProject(String defaultProject, File workingDir, boolean createNewProject, StringBuffer selectedProject)
                       throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execSetFilesLabel(String[] files, String label, boolean wholeProject, boolean projectRecursively)
                       throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execShowAdvancedOptions(String command, boolean project)
                             throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execShowFileDiff(String fileName, boolean ignoreCase, boolean ignoreSpace)
                      throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execShowFileProperties(String fileName)
                            throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execShowFilesHistory(String[] files, boolean wholeProject, boolean projectRecursively)
                          throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execUnCheckOutFiles(String[] files, boolean removeLocal, boolean wholeProject, boolean projectRecursively)
                         throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execUnLockFiles(String[] files, boolean wholeProject, boolean projectRecursively)
                     throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public int execUnSetFilesLabel(String[] files, String label, boolean wholeProject, boolean projectRecursively)
                         throws VcsProviderException

public int execUpdateFiles(String[] files, boolean wholeProject, boolean projectRecursively, VcsUpdateInfo updateInfo)
                     throws VcsProviderException

Throws CapabilityException. This method should be overridden by subclass if the command is supported.

public void free()

Clears all internal fields.

public String getCurrentProject()

Returns root project + path from root working directory to current
working directory. All delimiters guaranteed to be "/". This method may be overridden to get correct project.

public File getCurrentWorkingDirectory()

Returns value of internal current project field.

public int getFileStatus(String filename)
                   throws VcsProviderException

Returns FILE_STATUS_NONE.

public String getID()

Returns "DEFAULT" as provider ID. Should be overridden by subclass.

public String getRootProject()

Returns value of internal root project field.

public File getRootWorkingDirectory()

Returns value of internal root working directory field.

public boolean isSessionStarted()

Returns true if both internal root project and working directories are not null.

public boolean isValid()

Always returns false.

public boolean isVcsInternalFile(String fileName)

public void removeListener(VcsProviderListener listener)

Removes provider event listenter

Stereotype new

public void setListener(VcsProviderListener listener)

Set provider event listenter

public void startSession(String rootProject, File rootWorkingDir, String user, String password)
                   throws VcsProviderException

Initializes internal root project and working directory values.
Current working directory set to root. None of parameters can be null.

throw IllegalArgumentException if any of parameters is null.

public void startSession(String rootProject, File rootWorkingDir)
                   throws VcsProviderException

Association Links

to Class java.io.File

to Class java.io.File

to Class java.lang.String

to Class java.lang.String

to Class java.lang.String