|
| |
|
| java.lang.Object
 com.ice.cvsc.CVSRequest
| CVSRequest | | public class CVSRequest extends Object (Code) | | The CVSRequest class is used to encapsulate a complete
description of a CVS server request. Capable of parsing
a simple string to define a request, CVSRequests are
often built by configuration properties. Once a CVRequest
is built and filled in, it is handed to a CVSClient for
processing. Once the processing is completed, the CVSClient
will return a CVSResponse containing the results of the
request.
version:
$Revision: 2.9 $
author:
Timothy Gerard Endres, .
See Also: CVSClient
See Also: CVSProject |
| Field Summary | |
| final public static int | ES_ALL
| | final public static int | ES_ALLLOST
| | final public static int | ES_ALLMOD
| | final public static int | ES_ALLUNC
| | final public static int | ES_NEW
| | final public static int | ES_NONE
| | final public static int | ES_POPUP
| | final public static int | ES_SEL
| | final public static int | ES_SELALL
| | final public static int | ES_SELLOST
| | final public static int | ES_SELMOD
| | final public static int | ES_SELUNC
| | final public static int | ES_USER
| | final public static int | METHOD_INETD
| | final public static int | METHOD_RSH
| | final public static int | METHOD_SSH
| | final public static String | RCS_ID
| | final public static String | RCS_REV
| | public boolean | allowGzipFileMode
If true, allow gzip-file-contents mode, otherwise suppress it. | | public boolean | allowOverWrites
If true, reponses that try to overwrite existing updated
files will be allowed to overwrite if the file is in the
list of files sent to the server. | | public boolean | displayReponse
Determines if this request should display the reponse. | | public boolean | execInCurDir
This determines where cvs commands are executed. | | public boolean | forceModifieds
Force every file to go up as 'Modified'. | | public boolean | guaranteeMsg
Determines if this request will guarantee a '-m message' argument. | | public boolean | gzipFileMode
If true, send all files using gzip-file-contents mode. | | public int | gzipStreamLevel
If > 0, sets Gzip-stream level. | | public boolean | handleCopyFile
Determines if this request will handle 'Copy-file' responses. | | public boolean | handleEntries
Determines if this request will handle all entries related
responses ('New-entry', 'Remove-entry', etc.). | | public boolean | handleFlags
Determines if this request will handle all settings related
responses ('Set-sticky', 'Clear-static-directory', etc.). | | public boolean | handleMerged
Determines if this request will handle 'Merged' responses. | | public boolean | handleUpdated
Determines if this request will handle 'Updated' responses. | | public boolean | ignoreResult
If true, the reponse's status will be ignored and assumed
to be 'ok'. | | public boolean | includeNotifies
Determines if this request should include the 'Notify' requests. | | public Vector | notifies
The 'Notification' vector. | | public boolean | queueResponse
Determines whether or not the server's reponse is queued.
If true, all responses will be queued and handed back in
the CVSResponse. | | public boolean | redirectOutput
Determines if the output of the reponse (stderr & stdout) will
be redirected to a user specified file. | | public CVSResponseHandler | responseHandler
The response handler. | | public boolean | saveTempFiles
If true, the temporary files generated by this request will
not be deleted as usual. | | public boolean | sendArguments
Determines if this request will send 'Argument 's. | | public boolean | sendEmptyMods
Determines if this request will send the special empty 'Modified'
requests when a file is to be uploaded. | | public boolean | sendEntries
Determines if this request will send the 'Entry' requests. | | public boolean | sendEntryFiles
Determines if this request will send the 'Entry' list as 'files...'. | | public boolean | sendModifieds
Determines if this request will send 'Modified' requests
for files that are modified locally. | | public boolean | sendModule
Determines if this request will send the 'Repository' list as 'module'. | | public boolean | sendRootDirectory
Determines if this request will send the 'RootDirectory'. | | public boolean | staticDirIsSet
Reflects the current 'Static-directory' setting in this request. | | public boolean | stickyIsSet
Reflects the current 'Sticky' setting in this request. | | public boolean | traceProcessing
If true, the processing phase of the CVS command will be
traced on stderr. | | public boolean | traceRequest
If true, the request phase of the CVS command will be
traced on stderr. | | public boolean | traceResponse
If true, the response phase of the CVS command will be
traced on stderr. | | public boolean | traceTCPData
If true, all input and output data (TCP bytes) will be traced. | | public boolean | useDirectory
This is set by the "Valid-requests" cvs request. | | public boolean | useUnchanged
This is set by the "Valid-requests" cvs request. | | public String | validRequests
The 'Valid-requests' response string from the server. | | public boolean | verificationOnly
Determines if this request will only verify the login and then return. |
| Constructor Summary | |
| public | CVSRequest()
Constructs a new CVSRequest object. |
| ES_ALL | | final public static int ES_ALL(Code) | | |
| ES_ALLLOST | | final public static int ES_ALLLOST(Code) | | |
| ES_ALLMOD | | final public static int ES_ALLMOD(Code) | | |
| ES_ALLUNC | | final public static int ES_ALLUNC(Code) | | |
| ES_NEW | | final public static int ES_NEW(Code) | | |
| ES_NONE | | final public static int ES_NONE(Code) | | |
| ES_POPUP | | final public static int ES_POPUP(Code) | | |
| ES_SEL | | final public static int ES_SEL(Code) | | |
| ES_SELALL | | final public static int ES_SELALL(Code) | | |
| ES_SELLOST | | final public static int ES_SELLOST(Code) | | |
| ES_SELMOD | | final public static int ES_SELMOD(Code) | | |
| ES_SELUNC | | final public static int ES_SELUNC(Code) | | |
| ES_USER | | final public static int ES_USER(Code) | | |
| METHOD_INETD | | final public static int METHOD_INETD(Code) | | |
| METHOD_RSH | | final public static int METHOD_RSH(Code) | | |
| METHOD_SSH | | final public static int METHOD_SSH(Code) | | |
| allowGzipFileMode | | public boolean allowGzipFileMode(Code) | | If true, allow gzip-file-contents mode, otherwise suppress it.
|
| allowOverWrites | | public boolean allowOverWrites(Code) | | If true, reponses that try to overwrite existing updated
files will be allowed to overwrite if the file is in the
list of files sent to the server. If false, normal processing
occurs (no overwrites allowed).
|
| displayReponse | | public boolean displayReponse(Code) | | Determines if this request should display the reponse.
|
| execInCurDir | | public boolean execInCurDir(Code) | | This determines where cvs commands are executed.
If true, the command is run in the 'current directory'.
If false, the command is run at the 'top level'.
|
| forceModifieds | | public boolean forceModifieds(Code) | | Force every file to go up as 'Modified'.
|
| guaranteeMsg | | public boolean guaranteeMsg(Code) | | Determines if this request will guarantee a '-m message' argument.
Actually getting the message from the user is the responsibility
of the code that uses the request, since CVSRequests have no clue
about how to get messages.
|
| gzipFileMode | | public boolean gzipFileMode(Code) | | If true, send all files using gzip-file-contents mode.
|
| gzipStreamLevel | | public int gzipStreamLevel(Code) | | If > 0, sets Gzip-stream level. If 0, do not use Gzip-stream mode.
|
| handleCopyFile | | public boolean handleCopyFile(Code) | | Determines if this request will handle 'Copy-file' responses.
|
| handleEntries | | public boolean handleEntries(Code) | | Determines if this request will handle all entries related
responses ('New-entry', 'Remove-entry', etc.).
|
| handleFlags | | public boolean handleFlags(Code) | | Determines if this request will handle all settings related
responses ('Set-sticky', 'Clear-static-directory', etc.).
|
| handleMerged | | public boolean handleMerged(Code) | | Determines if this request will handle 'Merged' responses.
|
| handleUpdated | | public boolean handleUpdated(Code) | | Determines if this request will handle 'Updated' responses.
|
| ignoreResult | | public boolean ignoreResult(Code) | | If true, the reponse's status will be ignored and assumed
to be 'ok'. If false, the reponse's status will be set to
reflect the status returned by the server.
|
| includeNotifies | | public boolean includeNotifies(Code) | | Determines if this request should include the 'Notify' requests.
|
| notifies | | public Vector notifies(Code) | | The 'Notification' vector. If this vector is not null
then it contains a vector if notification strings of the
format: 'File\tType\tTime\tHost\tWorkingDir\tWatches'.
|
| queueResponse | | public boolean queueResponse(Code) | | Determines whether or not the server's reponse is queued.
If true, all responses will be queued and handed back in
the CVSResponse. If false, responses will be handed to the
'responseHandler' for processing as they come from the server.
|
| redirectOutput | | public boolean redirectOutput(Code) | | Determines if the output of the reponse (stderr & stdout) will
be redirected to a user specified file. It is the responsbility
of the code using the request to setup the output file.
|
| responseHandler | | public CVSResponseHandler responseHandler(Code) | | The response handler. If this request does not use the
'queue response' option, then this field must be set to
the CVSResponseHandler that will handle the responses
to this request.
|
| saveTempFiles | | public boolean saveTempFiles(Code) | | If true, the temporary files generated by this request will
not be deleted as usual. This is primarily for debugging.
|
| sendArguments | | public boolean sendArguments(Code) | | Determines if this request will send 'Argument 's.
|
| sendEmptyMods | | public boolean sendEmptyMods(Code) | | Determines if this request will send the special empty 'Modified'
requests when a file is to be uploaded. If true, all 'Modified'
requests send a file size of zero to optimize the protocol when
the file's contents are not needed.
|
| sendEntries | | public boolean sendEntries(Code) | | Determines if this request will send the 'Entry' requests.
|
| sendEntryFiles | | public boolean sendEntryFiles(Code) | | Determines if this request will send the 'Entry' list as 'files...'.
|
| sendModifieds | | public boolean sendModifieds(Code) | | Determines if this request will send 'Modified' requests
for files that are modified locally. If true, modified
files are uploaded via 'Modified'. If false, modified
files are treated as if they were unchanged.
|
| sendModule | | public boolean sendModule(Code) | | Determines if this request will send the 'Repository' list as 'module'.
|
| sendRootDirectory | | public boolean sendRootDirectory(Code) | | Determines if this request will send the 'RootDirectory'.
|
| staticDirIsSet | | public boolean staticDirIsSet(Code) | | Reflects the current 'Static-directory' setting in this request.
|
| stickyIsSet | | public boolean stickyIsSet(Code) | | Reflects the current 'Sticky' setting in this request.
|
| traceProcessing | | public boolean traceProcessing(Code) | | If true, the processing phase of the CVS command will be
traced on stderr.
|
| traceRequest | | public boolean traceRequest(Code) | | If true, the request phase of the CVS command will be
traced on stderr.
|
| traceResponse | | public boolean traceResponse(Code) | | If true, the response phase of the CVS command will be
traced on stderr.
|
| traceTCPData | | public boolean traceTCPData(Code) | | If true, all input and output data (TCP bytes) will be traced.
|
| useDirectory | | public boolean useDirectory(Code) | | This is set by the "Valid-requests" cvs request.
If true, the server understands 'Directory' requests.
|
| useUnchanged | | public boolean useUnchanged(Code) | | This is set by the "Valid-requests" cvs request.
If true, the server understands 'Unchanged' requests.
|
| validRequests | | public String validRequests(Code) | | The 'Valid-requests' response string from the server.
|
| verificationOnly | | public boolean verificationOnly(Code) | | Determines if this request will only verify the login and then return.
|
| CVSRequest | | public CVSRequest()(Code) | | Constructs a new CVSRequest object.
|
| appendArguments | | public void appendArguments(CVSArgumentVector newArgs)(Code) | | Appends an argument list to the request's argument list.
Parameters:
arguments - The list of arguments to append. |
| appendGlobalArguments | | public void appendGlobalArguments(CVSArgumentVector newArgs)(Code) | | Appends an argument list to the request's global argument list.
Parameters:
arguments - The list of arguments to append. |
| endRedirection | | public void endRedirection()(Code) | | |
| getArguments | | public CVSArgumentVector getArguments()(Code) | | Returns the request's argument list as a vector.
The request's argument list. |
| getCheckInProgram | | public String getCheckInProgram()(Code) | | Returns the request's 'Checkin-prog' setting.
The request's 'Checkin-prog' program name. |
| getCommand | | public String getCommand()(Code) | | Returns the request's command name.
The request's command name. |
| getConnMethodName | | public static String getConnMethodName(int method)(Code) | | |
| getConnectionMethod | | public int getConnectionMethod()(Code) | | |
| getEntries | | public CVSEntryVector getEntries()(Code) | | Returns the request's entry list as a vector.
The request's entry list in a CVSEntryVector. |
| getEntrySelector | | public int getEntrySelector()(Code) | | Returns the request's entry selector.
The request's entry selector. |
| getGlobalArguments | | public CVSArgumentVector getGlobalArguments()(Code) | | Returns the request's global argument list as a vector.
The request's argument list. |
| getGzipStreamLevel | | public int getGzipStreamLevel()(Code) | | |
| getHostName | | public String getHostName()(Code) | | Returns the request's server hostname.
The string representing the request's server's hostname. |
| getLocalDirectory | | public String getLocalDirectory()(Code) | | Returns the request's local directory, which represents
the project's local directory.
The request's local directory. |
| getLocalFile | | public File getLocalFile(CVSEntry entry)(Code) | | Returns the request's entry's local file.
The request's entry's local file. |
| getPort | | public int getPort()(Code) | | Returns the request's server port number.
The request's CVS server port number. |
| getRepository | | public String getRepository()(Code) | | Returns the request's repository, which represents
the project's CVS module on the server.
The request's repository. |
| getResponseHandler | | public CVSResponseHandler getResponseHandler()(Code) | | Returns the request's response handler.
The request's response handler. |
| getRootDirectory | | public String getRootDirectory()(Code) | | Returns the request's root directory, which represents
the project's CVS root directory on the server.
The request's root directory. |
| getRootRepository | | public String getRootRepository()(Code) | | Returns the request's ROOT repository. This is the
full repository path to the root entry's directory.
This should match rootEntry.getRepository().
The request's ROOT repository. |
| getSetVariables | | public String[] getSetVariables()(Code) | | Returns the request's user set variables.
The request's user set variables. |
| getStatics | | public Hashtable getStatics()(Code) | | Returns the request's 'Static-directory' settings.
The request's 'Static-directory' settings Hashtable. |
| getStickys | | public Hashtable getStickys()(Code) | | Returns the request's 'Sticky' settings.
The request's 'Sticky' settings Hashtable. |
| getUpdateProgram | | public String getUpdateProgram()(Code) | | Returns the request's 'Update-prog' setting.
The request's 'Update-prog' program name. |
| isPServer | | public boolean isPServer()(Code) | | |
| isRedirected | | public boolean isRedirected()(Code) | | |
| parseArgumentString | | public void parseArgumentString(String argStr)(Code) | | Process a user provided, or command spec based, argument string.
The syntax is '[global options] command options'.
Parameters:
argStr - The argument string to be parsed. |
| parseControlString | | public boolean parseControlString(String specification)(Code) | | Attempts to parse a CVS request specification string. If
the parse succeeds, this request object will be updated
to reflect the request specification, making it ready to
be handed to a CVSClient for processing.
The string is of the format:
:command:select:request:response:arguments
Where:
command - is a valid cvs command name (e.g., 'update', 'co', 'diff')
select - specifies which entries to apply command to
request - is a valid cvs request specification
reponse - is a valid cvs reponse handling specification
arguments - is the remainder of the string taken as command arguments
Refer to the CVSRequest Specification for details.
Parameters:
specification - The CVSRequest Specification string to parse. True if the parse succeeded, false if it failed. |
| parseEntriesSelector | | public static int parseEntriesSelector(char selectCh)(Code) | | |
| setArguments | | public void setArguments(CVSArgumentVector arguments)(Code) | | Sets the request's argument list.
Parameters:
arguments - The new list of argument for this request. |
| setCheckInProgram | | public void setCheckInProgram(String program)(Code) | | Sets the request's 'Checkin-prog' setting.
This does not create or delete the 'Checkin.prog'
administration file. This must be done by the request user.
Parameters:
program - The new checkin-program name. |
| setCommand | | public void setCommand(String command)(Code) | | Sets the request's command.
Parameters:
command - The new command for this request. |
| setConnectionMethod | | public void setConnectionMethod(int method)(Code) | | |
| setEntries | | public void setEntries(CVSEntryVector entries)(Code) | | Sets the request's entry list.
Parameters:
entries - The new list of entries for this request. |
| setGlobalArguments | | public void setGlobalArguments(CVSArgumentVector arguments)(Code) | | Sets the request's global argument list.
Parameters:
arguments - The new list of argument for this request. |
| setGzipStreamLevel | | public void setGzipStreamLevel(int level)(Code) | | |
| setHostName | | public void setHostName(String hostName)(Code) | | Sets the request's server hostname. The hostname
is used to establish the connection with the CVS server.
Parameters:
hostName - The new hostname for the request's CVS Server. |
| setLocalDirectory | | public void setLocalDirectory(String localDirectory)(Code) | | Sets the request's local directory.
Parameters:
localDirectory - The new local directory for the request. |
| setPServer | | public void setPServer(boolean isPServer)(Code) | | |
| setPort | | public void setPort(int port)(Code) | | Sets the request's server port number. The port number
is used to establish the connection with the CVS server.
Parameters:
port - The new port number for the request's CVS server. |
| setRepository | | public void setRepository(String repository)(Code) | | Sets the request's repository (or module name).
Parameters:
repository - The request's repository. |
| setResponseHandler | | public void setResponseHandler(CVSResponseHandler responseHandler)(Code) | | Sets the request's response handler.
Parameters:
repository - The request's response handler. |
| setRootDirectory | | public void setRootDirectory(String rootDirectory)(Code) | | Sets the request's root directory.
Parameters:
rootDirectory - The new root directory for the request. |
| setRootRepository | | public void setRootRepository(String repository)(Code) | | Sets the request's ROOT repository.
Parameters:
repository - The request's ROOT repository. |
| setRshProcess | | public void setRshProcess(String rshProcess)(Code) | | |
| setServerCommand | | public void setServerCommand(String command)(Code) | | |
| setSetVariables | | public void setSetVariables(String[] vars)(Code) | | Sets the request's user set variables.
Parameters:
vars - The new user set variables. |
| setStatics | | public void setStatics(Hashtable statics)(Code) | | Sets the request's 'Static-directory' settings.
Parameters:
statics - The new Hashtable of 'Static-directory' settings. |
| setStickys | | public void setStickys(Hashtable stickys)(Code) | | Sets the request's 'Sticky' settings.
Parameters:
stickys - The new Hashtable of this request's 'Sticky' settings. |
| setUpdateProgram | | public void setUpdateProgram(String program)(Code) | | Sets the request's 'Update-prog' setting.
This does not create or delete the 'Update.prog'
administration file. This must be done by the request user.
Parameters:
program - The new update-program name. |
| toString | | public String toString()(Code) | | Returns a string representation of this request.
String representing request. |
| verifyRequest | | public boolean verifyRequest()(Code) | | Verify the current request. This determines if the request
has enough information to be handed to a CVSClient for
processing. It also makes some sanity checks.
True of the request is valid, false if not.
See Also: CVSRequest.verifyRequest
See Also: CVSRequest.getVerifyFailReason |
|
|
|