|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IServer
Provides an interface onto a Perforce SCM server.
This is the main interface for Perforce services that are typically Perforce client workspace-independent, or that affect entire Perforce depots or servers. Some of these services are also available through various client, job, changelist, etc., interfaces methods, but in general, most Perforce services are always available through methods on this interface as well.
IServer interfaces for specific Perforce servers are issued by the P4Javs server factory class, ServerFactory; the factory can return interfaces that use a small variety of communication protocols to access the Perforce server.
ServerFactory
Method Summary | |
---|---|
void |
connect()
Connect to the Perforce server associated with this server object. |
String |
createBranchSpec(IBranchSpec branchSpec)
Create a new Perforce branch spec on the Perforce server. |
String |
createClient(IClient newClient)
Attempt to create a new Perforce client (a.k.a. |
IJob |
createJob(Map<String,Object> fieldMap)
Create a new Perforce job in the Perforce server corresponding to the passed-in Perforce job fields (which in turn should correspond to at least the mandatory fields defined in the reigning Perforce job spec). |
String |
createLabel(ILabel label)
Create a new Perforce label in the Perforce server. |
String |
createUser(IUser user,
boolean force)
Create a new Perforce user on the Perforce server. |
String |
createUserGroup(IUserGroup group)
Create a new Perforce user group on the Perforce server. |
String |
deleteBranchSpec(String branchSpecName,
boolean force)
Delete a named Perforce branch spec from the Perforce server. |
String |
deleteClient(String clientName,
boolean force)
Delete a Perforce client from a Perforce server. |
void |
deleteCounter(String counterName,
boolean perforceCounter)
|
String |
deleteJob(String jobId)
Delete a job from the Perforce server. |
String |
deleteLabel(String labelName,
boolean force)
Delete a named Perforce label from the Perforce server. |
String |
deletePendingChangelist(int id)
Delete a pending Perforce changelist. |
String |
deleteUser(String userName,
boolean force)
Delete a named Perforce user from the Perforce server. |
String |
deleteUserGroup(IUserGroup group)
Delete a Perforce user group from the Perforce server. |
void |
disconnect()
Disconnect from this Perforce server. |
Map<String,Object>[] |
execInputStringMapCmd(String cmdName,
String[] cmdArgs,
String inString)
Issue an arbitrary P4Java command to the Perforce server and return the results as a map. |
void |
execInputStringStreamingMapComd(String cmdName,
String[] cmdArgs,
String inString,
IStreamingCallback callback,
int key)
Deprecated. As of release 2013.1, replaced by IOptionsServer.execInputStringStreamingMapCmd(java.lang.String, java.lang.String[], java.lang.String, com.perforce.p4java.server.callback.IStreamingCallback, int) |
Map<String,Object>[] |
execMapCmd(String cmdName,
String[] cmdArgs,
Map<String,Object> inMap)
Issue an arbitrary P4Java command to the Perforce server and return the results as a map. |
Map<String,Object>[] |
execQuietMapCmd(String cmdName,
String[] cmdArgs,
Map<String,Object> inMap)
Issue an arbitrary P4Java command to the Perforce server and return the results as a map without invoking any command callbacks. |
InputStream |
execQuietStreamCmd(String cmdName,
String[] cmdArgs)
Issue an arbitrary P4Java command to the Perforce server and get the results as a stream without invoking any command callbacks. |
InputStream |
execStreamCmd(String cmdName,
String[] cmdArgs)
Issue an arbitrary P4Java command to the Perforce server and get the results as a stream. |
void |
execStreamingMapCommand(String cmdName,
String[] cmdArgs,
Map<String,Object> inMap,
IStreamingCallback callback,
int key)
Issue a streaming map command to the Perforce server, using an optional map for any input expected by the server (such as label or job specs, etc.). |
List<IFix> |
fixJobs(List<String> jobIdList,
int changeListId,
String status,
boolean delete)
Mark each named job as being fixed by the changelist number given with changeListId. |
String |
getAuthTicket()
Return the current Perforce authentication ticket being used by this server, if any. |
IBranchSpec |
getBranchSpec(String name)
Get a specific named Perforce branch spec from the Perforce server. |
List<IBranchSpecSummary> |
getBranchSpecs(String userName,
String nameFilter,
int maxReturns)
Get a list of all summary Perforce branch specs known to the Perforce server. |
IChangelist |
getChangelist(int id)
Get a specific Perforce changelist from a Perforce server. |
InputStream |
getChangelistDiffs(int id,
DiffType diffType)
Get an InputStream onto the file diffs associated with a specific submitted changelist. |
InputStream |
getChangelistDiffsStream(int id,
DescribeOptions options)
Get an InputStream onto the file diffs associated with a specific submitted changelist. |
List<IFileSpec> |
getChangelistFiles(int id)
Get a list of the Perforce depot files associated with a Perforce changelist. |
List<IChangelistSummary> |
getChangelists(int maxMostRecent,
List<IFileSpec> fileSpecs,
String clientName,
String userName,
boolean includeIntegrated,
boolean submittedOnly,
boolean pendingOnly,
boolean longDesc)
An omnibus method to get a list of Perforce changelists from a server using zero or more qualifiers (note that convenience methods also exists, especially on the IClient interface). |
List<IChangelistSummary> |
getChangelists(int maxMostRecent,
List<IFileSpec> fileSpecs,
String clientName,
String userName,
boolean includeIntegrated,
IChangelist.Type type,
boolean longDesc)
An omnibus method to get a list of Perforce changelists from a server using zero or more qualifiers (note that convenience methods also exists, especially on the IClient interface). |
String |
getCharsetName()
Get the current charset name for the server connection. |
IClient |
getClient(IClientSummary clientSummary)
Convenience method for getClient(clientSummary.getName()). |
IClient |
getClient(String clientName)
Get an IClient object for a specific named Perforce client. |
List<IClientSummary> |
getClients(String userName,
String queryString,
int maxResults)
Get a list of IClientSummary objects for all Perforce clients known to this Perforce server. |
IClient |
getClientTemplate(String clientName)
Get a template of a non-existent named Perforce client. |
IClient |
getClientTemplate(String clientName,
boolean allowExistent)
Get a template of a non-existent named Perforce client. |
String |
getCounter(String counterName)
Get the value of a named Perforce counter from the Perforce server. |
Map<String,String> |
getCounters()
Get a map of the Perforce server's counters. |
IClient |
getCurrentClient()
Return the Perforce client currently associated with this Perforce server, if any. |
List<IDbSchema> |
getDbSchema(List<String> tableSpecs)
Get the database schema associated with this server (admin / superuser command). |
List<IFileSpec> |
getDepotFiles(List<IFileSpec> fileSpecs,
boolean allRevs)
List all Perforce depot files known to the Perforce server that conform to the passed-in wild-card file specification(s). |
List<IDepot> |
getDepots()
Get a list of all Perforce depots known to this Perforce server. |
List<IFileSpec> |
getDirectories(List<IFileSpec> fileSpecs,
boolean clientOnly,
boolean deletedOnly,
boolean haveListOnly)
List any directories matching the passed-in file specifications. |
List<Map<String,Object>> |
getExportRecords(boolean useJournal,
long maxRecs,
int sourceNum,
long offset,
boolean format,
String journalPrefix,
String filter)
Get a list of exported journal or checkpoint records (admin / superuser command). |
List<IExtendedFileSpec> |
getExtendedFiles(List<IFileSpec> fileSpecs,
int maxFiles,
int sinceChangelist,
int affectedByChangelist,
FileStatOutputOptions outputOptions,
FileStatAncilliaryOptions ancilliaryOptions)
Return a list of everything Perforce knows about a possibly very large set of Perforce files. |
List<IFileAnnotation> |
getFileAnnotations(List<IFileSpec> fileSpecs,
DiffType wsOpts,
boolean allResults,
boolean useChangeNumbers,
boolean followBranches)
Get a list of revision annotations for the specified files. |
InputStream |
getFileContents(List<IFileSpec> fileSpecs,
boolean allrevs,
boolean noHeaderLine)
Return an InputStream onto the contents of one or more revisions of one or more Perforce depot file contents. |
List<IFileDiff> |
getFileDiffs(IFileSpec file1,
IFileSpec file2,
String branchSpecName,
DiffType diffType,
boolean quiet,
boolean includeNonTextDiffs,
boolean gnuDiffs)
Run diff on the Perforce server of two files in the depot. |
List<IFix> |
getFixList(List<IFileSpec> fileSpecs,
int changeListId,
String jobId,
boolean includeIntegrations,
int maxFixes)
Return a list of all Perforce jobs with fix records associated with them, along with the changelist number of the fix. |
List<IChangelist> |
getInterchanges(IFileSpec fromFile,
IFileSpec toFile,
boolean showFiles,
boolean longDesc,
int maxChangelistId)
Get a list of changes and / or associated files not yet integrated (unsupported). |
List<IChangelist> |
getInterchanges(String branchSpecName,
List<IFileSpec> fromFileList,
List<IFileSpec> toFileList,
boolean showFiles,
boolean longDesc,
int maxChangelistId,
boolean reverseMapping,
boolean biDirectional)
Get a list of changes and / or associated files not yet integrated, based on branchspecs (unsupported). |
IJob |
getJob(String jobId)
Get a specific job. |
List<IJob> |
getJobs(List<IFileSpec> fileSpecs,
int maxJobs,
boolean longDescriptions,
boolean reverseOrder,
boolean includeIntegrated,
String jobView)
Return a list of Perforce jobs. |
IJobSpec |
getJobSpec()
Return the Perforce jobspec associated with this Perforce server. |
String[] |
getKnownCharsets()
Return an array of strings representing "known" charsets (e.g. |
ILabel |
getLabel(String labelName)
Get a specific named Perforce label. |
List<ILabelSummary> |
getLabels(String user,
int maxLabels,
String nameFilter,
List<IFileSpec> fileList)
Get a list of Perforce labels, optionally tied to a specific set of files. |
String |
getLoginStatus()
Return a string indicating the current login status; corresponds to the p4 login -s command. |
List<IFileSpec> |
getOpenedFiles(List<IFileSpec> fileSpecs,
boolean allClients,
String clientName,
int maxFiles,
int changeListId)
If one or more Perforce file specs is passed-in, return the opened / locked status of each file (if known) within an IFileSpec object; otherwise return a list of all files known to be open for this Perforce client workspace. |
Properties |
getProperties()
Return the Java properties associated with this server. |
List<IProtectionEntry> |
getProtectionEntries(boolean allUsers,
String hostName,
String userName,
String groupName,
List<IFileSpec> fileList)
Get a list of Perforce protection entries for the passed-in arguments. |
List<IUserSummary> |
getReviews(int changelistId,
List<IFileSpec> fileSpecs)
Get a list of all users who have subscribed to review the named files, the files in the numbered changelist, or all files by default. |
Map<IFileSpec,List<IFileRevisionData>> |
getRevisionHistory(List<IFileSpec> fileSpecs,
int maxRevs,
boolean contentHistory,
boolean includeInherited,
boolean longOutput,
boolean truncatedLongOutput)
Get the revision history data for one or more Perforce files. |
InputStream |
getServerFileDiffs(IFileSpec file1,
IFileSpec file2,
String branchSpecName,
DiffType diffType,
boolean quiet,
boolean includeNonTextDiffs,
boolean gnuDiffs)
Run diff on the Perforce server of two files in the depot. |
IServerInfo |
getServerInfo()
Return a snapshot set of data on the Perforce server associated with this server interface. |
List<IServerProcess> |
getServerProcesses()
Return a list of Perforce server processes active on the Perforce server. |
int |
getServerVersionNumber()
Get the Perforce version number of the Perforce server associated with this IServer object, if any. |
ServerStatus |
getStatus()
Return the current status of this server object. |
List<IFileSpec> |
getSubmittedIntegrations(List<IFileSpec> fileSpecs,
String branchSpec,
boolean reverseMappings)
Get a list of submitted integrations for the passed-in filespecs. |
IUser |
getUser(String userName)
Get the user details of a specific Perforce user from the Perforce server. |
IUserGroup |
getUserGroup(String name)
Get the named Perforce user group. |
List<IUserGroup> |
getUserGroups(String userOrGroupName,
boolean indirect,
boolean displayValues,
int maxGroups)
Get a list of Perforce user groups from the server. |
String |
getUserName()
Return the user name currently associated with this server, if any. |
List<IUserSummary> |
getUsers(List<String> userList,
int maxUsers)
Get a list of Perforce users known to this Perforce server. |
String |
getWorkingDirectory()
Get the underlying server's notion of the current working directory. |
boolean |
isCaseSensitive()
Returns whether the Perforce server associated with this IServer object is case sensitive. |
boolean |
isConnected()
Return true iff and the server object is connected to the associated Perforce server. |
void |
login(String password)
Convenience method for login(password, false). |
void |
login(String password,
boolean allHosts)
Log the current user (if any) in to a Perforce server, optionally arranging to be logged in for all hosts. |
void |
logout()
Log the current Perforce user out of a Perforce server session. |
List<IFileSpec> |
moveFile(int changelistId,
boolean listOnly,
boolean noClientMove,
String fileType,
IFileSpec fromFile,
IFileSpec toFile)
Move a file already opened for edit or add (the fromFile) to the destination file (the toFile). |
ICommandCallback |
registerCallback(ICommandCallback callback)
Register a P4Java command callback with this Perforce server. |
IProgressCallback |
registerProgressCallback(IProgressCallback callback)
Register a P4Java command progress callback with this Perforce server. |
ISSOCallback |
registerSSOCallback(ISSOCallback callback,
String ssoKey)
Register a Perforce Single Sign On (SSO) callback and key for this server. |
void |
setAuthTicket(String authTicket)
Set the server's Perforce authentication ticket to the passed-in string. |
boolean |
setCharsetName(String charsetName)
Set the Perforce server's charset to the passed-in charset name. |
void |
setCounter(String counterName,
String value,
boolean perforceCounter)
|
void |
setCurrentClient(IClient client)
Set the Perforce client associated with this server. |
void |
setUserName(String userName)
Set the Perforce user name to be used with this server. |
void |
setWorkingDirectory(String dirPath)
Set the Perforce server's idea of each command's working directory. |
boolean |
supportsSmartMove()
Return true IFF the underlying Perforce server supports the new 2009.1 and later "smart move" command. |
boolean |
supportsUnicode()
Return true if the underlying Perforce server supports Unicode (and is connected). |
List<IFileSpec> |
tagFiles(List<IFileSpec> fileSpecs,
String labelName,
boolean listOnly,
boolean delete)
Tag files with a Perforce label. |
String |
updateBranchSpec(IBranchSpec branchSpec)
Update a Perforce branch spec on the Perforce server. |
String |
updateClient(IClient client)
Update an existing Perforce client on the current Perforce server. |
String |
updateJob(IJob job)
Update a Perforce job on the Perforce server. |
String |
updateLabel(ILabel label)
Update an existing Perforce label in the Perforce server. |
String |
updateUser(IUser user,
boolean force)
Update a Perforce user on the Perforce server. |
String |
updateUserGroup(IUserGroup group,
boolean updateIfOwner)
Update a Perforce user group on the Perforce server. |
Method Detail |
---|
Properties getProperties()
ICommandCallback registerCallback(ICommandCallback callback)
See the ICommandCallback javadocs for callback semantics. Note that only one command callback can be active and registered for a given server at any one time.
callback
- ICommandCallback object to be registered; if null, command
callbacks are disabled.
IProgressCallback registerProgressCallback(IProgressCallback callback)
See the IProgressCallback javadocs for callback semantics. Note that only one progress callback can be active and registered for a given server at any one time.
callback
- IProgressCallback object to be registered; if null, progress
callbacks are disabled.
ISSOCallback registerSSOCallback(ISSOCallback callback, String ssoKey)
See the ISSOCallback Javadoc comments for an explanation of the SSO callback feature; note that only one SSO callback can be active and registered for a given P4Jserver object at any one time.
Note that SSO callbacks work only with the (default) pure Java (RPC) protocol implementation.
callback
- ISSOCallback object to be registered; if null, SSO
callbacks are disabled.ssoKey
- opaque string to be passed untouched to the callback; can
be null, in which case null is passed in to the callback
ServerStatus getStatus()
boolean setCharsetName(String charsetName) throws UnsupportedCharsetException
charsetName
- charset name; if null, resets the charset to "no charset".
UnsupportedCharsetException
- if the Perforce server doesn't
support or recognize the charset name.String getCharsetName()
int getServerVersionNumber()
boolean isCaseSensitive()
boolean supportsUnicode() throws ConnectionException, RequestException, AccessException
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerboolean supportsSmartMove() throws ConnectionException, RequestException, AccessException
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString[] getKnownCharsets()
Note that in this context, "known" simply means that Perforce servers supported by this API can potentially recognize the charset name and (hopefully) act accordingly.
Charset support in Perforce is described in more detail in the main p4 command documentation; in summary, although the list returned here is comprehensive and quite impressive, unless the Perforce server is actually primed to cope with Unicode (which, by default, they're not), the only charset listed here that will work is "none"; furthermore, actual charset support is somewhat idiosyncratic -- please refer to specific documentation for guidance with this. You probably need to use this method in conjunction with the supportsUnicode() method above.
void setUserName(String userName)
Note that the auth ticket (if available) for this user will also be set to this server instance.
userName
- Perforce user name; can be null, which is interpreted
as "don't associate a user name with this server".void setAuthTicket(String authTicket)
No checking is performed on the passed-in ticket, and any changes to existing tickets can cause authentication failures, so you should ensure the passed-in ticket is valid and makes sense for the current context.
authTicket
- possibly-null Perforce authentication ticketString getAuthTicket()
void setWorkingDirectory(String dirPath)
Note: no checking is done at call time for correctness (or otherwise) of the passed-in path.
dirPath
- absolute path of directory to be used, or nullString getWorkingDirectory()
String getUserName()
void connect() throws ConnectionException, AccessException, RequestException, ConfigException
This method's detailed semantics depend on the underlying transport implementation, but in general, it's intended to be called before any attempt is made to issue a command to the associated Perforce server. It's also intended to be called after any (intentional or accidental) disconnect.
Note that certain implementations may try to request a client, etc., on connection (in response to property values passed in through the URL, etc.), which may cause a RequestException to be generated.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
AccessException
- if the Perforce server denies access to the caller
RequestException
- if the Perforce server encounters an error during
its processing of the request
ConfigException
- if local I/O exception occursboolean isConnected()
The meaning of "connected" is generally dependent on the underlying transport layer, but in general, if the server is not connected, issuing server commands to the associated Perforce server will fail with a connection exception.
void disconnect() throws ConnectionException, AccessException
This command should be run at the point at which this server is not going to be used any more, and attempts to disconnect from the associated server. "Disconnect" here has different meanings according to the underlying transport mechanism, but in practice it will mean that attempting to use this server object to issue Perforce commands will fail, usually with a ConnectionException exception.
ConnectionException
AccessException
void login(String password, boolean allHosts) throws ConnectionException, RequestException, AccessException, ConfigException
Attempts to log in to the underlying Perforce server. If successful, successive calls to server-side services will succeed until the session is terminated by the server or the user logs out.
Behaviour is undefined if the server's user name attribute is null (but will probably cause a NullPointerError with most implementations).
Login will work with the Perforce SSO (single sign-on) scheme: in this case your password should be null, and the environment variable P4LOGINSSO should point to an executable SSO script as described in p4 help undoc (help for this is beyond the scope of this method doc, unfortunately, and the feature is not well tested here, but it "works" in general...).
password
- Perforce password; can be null if no password is needed (as
in the case of SSO logins)allHosts
- if true, perform the equivalent of a "login -a"
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the caller
ConfigException
- if the p4tickets file could not be updated successfullyvoid login(String password) throws ConnectionException, RequestException, AccessException, ConfigException
password
- Perforce password; can be null if no password is needed (as
in the case of SSO logins)
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the caller
ConfigException
- if the p4tickets file could not be updated successfullyString getLoginStatus() throws P4JavaException
P4JavaException
- if any errors occur during the processing of
this command.void logout() throws ConnectionException, RequestException, AccessException, ConfigException
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the caller
ConfigException
- if the p4tickets file could not be updated successfullyIServerInfo getServerInfo() throws ConnectionException, RequestException, AccessException
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IDepot> getDepots() throws ConnectionException, RequestException, AccessException
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerIUser getUser(String userName) throws ConnectionException, RequestException, AccessException
userName
- if null, get the current user details, otherwise use the
passed-in user name.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString createUser(IUser user, boolean force) throws ConnectionException, RequestException, AccessException
user
- non-null IUser defining the new user to be created.force
- if true, force the creation of any named user; requires admin
privileges,
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString updateUser(IUser user, boolean force) throws ConnectionException, RequestException, AccessException
user
- non-null IUser defining the user to be updatedforce
- if true, force update for users other than the caller. Requires
super user / admin privileges (enforced by the server).
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString deleteUser(String userName, boolean force) throws ConnectionException, RequestException, AccessException
userName
- non-null name of the user to be deleted.force
- if true, force deletion for users other than the caller. Requires
super user / admin privileges (enforced by the server).
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IUserSummary> getUsers(List<String> userList, int maxUsers) throws ConnectionException, RequestException, AccessException
Note that this implementation differs a bit from the p4 command line version in that it simply doesn't return any output for unmatched users.
userList
- if non-null, restrict output to users matching the passed-in
list of users.maxUsers
- if positive, only return the first maxUsers users.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IUserGroup> getUserGroups(String userOrGroupName, boolean indirect, boolean displayValues, int maxGroups) throws ConnectionException, RequestException, AccessException
Note that the Perforce server considers it an error to have both indirect and displayValues parameters set true; this will cause the server to throw a RequestException with an appropriate usage message.
userOrGroupName
- if non-null, restrict the list to the specified group or username.indirect
- if true, also displays groups that the specified user or group belongs
to indirectly via subgroups.displayValues
- if true, display the MaxResults, MaxScanRows, MaxLockTime,
and Timeout values for the named group.maxGroups
- if > 0, display only the first m results.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request.
AccessException
- if the Perforce server denies access to the caller.IUserGroup getUserGroup(String name) throws ConnectionException, RequestException, AccessException
name
- non-null group name.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request.
AccessException
- if the Perforce server denies access to the caller.String createUserGroup(IUserGroup group) throws ConnectionException, RequestException, AccessException
group
- non-null IUserGroup to be created.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request.
AccessException
- if the Perforce server denies access to the caller.String updateUserGroup(IUserGroup group, boolean updateIfOwner) throws ConnectionException, RequestException, AccessException
group
- non-null user group to be updated.updateIfOwner
- if true, allows a user without 'super'
access to modify the group only if that user is an
'owner' of that group.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request.
AccessException
- if the Perforce server denies access to the caller.String deleteUserGroup(IUserGroup group) throws ConnectionException, RequestException, AccessException
group
- non-null group to be deleted.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request.
AccessException
- if the Perforce server denies access to the caller.List<IProtectionEntry> getProtectionEntries(boolean allUsers, String hostName, String userName, String groupName, List<IFileSpec> fileList) throws ConnectionException, RequestException, AccessException
Note that the behavior of this method is unspecified when using clashing options (e.g. having both userName and groupName set non-null). Consult the main Perforce admin documentation for semantics and usage.
Note that the annotations in the file paths will be dropped. The reason is the Perforce server 'protects' command requires a file list devoid of annotated revision specificity.
allUsers
- if true, protection lines for all users are displayed.hostName
- only protection entries that apply to the given host (IP address)
are displayed.userName
- protection lines Perforce user "userName" are displayed.groupName
- protection lines for Perforce group "groupName" are displayed.fileList
- if non-null, only those protection entries that apply to the
specified files are displayed.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request.
AccessException
- if the Perforce server denies access to the caller.List<IClientSummary> getClients(String userName, String queryString, int maxResults) throws ConnectionException, RequestException, AccessException
Note that this method returns light-weight IClientSummary objects rather than full IClient objects; if you need the heavy-weight IClient objects, you should use getClient(). Note also that the returned IClient objects are not "complete", in the sense that implementations are free to leave certain attributes null for performance reasons. In general, at least the client's name, root, description, last modification time are guaranteed correct.
userName
- if not null, restrict listings to clients owned by the user 'userName'queryString
- if not null, limits output to clients whose name matches the query
pattern passed-in.
Note this option does not work for earlier Perforce servers.maxResults
- if > 0, restrict output to the first maxResults results.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<ILabelSummary> getLabels(String user, int maxLabels, String nameFilter, List<IFileSpec> fileList) throws ConnectionException, RequestException, AccessException
Note that the ILabel objects returned here do not have views associated with them (i.e. the getViewMapping() method will return an empty list. If you need to get the view mapping for a specific label, use the getLabel() method.
user
- if non-null, limit labels to those owned by the named usermaxLabels
- if larger than zero, return only the first maxLabels
(or fewer) qualifying labelsnameFilter
- if not null, limits output to labels whose name matches
the nameFilter pattern, e.g. -e 'svr-dev-rel*'fileList
- if not null, limits its report to labels that contain those files
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerILabel getLabel(String labelName) throws ConnectionException, RequestException, AccessException
Unlike the getLabelList method, the getViewMapping method on the returned label will be valid. Note though that changes to the returned label or its view will not be reflected on to the server unless the updateLabel method is called with the label as an argument.
labelName
- non-null label name
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString createLabel(ILabel label) throws ConnectionException, RequestException, AccessException
label
- non-null ILabel to be saved
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString updateLabel(ILabel label) throws ConnectionException, RequestException, AccessException
label
- non-null ILabel to be updated
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString deleteLabel(String labelName, boolean force) throws ConnectionException, RequestException, AccessException
labelName
- non-null label nameforce
- if true, forces the deletion of any label; normally labels
can only be deleted by their owner
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IFileSpec> tagFiles(List<IFileSpec> fileSpecs, String labelName, boolean listOnly, boolean delete) throws ConnectionException, RequestException, AccessException
fileSpecs
- non-null list of files to be tagged.labelName
- non-null label name to use for the tagging.listOnly
- if true, don't do the actual tag, just return the list of files that
would have been tagged.delete
- if true, delete the label tag from the files.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IBranchSpecSummary> getBranchSpecs(String userName, String nameFilter, int maxReturns) throws ConnectionException, RequestException, AccessException
Note that the IBranchSpecSummary objects returned here do not have branch view specs; you must call the getBranchSpec method on a specific branch to get valid view specs for a branch.
userName
- if non-null, limit qualifying branches to those owned by the named user.nameFilter
- if non-null, limits output to branches whose name matches
the nameFilter pattern.maxReturns
- if greater than zero, limit output to the first maxReturns
number of branches.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerIBranchSpec getBranchSpec(String name) throws ConnectionException, RequestException, AccessException
Note that since the Perforce server usually interprets asking for a non-existent branch spec as equivalent to asking for a template for a new branch spec, you will normally always get back a result here. It is best to first use the getBranchSpecList method to see if the branch spec exists, then use this method to retrieve a specific branch spec once you know it exists.
name
- non-null branch name
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString createBranchSpec(IBranchSpec branchSpec) throws ConnectionException, RequestException, AccessException
branchSpec
- non-null branch spec to be created.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString updateBranchSpec(IBranchSpec branchSpec) throws ConnectionException, RequestException, AccessException
branchSpec
- non-null branch spec to be updated.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString deleteBranchSpec(String branchSpecName, boolean force) throws ConnectionException, RequestException, AccessException
branchSpecName
- non-null branch spec nameforce
- if true, forces the deletion of any branch; normally branches
can only be deleted by their owner
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerIClient getCurrentClient()
void setCurrentClient(IClient client) throws ConnectionException, RequestException, AccessException
client
-
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerIClient getClient(String clientName) throws ConnectionException, RequestException, AccessException
Note that (unfortunately) some implementations cannot detect a non-existent client at this stage, and using the client returned in such circumstances may cause errors down the road.
clientName
- non-null Perforce client name.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerIClient getClient(IClientSummary clientSummary) throws ConnectionException, RequestException, AccessException
clientSummary
- non-null Perforce client summary object.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerIClient getClientTemplate(String clientName) throws ConnectionException, RequestException, AccessException
clientName
- non-null Perforce client name.
ConnectionException
- if the Perforce server is unreachable or is not connected.
RequestException
- if the Perforce server encounters an error during its
processing of the request
AccessException
- if the Perforce server denies access to the callerIClient getClientTemplate(String clientName, boolean allowExistent) throws ConnectionException, RequestException, AccessException
clientName
- non-null Perforce client name.allowExistent
- - true to return a client even if it exists
ConnectionException
- if the Perforce server is unreachable or is not connected.
RequestException
- if the Perforce server encounters an error during its
processing of the request
AccessException
- if the Perforce server denies access to the callerString createClient(IClient newClient) throws ConnectionException, RequestException, AccessException
getClient(String)
after this call in order to obtain the full
client spec as the server may fill in defaults for missing fields in the
specified newClient. This method will return a server status message and
will throw an exception if the client was not created for various
reasons. Note that the server status message may have form trigger
output appended or prepended to it.
newClient
- non-null IClient defining the new Perforce client to be
created.
ConnectionException
- if the Perforce server is unreachable or is not connected.
RequestException
- if the Perforce server encounters an error during its
processing of the request
AccessException
- if the Perforce server denies access to the callerString updateClient(IClient client) throws ConnectionException, RequestException, AccessException
client
- non-null IClient defining the Perforce client to be updated
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString deleteClient(String clientName, boolean force) throws ConnectionException, RequestException, AccessException
clientName
- non-null name of the client to be deleted from the server.force
- if true, tell the server to attempt to force the delete regardless of
the consequences. You're on your own with this one...
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IFileSpec> getDepotFiles(List<IFileSpec> fileSpecs, boolean allRevs) throws ConnectionException, AccessException
If client file names are given as file spec arguments the current Perforce client view mapping is used to list the corresponding depot files, if the client and view exist (if not, the results are undefined).
Normally, the head revision of each matching file is listed, but you can change this by specifying specific revisions or revision ranges. If the file spec argument includes a revision, then all files as of that revision are returned. If the file spec argument has a revision range, then only files selected by that revision range are returned, and the highest revision in the range is used for each file. If allRevs is true, all revisions within the specific range, rather than just the highest revision in the range, are returned.
See 'p4 help revisions' for help specifying revisions.
Note that the IFileSpec objects returned will have null client and local path components.
fileSpecs
- a non-null list of one or more IFileSpecs to be used
to qualify Perforce depot filesallRevs
- if true, list all revisions of qualifying files.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
AccessException
- if the Perforce server denies access to the callerList<IFileAnnotation> getFileAnnotations(List<IFileSpec> fileSpecs, DiffType wsOpts, boolean allResults, boolean useChangeNumbers, boolean followBranches) throws ConnectionException, RequestException, AccessException
fileSpecs
- non-null list of file specs to be annotatedwsOpts
- DiffType describing the white space option to be used; if null,
use default (no options), otherwise must be one of the whitespace
options defined by the isWsOption method on DiffType.allResults
- if true, include both deleted files and lines no longer present
at the head revisionuseChangeNumbers
- if true, annotate with change numbers rather than
revision numbers with each linefollowBranches
- if true, follow branches.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IFileSpec> moveFile(int changelistId, boolean listOnly, boolean noClientMove, String fileType, IFileSpec fromFile, IFileSpec toFile) throws ConnectionException, RequestException, AccessException
Note that this operation is not supported on servers earlier than 2009.1; any attempt to use this on earlier servers will result in a RequestException with a suitable message. Similarly, not all underlying IServer implementations will work with this either, and will also result in a suitable RequestException.
Note also that the move command is special in that almost alone among Perforce file-based commands, it does not allow full filespecs with version specifiers; these are currently quietly stripped off in the move command implementation here, which may lead to unexpected behaviour if you pass in specific versions expecting them to be honoured.
changelistId
- if not IChangelist.UNKNOWN, the files are opened in the numbered
pending changelist instead of the 'default' changelist.listOnly
- if true, don't actually perform the move, just return what would
happen if the move was performednoClientMove
- if true, bypasses the client file rename. This option can be
used to tell the server that the user has already renamed a file on
the client. The use of this option can confuse the server if you
are wrong about the client's contents. Only works for 2009.2 and later
servers; earlier servers will produce a RequestException if you set
this true.fileType
- if not null, the file is reopened as that filetype.fromFile
- the original file; must be already open for edit.toFile
- the target file.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IFileSpec> getDirectories(List<IFileSpec> fileSpecs, boolean clientOnly, boolean deletedOnly, boolean haveListOnly) throws ConnectionException, AccessException
fileSpecs
- non-null list of file specificationsclientOnly
- if true, limit the returns to directories that are mapped in
the current Perforce client workspacedeletedOnly
- if true, includes directories with only deleted files.haveListOnly
- if true, lists directories of files on the 'have' list.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
AccessException
- if the Perforce server denies access to the callerList<IChangelistSummary> getChangelists(int maxMostRecent, List<IFileSpec> fileSpecs, String clientName, String userName, boolean includeIntegrated, IChangelist.Type type, boolean longDesc) throws ConnectionException, RequestException, AccessException
Note that if both submittedOnly and pendingOnly are true, the results are implementation-defined.
maxMostRecent
- if positive, restrict the list to the maxMostRecent
most recent changelists.
Implementations are free to ignore this parameter if necessary
(and return all qualifying results).fileSpecs
- if non-empty, limits the results to
changelists that affect the specified files. If the file specification
includes a revision range, limits its results to
submitted changelists that affect those particular revisions.clientName
- if non-null, restrict the results to changelists associated
with the given client.userName
- if non-null, restrict the results to changelists associated
with the given user name.includeIntegrated
- if true, also include any changelists integrated into the
specified files (if any).type
- if non-null, restrict the results to the specified changelist typelongDesc
- if true, produce a non-truncated long version of the description
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IChangelistSummary> getChangelists(int maxMostRecent, List<IFileSpec> fileSpecs, String clientName, String userName, boolean includeIntegrated, boolean submittedOnly, boolean pendingOnly, boolean longDesc) throws ConnectionException, RequestException, AccessException
Note that if both submittedOnly and pendingOnly are true, the results are implementation-defined.
maxMostRecent
- if positive, restrict the list to the maxMostRecent
most recent changelists.
Implementations are free to ignore this parameter if necessary
(and return all qualifying results).fileSpecs
- if non-empty, limits the results to
changelists that affect the specified files. If the file specification
includes a revision range, limits its results to
submitted changelists that affect those particular revisions.clientName
- if non-null, restrict the results to changelists associated
with the given client.userName
- if non-null, restrict the results to changelists associated
with the given user name.includeIntegrated
- if true, also include any changelists integrated into the
specified files (if any).longDesc
- if true, produce a non-truncated long version of the descriptionsubmittedOnly
- if true, restrict the results to submitted changelists only.pendingOnly
- if true, restrict the results to pending changelists only.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerIChangelist getChangelist(int id) throws ConnectionException, RequestException, AccessException
Corresponds fairly well to the p4 command-line command "change -o", and (like "change -o") does not include the associated changelist files (if any) in the returned changelist object -- you must use getChangelistFiles (or similar) to properly populate the changelist for submission, for example.
id
- the Perforce changelist ID; if id is IChangelist.DEFAULT, get the default
changelist for the current client (if available)
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString deletePendingChangelist(int id) throws ConnectionException, RequestException, AccessException
Note: any IChangelist object associated with the given changelist will no longer be valid after this operation, and using that object may cause undefined results or even global disaster -- you must ensure that the object is not used again improperly.
id
- the ID of the Perforce pending changelist to be deleted.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IFileSpec> getChangelistFiles(int id) throws ConnectionException, RequestException, AccessException
The IFileSpec objects returned are not guaranteed to have any fields except depot path, version, and action valid.
Changelists that are pending will not have files visible through this method; you should use the client openedFiles method for retrieving files in that situation.
id
- numeric changelist identifier
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerInputStream getChangelistDiffs(int id, DiffType diffType) throws ConnectionException, RequestException, AccessException
This is one of the guaranteed "live" method on this interface, and will return the diff output as it exists when called (rather than when the underlying implementation object was created). This can be an expensive method to evaluate, and can generate reams and reams (and reams) of output, so don't use it willy-nilly.
Note that unlike the corresponding command-line command, which keeps going in the face of errors by moving on to the next file (or whatever), any errors encountered in this method will cause an exception from this method at the first error, so plan accordingly....
id
- the ID of the target changelistdiffType
- if non-null, describes which type of diff to perform.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerInputStream getChangelistDiffsStream(int id, DescribeOptions options) throws ConnectionException, RequestException, AccessException
This is one of the guaranteed "live" method on this interface, and will return the diff output as it exists when called (rather than when the underlying implementation object was created). This can be an expensive method to evaluate, and can generate reams and reams (and reams) of output, so don't use it willy-nilly.
Note that unlike the corresponding command-line command, which keeps going in the face of errors by moving on to the next file (or whatever), any errors encountered in this method will cause an exception from this method at the first error, so plan accordingly....
id
- the ID of the target changelistoptions
- DescribeOptions behavioural options for method.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerInputStream getFileContents(List<IFileSpec> fileSpecs, boolean allrevs, boolean noHeaderLine) throws ConnectionException, RequestException, AccessException
If file is specified as a Perforce client workspace file name, the client view is used to find the corresponding depot file. If a file argument has a revision, then all files as of that revision are streamed. If a file argument has a revision range, then only files selected by that revision range are streamed, and the highest revision in the range is used for each file. Normally, only the head revision is printed.
The underlying input stream is not guaranteed to support mark() and skip() operations, and in some cases can be absolutely ginormously long it is also not guaranteed to be printable, and will be in the charset encoding stored in the Perforce server.
You should close the InputStreamReader after use in order to release any underlying stream-related resources. Failure to do this may lead to the proliferation of temp files or long-term memory wastage or even leaks.
Note that unlike the corresponding command-line command, which keeps going in the face of errors by moving on to the next file (or whatever), any errors encountered in this method will cause an exception from this method at the first error, so plan accordingly....
fileSpecs
- non-null list of depot or client file specs defining files to be streamedallrevs
- if true, streams all revisions within the specific range, rather
than just the highest revision in the rangenoHeaderLine
- if true, suppresses the initial line that displays the file name
and revision for each file / revision contents
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerMap<IFileSpec,List<IFileRevisionData>> getRevisionHistory(List<IFileSpec> fileSpecs, int maxRevs, boolean contentHistory, boolean includeInherited, boolean longOutput, boolean truncatedLongOutput) throws ConnectionException, AccessException
Behavior is undefined if both longOutput and truncatedLongOutput are true. If both are false, a short form of the description (prepared by the server) is returned.
fileSpecs
- filespecs to be processed; if null or empty,
an empty Map is returned.maxRevs
- if positive, return at most maxRev revisions for each file.includeInherited
- if true, causes inherited file history to be returned as well.longOutput
- if true, return the full descriptions associated with each revisiontruncatedLongOutput
- if true, return only the first 250 characters of each description.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
AccessException
- if the Perforce server denies access to the callerList<IUserSummary> getReviews(int changelistId, List<IFileSpec> fileSpecs) throws ConnectionException, RequestException, AccessException
Note that the returned IUserSummary objects will have null access and update dates associated with them.
changelistId
- if not IChangelist.UNKNOWN, use this changelist ID.fileSpecs
- if not null, use this list as the list of named files rather
than all files.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IFileSpec> getOpenedFiles(List<IFileSpec> fileSpecs, boolean allClients, String clientName, int maxFiles, int changeListId) throws ConnectionException, AccessException
The returned list can be modified with the other arguments as described below.
fileSpecs
- if non-empty, determine the status of the specified
files; otherwise return all qualifying files known to be openallClients
- if true, return results for all known clients rather than the
current client (if any).clientName
- if non-null, return results for the named client only.maxFiles
- if positive, return only the first maxFiles qualifying files.changeListId
- if positive, return only files associated with the given
changelist ID; if IChangelist.DEFAULT, retrieve files open
associated with the default changelist.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
AccessException
- if the Perforce server denies access to the callerList<IExtendedFileSpec> getExtendedFiles(List<IFileSpec> fileSpecs, int maxFiles, int sinceChangelist, int affectedByChangelist, FileStatOutputOptions outputOptions, FileStatAncilliaryOptions ancilliaryOptions) throws ConnectionException, AccessException
This method is not intended for general use, and is not documented in detail here; consult the main Perforce fstat command documentation for detailed help. In particular, the various options are too complex to be described in a few sentences here, and the various option arguments reflect this complexity. Note that setting both sinceChangelist and affectedByChangelist to zero or a positive value will cause usage errors from the server (these are currently intended to be mutually-exclusive options).
This method can be a real server and bandwidth resource hog, and should be used as sparingly as possible; alternatively, try to use it with as narrow a set of file specs as possible.
fileSpecs
- non-null list of Perforce file specification(s)maxFiles
- if positive, restrict the output to the first maxReturns files.
Implementations are free to ignore this parameter if necessary
(and return all qualifying results).sinceChangelist
- if larger than or equal to zero, display only files
affected since the given changelist number; zero is equivalent
to IChangelist.DEFAULT.affectedByChangelist
- if larger than or equal to zero, display only files
affected by the given changelist number; zero is equivalent
to IChangelist.DEFAULT.outputOptions
- if non-null, specifies the oputput options to be usedancilliaryOptions
- if non-null, specifies the ancilliary output options to be used
ConnectionException
- if the Perforce server is unreachable or is not
connected.
AccessException
- if the Perforce server denies access to the callerList<IFileSpec> getSubmittedIntegrations(List<IFileSpec> fileSpecs, String branchSpec, boolean reverseMappings) throws ConnectionException, RequestException, AccessException
fileSpecs
- if null or ommitted, all qualifying depot files are used.branchSpec
- if non-null, only files integrated from the source
to target files in the branch view are shown. Qualified files
are displayed even if they were integrated without using the
branch view itself.reverseMappings
- if true,reverses the mappings in the branch view, with
the target files and source files exchanging place. This requires the
branchSpec to be non-null.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IChangelist> getInterchanges(IFileSpec fromFile, IFileSpec toFile, boolean showFiles, boolean longDesc, int maxChangelistId) throws ConnectionException, RequestException, AccessException
Note that if showFiles is true, the returned files are attached to the associated changelist, and can be retrieved using the getFiles(false) method -- and note that if you call getFiles(true) you will get a refreshed list of all files associated with the changelist, which is probably different from the list associated with the integration.
Note also that if there are no qualifying changes, this method will return an empty list rather than throw an exception; this behaviour is different to that seen with the p4 command line which will throw an exception.
fromFile
- non-null from-file specification.toFile
- non-null to-file specification.showFiles
- if true, show the individual files that would require integration.longDesc
- if true, return a long description in the changelist.maxChangelistId
- if greater than zero, only consider integration
history from changelists at or below the given number
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IChangelist> getInterchanges(String branchSpecName, List<IFileSpec> fromFileList, List<IFileSpec> toFileList, boolean showFiles, boolean longDesc, int maxChangelistId, boolean reverseMapping, boolean biDirectional) throws ConnectionException, RequestException, AccessException
Note that if showFiles is true, the returned files are attached to the associated changelist, and can be retrieved using the getFiles(false) method -- and note that if you call getFiles(true) you will get a refreshed list of all files associated with the changelist, which is probably different from the list associated with the integration.
Note also that if there are no qualifying changes, this method will return an empty list rather than throw an exception; this behaviour is different to that seen with the p4 command line which will throw an exception.
branchSpecName
- non-null, non-empty branch spec name.fromFileList
- if non-null and not empty, and biDirectional is true,
use this as the from file list.toFileList
- if non-null and not empty, use this as the to file list.showFiles
- if true, show the individual files that would require integration.longDesc
- if true, return a long description in the changelist.maxChangelistId
- if greater than zero, only consider integrationreverseMapping
- if true, reverse the mappings in the branch view, with the
target files and source files exchanging place.biDirectional
-
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IJob> getJobs(List<IFileSpec> fileSpecs, int maxJobs, boolean longDescriptions, boolean reverseOrder, boolean includeIntegrated, String jobView) throws ConnectionException, RequestException, AccessException
Note that this method (unlike the main file list methods) throws an exception and stops at the first encountered error.
fileSpecs
- if given, return only jobspecs affecting the given file(s)maxJobs
- if positive, return only up to maxJobs resultslongDescriptions
- if true, return full descriptions, otherwise show
only a subset (typically the first 128 characters, but
this is not guaranteed).reverseOrder
- if true, reverse the normal sort orderincludeIntegrated
- if true, include any fixes made by changelists
integrated into the specified filesjobView
- if non-null, a string in format detailed by "p4 help jobview"
used to restrict jobs to those satisfying the job view expression.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerIJob getJob(String jobId) throws ConnectionException, RequestException, AccessException
jobId
- non-null job Id.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerIJob createJob(Map<String,Object> fieldMap) throws ConnectionException, RequestException, AccessException
Perforce job semantics, field count and layout, etc., are to some extent free-form and specified for each server by the associated job spec (retrievable using the getJobSpec() method below), so map fields are passed to the Perforce server exactly as passed to the create method in the job's field map, so you need to know the field names and semantics given by the associated job spec. This includes setting the relevant job ID field to "new", but otherwise, no checking is done on fields in this method against the job spec (this may be added later).
fieldMap
- non-null field map defining the new job in the Perforce server.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString updateJob(IJob job) throws ConnectionException, RequestException, AccessException
The returned string will contain whatever the Perforce server returned in response to this command; in general, if the update fails, an exception will be thrown, meaning that the returned string represents success only. There are two success states -- either the job was saved or it didn't need saving (it was the same after updating). Consumers should parse this accordingly.
job
- non-null candidate for updating.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerString deleteJob(String jobId) throws ConnectionException, RequestException, AccessException
jobId
- ID of the job to be deleted.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerIJobSpec getJobSpec() throws ConnectionException, RequestException, AccessException
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IFix> getFixList(List<IFileSpec> fileSpecs, int changeListId, String jobId, boolean includeIntegrations, int maxFixes) throws ConnectionException, RequestException, AccessException
Note that this method (unlike the main file list methods) throws an exception and stops at the first encountered error.
fileSpecs
- if given, restrict output to fixes associated with these fileschangeListId
- if positive, only fixes from the numbered changelist are listed.jobId
- if non-null, only fixes for the named job are listedincludeIntegrations
- if true, include any fixes made by changelists integrated
into the specified filesmaxFixes
- if positive, restrict the list to the first maxFixes fixes
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IFix> fixJobs(List<String> jobIdList, int changeListId, String status, boolean delete) throws ConnectionException, RequestException, AccessException
changeListId
- changelist numberstatus
- if non-null, use this as the new status rather than "closed"delete
- if true, delete the specified fixes
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IServerProcess> getServerProcesses() throws ConnectionException, RequestException, AccessException
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerInputStream getServerFileDiffs(IFileSpec file1, IFileSpec file2, String branchSpecName, DiffType diffType, boolean quiet, boolean includeNonTextDiffs, boolean gnuDiffs) throws ConnectionException, RequestException, AccessException
This method corresponds closely to the standard diff2 command, and that command's documentation should be consulted for the overall and detailed semantics. In particular, the various potentially-valid combinations of branch spec and file specs can be complicated and won't be repeated here.
As with other streams-based IServer methods, callers should ensure that the stream returned here is always explicitly closed after use; if not closed, the stream's associated temporary files managed by P4Java (if they exist) may not be properly deleted.
file1
- optional first file IFileSpecfile2
- optional second file IFileSpecbranchSpecName
- optional branch spec namequiet
- if true, suppresses the display of the header lines of files whose
content and types are identical and suppresses the actual diff
for all files.includeNonTextDiffs
- if true, forces 'p4 diff2' to diff even files with
non-text (binary) typesgnuDiffs
- see "-u" option in the main diff2 documentation.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IFileDiff> getFileDiffs(IFileSpec file1, IFileSpec file2, String branchSpecName, DiffType diffType, boolean quiet, boolean includeNonTextDiffs, boolean gnuDiffs) throws ConnectionException, RequestException, AccessException
This method corresponds closely to the standard diff2 command, and that command's documentation should be consulted for the overall and detailed semantics. In particular, the various potentially-valid combinations of branch spec and file specs can be complicated and won't be repeated here.
file1
- optional first file IFileSpecfile2
- optional second file IFileSpecbranchSpecName
- optional branch spec namequiet
- if true, suppresses the display of the header lines of files whose
content and types are identical and suppresses the actual diff
for all files.includeNonTextDiffs
- if true, forces 'p4 diff2' to diff even files with
non-text (binary) typesgnuDiffs
- see "-u" option in the main diff2 documentation.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerMap<String,Object>[] execMapCmd(String cmdName, String[] cmdArgs, Map<String,Object> inMap) throws ConnectionException, RequestException, AccessException
This method is intended for low-level commands in the spirit and format of the p4 command line interpreter, and offers a simple way to issue commands to the associated Perforce server without the overhead of the more abstract Java interfaces and methods.
No guidance is given here on the format of the returned map; however, it produces the same output as the p4 command line interpreter in -G (Python map) mode.
Note that this method does not allow you to set "usage" options for the command; these may be added later. Note also that although option arguments passed to this method must be in a form recognized by the p4 command line interpreter, that does not mean the method is being implemented by the interpreter -- the actual implementation depends on the options used to get the server object in the first place from the server factory.
cmdName
- the command to be issued; must be non-null, and correspond to a Perforce
command recognized by P4Java and defined in CmdSpec.cmdArgs
- the array of command arguments (options and file arguments, etc.) to be
sent to the Perforce server. These must be in the form used by the corresponding
p4 command line interpreter. Ignored if null.inMap
- an optional map to be sent to the server as standard input, using the
Python map format (-G) form. You must remember to issue the relevant
command-specific option to enable this if needed.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerMap<String,Object>[] execInputStringMapCmd(String cmdName, String[] cmdArgs, String inString) throws P4JavaException
This method is intended for low-level commands in the spirit and format of the p4 command line interpreter, and offers a simple way to issue commands to the associated Perforce server without the overhead of the more abstract Java interfaces and methods.
No guidance is given here on the format of the returned map; however, it produces the same output as the p4 command line interpreter in -G (Python map) mode.
Note that this method does not allow you to set "usage" options for the command; these may be added later. Note also that although option arguments passed to this method must be in a form recognized by the p4 command line interpreter, that does not mean the method is being implemented by the interpreter -- the actual implementation depends on the options used to get the server object in the first place from the server factory.
cmdName
- the command to be issued; must be non-null, and correspond to a Perforce
command recognized by P4Java and defined in CmdSpec.cmdArgs
- the array of command arguments (options and file arguments, etc.) to be
sent to the Perforce server. These must be in the form used by the corresponding
p4 command line interpreter. Ignored if null.inString
- an optional string to be sent to the server as standard input unchanged
(this must be in the format expected by the server, typically as required
when using the "-i" flag to the p4 command line app for the same command).
You must remember to issue the relevant
command-specific option to enable this if needed.
P4JavaException
- if an error occurs processing this method and its parametersMap<String,Object>[] execQuietMapCmd(String cmdName, String[] cmdArgs, Map<String,Object> inMap) throws ConnectionException, RequestException, AccessException
Basically equivalent to execMapCmd with temporary disabling of any ICommandCallback calls and / or listeners; this turns out to be useful for various reasons we won't go into here...
cmdName
- the command to be issued; must be non-null, and correspond to a Perforce
command recognized by P4Java and defined in CmdSpec.cmdArgs
- the array of command arguments (options and file arguments, etc.) to be
sent to the Perforce server. These must be in the form used by the corresponding
p4 command line interpreter. Ignored if null.inMap
- an optional map to be sent to the server as standard input, using the
Python map format (-G) form. You must remember to issue the relevant
command-specific option to enable this if needed.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerInputStream execStreamCmd(String cmdName, String[] cmdArgs) throws ConnectionException, RequestException, AccessException
This method is intended for low-level commands in the spirit and format of the p4 command line interpreter, and offers a simple way to issue commands to the associated Perforce server without the overhead of the more abstract Java interfaces and methods.
Note that this method is intended for things like getting file contents, and may have unpredictable results on commands not originally expected to return i/o streams.
Note that this method does not allow you to set "usage" options for the command; these may be added later. Note also that although option arguments passed to this method must be in a form recognized by P4Java (as defined by the CmdSpec enum), that does not mean the method is being implemented by the interpreter -- the actual implementation depends on the options used to get the server object in the first place from the server factory.
cmdName
- the command to be issued; must be non-null, and correspond to a Perforce
command recognized by P4Java and defined in CmdSpec.cmdArgs
- the array of command arguments (options and file arguments, etc.) to be
sent to the Perforce server. These must be in the form used by the corresponding
p4 command line interpreter. Ignored if null.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerInputStream execQuietStreamCmd(String cmdName, String[] cmdArgs) throws ConnectionException, RequestException, AccessException
Basically equivalent to execStreamCmd with temporary disabling of any ICommandCallback calls and / or listeners; this turns out to be useful for various reasons we won't go into here...
cmdName
- the command to be issued; must be non-null, and correspond to a Perforce
command recognized by P4Java and defined in CmdSpec.cmdArgs
- the array of command arguments (options and file arguments, etc.) to be
sent to the Perforce server. These must be in the form used by the corresponding
p4 command line interpreter. Ignored if null.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callervoid execStreamingMapCommand(String cmdName, String[] cmdArgs, Map<String,Object> inMap, IStreamingCallback callback, int key) throws P4JavaException
Streaming commands allow users to get each result from a suitably-issued command as it comes in from the server, rather than waiting for the entire command method to complete (and getting the results back as a completed List or Map or whatever).
The results are sent to the user using the IStreamingCallback handleResult method; see the IStreamingCallback Javadoc for details. The payload passed to handleResult is usually the raw map gathered together deep in the RPC protocol layer, and the user is assumed to have the knowledge and technology to be able to parse it and use it suitably in much the same way as a user unpacks or processes the results from the other low-level exec methods like execMapCommand.
NOTE: 'streaming' here has nothing at all to do with Perforce 'streams', which are (or will be) implemented elsewhere.
cmdName
- the command to be issued; must be non-null, and correspond to a Perforce
command recognized by P4Java and defined in CmdSpec.cmdArgs
- the array of command arguments (options and file arguments, etc.) to be
sent to the Perforce server. These must be in the form used by the corresponding
p4 command line interpreter. Ignored if null.inMap
- an optional map to be sent to the server as standard input, using the
Python map format (-G) form. You must remember to issue the relevant
command-specific option to enable this if needed.callback
- a non-null IStreamingCallback to be used to process the incoming
results.key
- an opaque integer key that is passed to the IStreamingCallback callback
methods to identify the action as being associated with this specific
call.
P4JavaException
- if an error occurs processing this method and its parameters.@Deprecated void execInputStringStreamingMapComd(String cmdName, String[] cmdArgs, String inString, IStreamingCallback callback, int key) throws P4JavaException
IOptionsServer.execInputStringStreamingMapCmd(java.lang.String, java.lang.String[], java.lang.String, com.perforce.p4java.server.callback.IStreamingCallback, int)
Streaming commands allow users to get each result from a suitably-issued command as it comes in from the server, rather than waiting for the entire command method to complete (and getting the results back as a completed List or Map or whatever).
The results are sent to the user using the IStreamingCallback handleResult method; see the IStreamingCallback Javadoc for details. The payload passed to handleResult is usually the raw map gathered together deep in the RPC protocol layer, and the user is assumed to have the knowledge and technology to be able to parse it and use it suitably in much the same way as a user unpacks or processes the results from the other low-level exec methods like execMapCommand.
NOTE: 'streaming' here has nothing at all to do with Perforce 'streams', which are (or will be) implemented elsewhere.
cmdName
- the command to be issued; must be non-null, and correspond to a Perforce
command recognized by P4Java and defined in CmdSpec.cmdArgs
- the array of command arguments (options and file arguments, etc.) to be
sent to the Perforce server. These must be in the form used by the corresponding
p4 command line interpreter. Ignored if null.inString
- an optional string to be sent to the server as standard input unchanged
(this must be in the format expected by the server, typically as required
when using the "-i" flag to the p4 command line app for the same command).
You must remember to issue the relevant
command-specific option to enable this if needed.callback
- a non-null IStreamingCallback to be used to process the incoming
results.key
- an opaque integer key that is passed to the IStreamingCallback callback
methods to identify the action as being associated with this specific
call.
P4JavaException
- if an error occurs processing this method and its parameters.String getCounter(String counterName) throws ConnectionException, RequestException, AccessException
Note that despite their name, counters can be any value, not just a number; hence the string return value here.
counterName
- non-null counter name.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callervoid setCounter(String counterName, String value, boolean perforceCounter) throws ConnectionException, RequestException, AccessException
ConnectionException
RequestException
AccessException
void deleteCounter(String counterName, boolean perforceCounter) throws ConnectionException, RequestException, AccessException
ConnectionException
RequestException
AccessException
Map<String,String> getCounters() throws ConnectionException, RequestException, AccessException
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<IDbSchema> getDbSchema(List<String> tableSpecs) throws ConnectionException, RequestException, AccessException
See the main p4 admin command documentation for full semantics and usage details.
tableSpecs
- if null, return all known schema; otherwise, restrict the returned
list to the named tables and table versions.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the callerList<Map<String,Object>> getExportRecords(boolean useJournal, long maxRecs, int sourceNum, long offset, boolean format, String journalPrefix, String filter) throws ConnectionException, RequestException, AccessException
See the main p4 admin command documentation for full semantics and usage details.
useJournal
- if true, export journal records; otherwise, export checkpoint records.maxRecs
- if larger than zero, return only the first maxRec linessourceNum
- checkpoint or journal number.offset
- offset with in checkpoint or journal.format
- if true, formats record output appropriately for the type of data.journalPrefix
- if not null, specify a journal name prefix.filter
- if not null, pass the specified filter to the exporter.
ConnectionException
- if the Perforce server is unreachable or is not
connected.
RequestException
- if the Perforce server encounters an error during
its processing of the request
AccessException
- if the Perforce server denies access to the caller
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |