| java.lang.Object
 com.ice.cvsc.CVSProject
| CVSProject | | public class CVSProject extends Object implements CVSResponseHandler(Code) | | The CVSProject class implements the concept of a local
CVS project directory. A local project directory can be
thought of as a local source code working directory that
contains a CVS directory containing CVS administration files.
Combined with CVSClient, this class provides everything
you need to communicate with a CVS Server and maintain
local working directories for CVS repositories.
version:
$Revision: 2.26 $
author:
Timothy Gerard Endres, .
See Also: CVSClient |
| Constructor Summary | |
| public | CVSProject()
Constructs a new CVSProject object. | | public | CVSProject(CVSClient client)
Constructs a new CVSProject object, setting the
project's client to the one provided. |
| Method Summary | |
| public void | addEntryNotify(CVSEntryVector entries, String type, String options)
| | public void | addNewEntry(CVSEntry entry)
| | public static String | adminPathToRootPath(String dirName)
Parses a valid CVS Administration Directory path
and returns the pathname of the working directory
that the administration directory belongs to. | | public boolean | allowsGzipFileMode()
| | public boolean | checkOverwrite(CVSEntry entry, File file)
| | public boolean | checkReleaseStatus(CVSIgnore ignore, Vector mods, Vector adds, Vector rems, Vector unks)
This is used for the 'release' command to determine
if the project has any modifications the user might
not want to lose. | | public boolean | copyFile(File from, File to, int translation, boolean isGZIPed)
| | public boolean | copyFileAscii(File from, File to, boolean isGZIPed)
| | public boolean | copyFileRaw(File from, File to, boolean isGZIPed)
| | public CVSEntry | createItemEntry(CVSResponseItem item)
| | public StringBuffer | dumpCVSProject(StringBuffer buf, String description)
| | public StringBuffer | dumpEntry(StringBuffer buf, String prefix, CVSEntry dirEntry)
| | public boolean | ensureEntryHierarchy(String localDirectory, String repository)
| | public boolean | ensureLocalTree(File localFile, boolean ensureAdmin)
| | public boolean | ensureProperWorkingDirectory(String localRoot, String subPath, boolean ensureAdmin)
| | public CVSResponse | ensureRepositoryPath(CVSUserInterface ui, String localDirectory, CVSResponse resultResp)
Guarentees that the repository contains the path specified.
This will in turn invoke server commands to create the
directories needed to make the path exist, so this can and
will change the repository on the server. | | public static String | entriesPathToAdminPath(String entriesPath)
Parses a valid CVS Entries File pathname and
returns the pathname of the admin directory
that the entries files belongs to. | | public CVSEntry | entryLineToEntry(String entryLine)
| | public void | establishNewDirSticky(CVSRequest request, CVSEntry entry)
This methods deal with adding a new directory which is not
yet in the repository, and yet, whose parent directory has
a sticky tag set. | | public void | establishRootEntry(String repository)
| | public void | establishStatics(CVSRequest request)
| | public void | establishStickys(CVSRequest request)
| | public static String | getAdminEntriesPath(String adminDirPath)
Given the administrative directory pathname, return
the full pathname of the 'Entries' file. | | public static String | getAdminNotifyPath(String adminDirPath)
Given the administrative directory pathname, return
the full pathname of the 'Notify' file. | | public static String | getAdminPrefsPath(String adminDirPath)
Given the administrative directory pathname, return
the full pathname of the project preferences file. | | public static String | getAdminRepositoryPath(String adminDirPath)
Given the administrative directory pathname, return
the full pathname of the 'Repository' file. | | public static String | getAdminRootPath(String adminDirPath)
Given the administrative directory pathname, return
the full pathname of the 'Root' file. | | public CVSClient | getClient()
Returns the client this project is set to use. | | public int | getConnectionMethod()
| | public int | getConnectionPort()
| | public CVSEntry | getDirEntryForLocalDir(String localDir)
Given a 'local directory' (in the protocol sense), get the
corresponding directory CVSEntry. | | public File | getEntryFile(CVSEntry entry)
| | public int | getGzipStreamLevel()
| | public File | getLocalEntryFile(CVSEntry entry)
| | public String | getLocalRootDirectory()
| | public String | getLocalRootPath()
Returns the full local pathname for the
root directory of this project. | | public String | getPassword()
| | CVSEntry | getPathIgnoringCase(String subPath)
Given a repository path, which was not found in the
pathTable, determine if the path is in the table if
case is ignored. | | public CVSProjectDef | getProjectDef()
| | public String | getRepository()
| | public String | getRootDirectory()
| | public CVSEntry | getRootEntry()
| | public String | getRshProcess()
| | public String | getServerCommand()
| | public String[] | getSetVariables()
Returns the project's user set variables. | | public String | getTempDirectory()
| | public String | getUserName()
| | public boolean | handleResponseItem(CVSRequest request, CVSResponse response, CVSResponseItem item)
| | public boolean | hasValidLogin(String userName)
| | public void | includeNotifies(CVSRequest request)
| | public boolean | isLocalFileModified(CVSEntry entry)
| | public boolean | isPServer()
| | public boolean | isSSHServer()
| | public static boolean | isValidAdminPath(String dirName)
Determines if a pathname, provided by the dirName
parameter, is a valid CVS administration directory
(i.e., is a directory named 'CVS'). | | public CVSEntry | locateEntry(String fullPath)
| | public void | moveLocalFile(File localFile, String versionStr)
| | public String | normalizeLocalDirectory(String pathName, String repository)
Given a local-directory returned from the server,
make sure the local-directory is in a format that
jCVS can make use of (i.e., via the pathTable).
Currently, the only case handled is when local-directory
is './', which forces us to locate from pathTable.
Parameters:
pathName - The local-directory from the server.
Parameters:
repository - The repository the server sent with this local-directory. | | public void | openProject(File localRootFile)
| | public CVSNotifyItem | parseNotifyLine(String notifyLine)
| | public boolean | performCVSRequest(CVSRequest request)
| | public boolean | performCVSRequest(CVSRequest request, CVSResponse response)
| | public boolean | performCopyFile(CVSResponseItem item)
| | public boolean | processCVSResponse(CVSRequest request, CVSResponse response)
| | protected boolean | processNotified(CVSResponseItem item)
| | public void | pruneEmptySubDirs(boolean saveAdminFiles)
| | public void | pruneEmptySubDirs(CVSEntry parent)
| | public boolean | readEntries()
| | public CVSEntryVector | readEntriesFile(CVSEntry dirEntry, File workingDirectory)
| | public String | readRepository(File reposFile)
| | public String | readRootDirectory(File rootFile)
| | public void | releaseProject()
| | public void | removeAllEntries()
| | public boolean | removeEntriesItem(CVSResponseItem item)
| | public String | reposNameToFileName(String fullRepos)
| | public String | reposNameToRepository(String fullRepos)
| | public static String | rootPathToAdminPath(String dirName)
Given a root path, returns the administration directory
path corresponding to root's project. | | public void | setAllowsGzipFileMode(boolean allow)
| | public void | setClient(CVSClient client)
| | public void | setConnectionMethod(int method)
| | public void | setConnectionPort(int port)
| | public void | setGzipStreamLevel(int level)
| | public void | setLocalRootDirectory(String dirName)
| | public void | setPServer(boolean isPServer)
| | public void | setPassword(String password)
| | public void | setProjectDef(CVSProjectDef projectDef)
| | public void | setRepository(String repository)
| | public void | setRootDirectory(String rootDirectory)
| | public void | setRshProcess(String rshProcess)
| | public void | setServerCommand(String command)
| | public void | setSetVariables(String[] vars)
Sets the project's user set variables. | | public boolean | setStaticDirectory(CVSResponseItem item, boolean isSet, boolean writeFile)
| | public boolean | setSticky(CVSResponseItem item, boolean isSet, boolean writeFile)
| | public void | setTempDirectory(String dirName)
| | public void | setUserName(String name)
| | public String | toString()
| | public void | uiDisplayProgramError(String error)
| | public void | uiDisplayProgressMsg(String message)
| | public void | uiDisplayResponse(CVSResponse response)
| | public void | updateEntriesItem(CVSEntry newEntry)
Given an entry, update the entry in our project. | | public boolean | updateLocalFile(CVSResponseItem item, CVSEntry entry, File localFile)
| | public static boolean | verifyAdminDirectory(String dirName)
Verifies that a directory path is a valid CVS
administration directory. | | public boolean | verifyPassword(CVSUserInterface ui, String userName, String password, boolean trace)
| | public boolean | writeAdminEntriesFile(File entriesFile, CVSEntryVector entries)
| | public boolean | writeAdminFiles()
| | public boolean | writeAdminRepositoryFile(File repFile, String repository)
| | public boolean | writeAdminRootFile(File rootFile, String rootDirectoryStr)
|
| debugEntryIO | | public static boolean debugEntryIO(Code) | | |
| deepDebug | | public static boolean deepDebug(Code) | | |
| overTraceProcessing | | public static boolean overTraceProcessing(Code) | | |
| overTraceRequest | | public static boolean overTraceRequest(Code) | | |
| overTraceResponse | | public static boolean overTraceResponse(Code) | | |
| overTraceTCP | | public static boolean overTraceTCP(Code) | | |
| CVSProject | | public CVSProject()(Code) | | Constructs a new CVSProject object.
|
| CVSProject | | public CVSProject(CVSClient client)(Code) | | Constructs a new CVSProject object, setting the
project's client to the one provided.
Parameters:
client - A CVSClient object to be used by thisproject for all CVS server requests. |
| adminPathToRootPath | | public static String adminPathToRootPath(String dirName)(Code) | | Parses a valid CVS Administration Directory path
and returns the pathname of the working directory
that the administration directory belongs to. In
other words, it returns the directory's parent.
Parameters:
dirName - the pathname of the admin directory |
| allowsGzipFileMode | | public boolean allowsGzipFileMode()(Code) | | |
| checkReleaseStatus | | public boolean checkReleaseStatus(CVSIgnore ignore, Vector mods, Vector adds, Vector rems, Vector unks)(Code) | | This is used for the 'release' command to determine
if the project has any modifications the user might
not want to lose.
True if the project has any changes user might want to save. |
| copyFile | | public boolean copyFile(File from, File to, int translation, boolean isGZIPed)(Code) | | |
| copyFileAscii | | public boolean copyFileAscii(File from, File to, boolean isGZIPed)(Code) | | |
| copyFileRaw | | public boolean copyFileRaw(File from, File to, boolean isGZIPed)(Code) | | |
| ensureEntryHierarchy | | public boolean ensureEntryHierarchy(String localDirectory, String repository)(Code) | | |
| ensureLocalTree | | public boolean ensureLocalTree(File localFile, boolean ensureAdmin)(Code) | | |
| ensureProperWorkingDirectory | | public boolean ensureProperWorkingDirectory(String localRoot, String subPath, boolean ensureAdmin)(Code) | | |
| ensureRepositoryPath | | public CVSResponse ensureRepositoryPath(CVSUserInterface ui, String localDirectory, CVSResponse resultResp)(Code) | | Guarentees that the repository contains the path specified.
This will in turn invoke server commands to create the
directories needed to make the path exist, so this can and
will change the repository on the server. The repositoryPath
is relative to the repository's root directory.
Parameters:
ui - The CVS User Interface to display the progress.
Parameters:
localDirectory - The relative path to ensure. A CVSResponse with the results of each directory 'add'. |
| entriesPathToAdminPath | | public static String entriesPathToAdminPath(String entriesPath)(Code) | | Parses a valid CVS Entries File pathname and
returns the pathname of the admin directory
that the entries files belongs to. In other
words, it returns the directory's parent.
Parameters:
entriesPath - The pathname of the Entries file. |
| establishNewDirSticky | | public void establishNewDirSticky(CVSRequest request, CVSEntry entry)(Code) | | This methods deal with adding a new directory which is not
yet in the repository, and yet, whose parent directory has
a sticky tag set. We wish to "inherit" that tag...
|
| establishRootEntry | | public void establishRootEntry(String repository)(Code) | |
Parameters:
repository - The server's repository pathname for the root. |
| getAdminEntriesPath | | public static String getAdminEntriesPath(String adminDirPath)(Code) | | Given the administrative directory pathname, return
the full pathname of the 'Entries' file.
Parameters:
adminDirPath - The pathname of the admin ('CVS') directory. |
| getAdminNotifyPath | | public static String getAdminNotifyPath(String adminDirPath)(Code) | | Given the administrative directory pathname, return
the full pathname of the 'Notify' file.
Parameters:
adminDirPath - The pathname of the admin ('CVS') directory. |
| getAdminPrefsPath | | public static String getAdminPrefsPath(String adminDirPath)(Code) | | Given the administrative directory pathname, return
the full pathname of the project preferences file.
Parameters:
adminDirPath - The pathname of the admin ('CVS') directory. |
| getAdminRepositoryPath | | public static String getAdminRepositoryPath(String adminDirPath)(Code) | | Given the administrative directory pathname, return
the full pathname of the 'Repository' file.
Parameters:
adminDirPath - The pathname of the admin ('CVS') directory. |
| getAdminRootPath | | public static String getAdminRootPath(String adminDirPath)(Code) | | Given the administrative directory pathname, return
the full pathname of the 'Root' file.
Parameters:
adminDirPath - The pathname of the admin ('CVS') directory. |
| getClient | | public CVSClient getClient()(Code) | | Returns the client this project is set to use.
the project's client.
See Also: CVSClient |
| getConnectionMethod | | public int getConnectionMethod()(Code) | | |
| getConnectionPort | | public int getConnectionPort()(Code) | | |
| getDirEntryForLocalDir | | public CVSEntry getDirEntryForLocalDir(String localDir)(Code) | | Given a 'local directory' (in the protocol sense), get the
corresponding directory CVSEntry. This method will return
null if the directory hierarchy has not been "ensured" yet.
Parameters:
localDir - The directory's 'local directory' name. |
| getGzipStreamLevel | | public int getGzipStreamLevel()(Code) | | |
| getLocalRootDirectory | | public String getLocalRootDirectory()(Code) | | |
| getLocalRootPath | | public String getLocalRootPath()(Code) | | Returns the full local pathname for the
root directory of this project.
Full pathname of project's local root directory. |
| getPathIgnoringCase | | CVSEntry getPathIgnoringCase(String subPath)(Code) | | Given a repository path, which was not found in the
pathTable, determine if the path is in the table if
case is ignored. This is to support platforms which
have case insensitive path names.
Parameters:
subPath - The path to check for in the table. The CVSEntry representing the path's directory. |
| getSetVariables | | public String[] getSetVariables()(Code) | | Returns the project's user set variables.
The project's user set variables. |
| hasValidLogin | | public boolean hasValidLogin(String userName)(Code) | | |
| isLocalFileModified | | public boolean isLocalFileModified(CVSEntry entry)(Code) | | |
| isPServer | | public boolean isPServer()(Code) | | |
| isSSHServer | | public boolean isSSHServer()(Code) | | |
| isValidAdminPath | | public static boolean isValidAdminPath(String dirName)(Code) | | Determines if a pathname, provided by the dirName
parameter, is a valid CVS administration directory
(i.e., is a directory named 'CVS').
Parameters:
dirName - the pathname of the directory in question |
| normalizeLocalDirectory | | public String normalizeLocalDirectory(String pathName, String repository)(Code) | | Given a local-directory returned from the server,
make sure the local-directory is in a format that
jCVS can make use of (i.e., via the pathTable).
Currently, the only case handled is when local-directory
is './', which forces us to locate from pathTable.
Parameters:
pathName - The local-directory from the server.
Parameters:
repository - The repository the server sent with this local-directory. The normalized local-directory, or null if it does not exist. |
| pruneEmptySubDirs | | public void pruneEmptySubDirs(boolean saveAdminFiles)(Code) | | |
| readEntries | | public boolean readEntries()(Code) | | |
| readEntriesFile | | public CVSEntryVector readEntriesFile(CVSEntry dirEntry, File workingDirectory)(Code) | |
Parameters:
dirEntry - The entry of the directory being loaded.
Parameters:
workingDirectory - The local file system directory of dirEntry. |
| releaseProject | | public void releaseProject()(Code) | | |
| removeAllEntries | | public void removeAllEntries()(Code) | | |
| rootPathToAdminPath | | public static String rootPathToAdminPath(String dirName)(Code) | | Given a root path, returns the administration directory
path corresponding to root's project.
Parameters:
dirName - the pathname of the root directory |
| setAllowsGzipFileMode | | public void setAllowsGzipFileMode(boolean allow)(Code) | | |
| setConnectionMethod | | public void setConnectionMethod(int method)(Code) | | |
| setConnectionPort | | public void setConnectionPort(int port)(Code) | | |
| setGzipStreamLevel | | public void setGzipStreamLevel(int level)(Code) | | |
| setLocalRootDirectory | | public void setLocalRootDirectory(String dirName)(Code) | | |
| setPServer | | public void setPServer(boolean isPServer)(Code) | | |
| setRepository | | public void setRepository(String repository)(Code) | | |
| setRootDirectory | | public void setRootDirectory(String rootDirectory)(Code) | | |
| setRshProcess | | public void setRshProcess(String rshProcess)(Code) | | |
| setServerCommand | | public void setServerCommand(String command)(Code) | | |
| setSetVariables | | public void setSetVariables(String[] vars)(Code) | | Sets the project's user set variables.
Parameters:
vars - The new user set variables. |
| setStaticDirectory | | public boolean setStaticDirectory(CVSResponseItem item, boolean isSet, boolean writeFile)(Code) | | |
| setTempDirectory | | public void setTempDirectory(String dirName)(Code) | | |
| uiDisplayProgramError | | public void uiDisplayProgramError(String error)(Code) | | |
| uiDisplayProgressMsg | | public void uiDisplayProgressMsg(String message)(Code) | | |
| updateEntriesItem | | public void updateEntriesItem(CVSEntry newEntry)(Code) | | Given an entry, update the entry in our project. If the
entry is new (not found), then add it to our project.
Parameters:
newEntry - The entry to update. |
| verifyAdminDirectory | | public static boolean verifyAdminDirectory(String dirName)(Code) | | Verifies that a directory path is a valid CVS
administration directory. This checks for the
correct name ('CVS'), and that the necessary
files ('Entries', 'Root' and 'Repository') are
present.
Parameters:
dirName - the pathname of the admin directory true if directory is valid, otherwise false |
| writeAdminFiles | | public boolean writeAdminFiles()(Code) | | |
| writeAdminRepositoryFile | | public boolean writeAdminRepositoryFile(File repFile, String repository)(Code) | | |
| writeAdminRootFile | | public boolean writeAdminRootFile(File rootFile, String rootDirectoryStr)(Code) | | |
|
|