Package com.perforce.p4java.server.delegator

Interface IProtectDelegator

All Known Subinterfaces:

IOptionsServer, IServer, IStreamingServer

All Known Implementing Classes:

NtsServerImpl, OneShotServerImpl, ProtectDelegator, RpcServer, Server

public interface IProtectDelegator

Interface to handle the Protect command.

Method Summary

Modifier and Type	Method	Description
java.lang.String	createProtectionEntries(java.util.List<IProtectionEntry> entryList)	Create or replace the protections table data on the Perforce server with these new protection entries.
java.io.InputStream	getProtectionsTable()	Get an InputStream onto the entries of the Perforce protections table.
java.lang.String	updateProtectionEntries(java.util.List<IProtectionEntry> entryList)	Replace the protections table data on the Perforce server with these new protection entries.

Method Detail

createProtectionEntries

java.lang.String createProtectionEntries(@Nonnull
                                         java.util.List<IProtectionEntry> entryList)
                                  throws P4JavaException

Create or replace the protections table data on the Perforce server with these new protection entries.

Each entry in the table contains a protection mode, a group/user indicator, the group/user name, client host ID and a depot file path pattern. Users receive the highest privilege that is granted on any entry.

Warning: this will overwrite the existing protections table data.

Parameters:

entryList - non-null list of protection entries.

Returns:

possibly-null status message string as returned from the server

Throws:

P4JavaException - if an error occurs processing this method and its parameters.

Since:

2011.2

updateProtectionEntries

java.lang.String updateProtectionEntries(@Nonnull
                                         java.util.List<IProtectionEntry> entryList)
                                  throws P4JavaException

Replace the protections table data on the Perforce server with these new protection entries.

Each entry in the table contains a protection mode, a group/user indicator, the group/user name, client host ID and a depot file path pattern. Users receive the highest privilege that is granted on any entry.

Warning: this will overwrite the existing protections table data.

Parameters:

entryList - non-null list of protection entries.

Returns:

possibly-null status message string as returned from the server

Throws:

P4JavaException - if an error occurs processing this method and its parameters.

Since:

2011.2

getProtectionsTable

java.io.InputStream getProtectionsTable()
                                 throws P4JavaException

Get an InputStream onto the entries of the Perforce protections table.

Returns:

a non-null but possibly empty InputStream onto the protections table's entries.

Throws:

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