com.qumasoft.clientapi
Interface ClientAPIContext


public interface ClientAPIContext

Interface that defines the context for QVCS-Enterprise Client API requests. The implementation of this interface will likely be a java bean style class. The methods defined here define the accessor methods needed.


Method Summary
 java.lang.String getAppendedPath()
          Get the appendedPath.
 java.lang.String getFileName()
          Get the file name.
 java.lang.String getPassword()
          Get the password.
 java.lang.Integer getPort()
          Get the port number where the QVCS-Enterprise server is listening for connections from QVCS-Enterprise clients.
 boolean getPreserveStateFlag()
          Get the preserveState flag.
 java.lang.String getProjectName()
          Get the project name.
 boolean getRecurseFlag()
          Get the recurse flag.
 java.lang.String getServerIPAddress()
          Get the QVCS-Enterprise server IP address.
 java.lang.String getUserName()
          Get the user name.
 java.lang.String getViewName()
          Get the view name.
 void setAppendedPath(java.lang.String appendedPath)
          Set the appended path.
 void setFileName(java.lang.String fileName)
          Set the file name.
 void setPassword(java.lang.String password)
          Set the password.
 void setPort(java.lang.Integer port)
          Set the port number that the QVCS-Enterprise client API will use when attempting to establish a connection to the QVCS-Enterprise server.
 void setPreserveStateFlag(boolean flag)
          Set the preserveState flag.
 void setProjectName(java.lang.String projectName)
          Set the project name.
 void setRecurseFlag(boolean flag)
          Set the recurse flag.
 void setServerIPAddress(java.lang.String serverIPAddress)
          Set the QVCS-Enterprise server IP address.
 void setUserName(java.lang.String userName)
          Set the user name.
 void setViewName(java.lang.String viewName)
          Set the view name.
 

Method Detail

getUserName

java.lang.String getUserName()
Get the user name. This is the user name used to login to the QVCS-Enterprise server.

Returns:
the user name.

setUserName

void setUserName(java.lang.String userName)
Set the user name.

Parameters:
userName - the user name used to login to the QVCS-Enterprise server.

getPassword

java.lang.String getPassword()
Get the password. This is the password for the user name so that the username/password pair can be used to login to the QVCS-Enterprise server.

Returns:
the password.

setPassword

void setPassword(java.lang.String password)
Set the password. This is the password for the user name so that the username/password pair can be used to login to the QVCS-Enterprise server.

Parameters:
password - the password.

getServerIPAddress

java.lang.String getServerIPAddress()
Get the QVCS-Enterprise server IP address. This is the IP address that defines the network location of the QVCS-Enterprise server.

Returns:
the IP address of the QVCS-Enterprise server.

setServerIPAddress

void setServerIPAddress(java.lang.String serverIPAddress)
Set the QVCS-Enterprise server IP address. The QVCS-Enterprise client API will attempt to communicate with the QVCS-Enterprise server located at this IP address.

Parameters:
serverIPAddress - the server IP address.

getPort

java.lang.Integer getPort()
Get the port number where the QVCS-Enterprise server is listening for connections from QVCS-Enterprise clients.

Returns:
the port number.

setPort

void setPort(java.lang.Integer port)
Set the port number that the QVCS-Enterprise client API will use when attempting to establish a connection to the QVCS-Enterprise server. The server should be listening for client connections on this port number.

Parameters:
port - the port number used by the QVCS-Enterprise server to listen for client connections.

getProjectName

java.lang.String getProjectName()
Get the project name.

Returns:
the project name.

setProjectName

void setProjectName(java.lang.String projectName)
Set the project name. This defines the project that you are interested in. The client API requests will request data from the project named here.

Parameters:
projectName - the name of the QVCS-Enterprise project that you are interested in.

getViewName

java.lang.String getViewName()
Get the view name.

Returns:
the view name.

setViewName

void setViewName(java.lang.String viewName)
Set the view name. Typically (and by default), this will be the 'Trunk' view.

Parameters:
viewName - the view that you are interested in.

getAppendedPath

java.lang.String getAppendedPath()
Get the appendedPath.

Returns:
the appended path.

setAppendedPath

void setAppendedPath(java.lang.String appendedPath)
Set the appended path. The 'appended path' identifies the sub-directory of the view that you are interested in. For example, if you are interested in the root directory of a view, then the appended path would be the empty string (e.g. ""); if you are interested in the source/java/com/qumasoft/utility sub-directory, then the appended path would be "source/java/com/qumasoft/utility".

Parameters:
appendedPath - the directory within the view that you are interested in.

getFileName

java.lang.String getFileName()
Get the file name.

Returns:
the file name.

setFileName

void setFileName(java.lang.String fileName)
Set the file name. This should be the file name for an individual file that you are interested in. It should include no directory components at all (the directory component is specified via the setAppendedPath() method).

Parameters:
fileName - the file name.

getRecurseFlag

boolean getRecurseFlag()
Get the recurse flag. This flag is used to determine whether API request applies to just the directory defined by the appended path, or if it applies recursively to include in addition all the directories beneath the appended path directory.

Returns:
the recurse flag.

setRecurseFlag

void setRecurseFlag(boolean flag)
Set the recurse flag. This flag is used to determine whether API request applies to just the directory defined by the appended path, or if it applies recursively to include in addition all the directories beneath the appended path directory.

Parameters:
flag - the value for the recurse flag.

getPreserveStateFlag

boolean getPreserveStateFlag()

Get the preserveState flag. This flag indicates whether calls through the client API are stateless (the default), or stateful. If the calls are stateless, then no state is preserved from one call on the ClientAPI to the next: the client logs in to the server for each call, and logs out from the server when the call is completed. If this flag is set to preserve state (true), then the client api will preserve state across calls when it can. Performance will be better if this flag is set to true. By default, its value is false.

Some calls will force the client to disconnect from the server and state will be discarded. For example, if the preserve state is set to true, and the client performs a getProjectList call followed by a setServerIPAddress call on this class, then state will be lost after the setServerIPAddress call since the server end point has now changed.

Returns:
the current value of the preserveState flag.

setPreserveStateFlag

void setPreserveStateFlag(boolean flag)
Set the preserveState flag. See getPreserveStateFlag for a description of how this flag works. You should set this flag before beginning method calls on the ClientAPI.

Parameters:
flag - the new value for the preserveState flag.