ProtectDelegator (p4java 2023.2.2581742 API)

java.lang.Object
- com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator
- - com.perforce.p4java.impl.mapbased.server.cmd.ProtectDelegator

All Implemented Interfaces:

IProtectDelegator
```
public class ProtectDelegator
extends BaseDelegator
implements IProtectDelegator
```
Implementation to handle the Protect command.

Field Summary
- Fields inherited from class com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator
  MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION

Constructor Summary

Constructors
Constructor and Description
`ProtectDelegator(IOptionsServer server)` Instantiate a new ProtectDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProtectDelegator
```
public ProtectDelegator(IOptionsServer server)
```
    Instantiate a new ProtectDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.
    
    Parameters:
    
    server - a concrete implementation of a Perforce Helix Server
- Method Detail
  - createProtectionEntries
```
public java.lang.String createProtectionEntries(@Nonnull
                                                java.util.List<IProtectionEntry> entryList)
                                         throws P4JavaException
```
    Description copied from interface: IProtectDelegator
    
    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.
    
    Specified by:
    
    createProtectionEntries in interface IProtectDelegator
    
    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.
  - updateProtectionEntries
```
public java.lang.String updateProtectionEntries(@Nonnull
                                                java.util.List<IProtectionEntry> entryList)
                                         throws P4JavaException
```
    Description copied from interface: IProtectDelegator
    
    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.
    
    Specified by:
    
    updateProtectionEntries in interface IProtectDelegator
    
    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.
  - getProtectionsTable
```
public java.io.InputStream getProtectionsTable()
                                        throws P4JavaException
```
    Description copied from interface: IProtectDelegator
    
    Get an InputStream onto the entries of the Perforce protections table.
    
    Specified by:
    
    getProtectionsTable in interface IProtectDelegator
    
    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.

Class ProtectDelegator

Field Summary

Fields inherited from class com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProtectDelegator

Method Detail

createProtectionEntries

updateProtectionEntries

getProtectionsTable