com.perforce.p4java.server.delegator

Interface IProtectsDelegator

All Known Subinterfaces:

IOptionsServer, IServer, IStreamingServer

All Known Implementing Classes:

NtsServerImpl, OneShotServerImpl, ProtectsDelegator, RpcServer, Server

public interface IProtectsDelegator

Interface to handle the Protects command.

Method Summary

Modifier and Type	Method and Description
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<IProtectionEntry>	getProtectionEntries(List<IFileSpec> fileList, GetProtectionEntriesOptions opts) Get a list of Perforce protection entries for the passed-in arguments.

Method Detail

getProtectionEntries

List<IProtectionEntry> getProtectionEntries(boolean allUsers,
                                            String hostName,
                                            String userName,
                                            String groupName,
                                            List<IFileSpec> fileList)
                                     throws ConnectionException,
                                            RequestException,
                                            AccessException

Get a list of Perforce protection entries for the passed-in arguments.

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.

Parameters:

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.

Returns:

non-null but possibly empty list of protection entries.

Throws:

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.

getProtectionEntries

List<IProtectionEntry> getProtectionEntries(List<IFileSpec> fileList,
                                            GetProtectionEntriesOptions opts)
                                     throws P4JavaException

Get a list of Perforce protection entries for the passed-in arguments.

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 any annotations in the file paths will be ignored. The reason is the Perforce server 'protects' command requires a file list devoid of annotated revision specificity.

Parameters:

fileList - if non-null, only those protection entries that apply to the specified files are displayed.

opts - GetProtectionEntriesOptions object describing optional parameters; if null, no options are set.

Returns:

non-null but possibly empty list of protection entries.

Throws:

P4JavaException - if any error occurs in the processing of this method.