Class ProtectDelegator

    • 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.