Package com.perforce.p4java.server.delegator

Interface IExtensionDelegator

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String createExtensionConfig​(IExtension extension, java.lang.String namespace, java.lang.String instanceConfig)
      Creates/updates an extension's global/instance config.
      java.lang.String deleteExtension​(java.lang.String namespace, java.lang.String extnName)
      Deletes an extension along with all of its configuration.
      Extension getExtensionConfig​(java.lang.String namespace, java.lang.String name, java.lang.String instanceName)
      Retrieves an extension/config.
      ExtensionSummary installExtension​(java.lang.String extnPackageName, boolean allowUnsigned)
      Installs extension on p4 server.
      java.util.List<ExtensionSummary> listExtensions​(java.lang.String type)
      Lists extensions or configs based on type.
      java.lang.String packageExtension​(java.lang.String dirName)
      Packages the extension.
      java.lang.String sampleExtension​(java.lang.String extnName)
      Creates sample extension with the given name.
      java.lang.String updateExtensionConfig​(IExtension extension, java.lang.String namespace, java.lang.String instanceConfig)
      Updates an extension's global/instance config.

    • Method Detail

      • sampleExtension

        java.lang.String sampleExtension​(java.lang.String extnName)
                          throws P4JavaException
        Creates sample extension with the given name. As a result a folder extnName will be created with main.lua and manifest.json in it. command: extension [ --sample name ]
        Parameters:
        extnName - - name of the extension
        Returns:
        result
        Throws:
        P4JavaException - on error

      • packageExtension

        java.lang.String packageExtension​(java.lang.String dirName)
                           throws P4JavaException
        Packages the extension. As a result creates a file with .p4-extension in the current folder. command: extension [ --package dir ]
        Parameters:
        dirName - - Directory name containing main.lua and manifest.json for the extension
        Returns:
        result
        Throws:
        P4JavaException - on error

      • installExtension

        ExtensionSummary installExtension​(java.lang.String extnPackageName,
                                  boolean allowUnsigned)
                           throws P4JavaException
        Installs extension on p4 server. command: extension [ --install file [--yes] [--cert] [--allow-unsigned] ]
        Parameters:
        extnPackageName - - Name of the extension package file. For ex. p4java-obliterate-extn.p4-extension
        allowUnsigned - if true
        Returns:
        extension summary
        Throws:
        P4JavaException - on error

      • createExtensionConfig

        java.lang.String createExtensionConfig​(IExtension extension,
                                       java.lang.String namespace,
                                       @Nullable
                                       java.lang.String instanceConfig)
                                throws P4JavaException
        Creates/updates an extension's global/instance config.
        Parameters:
        extension - extension
        namespace - name space
        instanceConfig - - If provided, creates/updates this instance config.
        Returns:
        result
        Throws:
        P4JavaException - on error

      • updateExtensionConfig

        java.lang.String updateExtensionConfig​(IExtension extension,
                                       java.lang.String namespace,
                                       @Nullable
                                       java.lang.String instanceConfig)
                                throws P4JavaException
        Updates an extension's global/instance config.
        Parameters:
        extension - extension
        namespace - name space
        instanceConfig - - If provided updates this instance config.
        Returns:
        result
        Throws:
        P4JavaException - on error

      • listExtensions

        java.util.List<ExtensionSummary> listExtensions​(java.lang.String type)
                                         throws P4JavaException
        Lists extensions or configs based on type.
        Parameters:
        type - - Can be "extensions" or "configs"
        Returns:
        list of extensions
        Throws:
        P4JavaException - on error

      • deleteExtension

        java.lang.String deleteExtension​(java.lang.String namespace,
                                 java.lang.String extnName)
                          throws P4JavaException
        Deletes an extension along with all of its configuration.
        Parameters:
        namespace - name space
        extnName - extension name
        Returns:
        result
        Throws:
        P4JavaException - on error

      • getExtensionConfig

        Extension getExtensionConfig​(java.lang.String namespace,
                             java.lang.String name,
                             @Nullable
                             java.lang.String instanceName)
                      throws P4JavaException
        Retrieves an extension/config.
        Parameters:
        namespace - name space
        name - extension name
        instanceName - Optional, only required for instance config
        Returns:
        extension config
        Throws:
        P4JavaException - on error