Package com.perforce.p4java.core

Interface IExtension

    • Method Detail

      • getExtDescription

        java.lang.String getExtDescription()
        Get the description of the Extension being configured.
        Returns:
        Extension description

      • getExtMaxScriptTime

        java.lang.String getExtMaxScriptTime()
        Get maximum seconds the Extension may be run.
        Returns:
        possibly-null (optional) Maximum seconds

      • getExtMaxScriptMem

        java.lang.String getExtMaxScriptMem()
        Get maximum megabytes the Extension may use.
        Returns:
        possibly-null (optional) Maximum megabytes

      • getOwner

        java.lang.String getOwner()
        Get the user who created this Extension config.
        Returns:
        Owner

      • getUpdate

        java.lang.String getUpdate()
        Get update time for the Extension config spec.
        Returns:
        Update time

      • getDescription

        java.lang.String getDescription()
        Get the description of this Extension config.
        Returns:
        Extension config description

      • getExtConfig

        java.util.Map<java.lang.String,​java.lang.String> getExtConfig()
        Get the extension config.
        Returns:
        Extension config

      • getExtAllowedGroups

        java.util.List<java.lang.String> getExtAllowedGroups()
        Get groups whose members may configure the Extension.
        Returns:
        Allowed groups

      • getExtP4USER

        java.lang.String getExtP4USER()
        Get Perforce user account for the Extension to use.
        Returns:
        User

      • getExtDebug

        java.lang.String getExtDebug()
        Check if extension diagnostics are enabled.
        Returns:
        Extension debug

      • setExtDescription

        void setExtDescription​(java.lang.String extDescription)
        Set the description of the Extension being configured.
        Parameters:
        extDescription - description

      • setExtMaxScriptTime

        void setExtMaxScriptTime​(java.lang.String extMaxScriptTime)
        Set maximum seconds the Extension may be run.
        Parameters:
        extMaxScriptTime - time

      • setExtMaxScriptMem

        void setExtMaxScriptMem​(java.lang.String extMaxScriptMem)
        Set maximum megabytes the Extension may use.
        Parameters:
        extMaxScriptMem - memory

      • setOwner

        void setOwner​(java.lang.String owner)
        Set the user who created this Extension config.
        Parameters:
        owner - owner

      • setUpdate

        void setUpdate​(java.lang.String update)
        Set update time for the Extension config spec.
        Parameters:
        update - date

      • setDescription

        void setDescription​(java.lang.String description)
        Set the description of this Extension config.
        Parameters:
        description - description

      • setExtConfig

        void setExtConfig​(java.util.Map<java.lang.String,​java.lang.String> extConfig)
        Set the extension config.
        Parameters:
        extConfig - config map

      • setExtAllowedGroups

        void setExtAllowedGroups​(java.util.List<java.lang.String> extAllowedGroups)
        Set groups whose members may configure the Extension.
        Parameters:
        extAllowedGroups - groups

      • setExtP4USER

        void setExtP4USER​(java.lang.String extP4USER)
        Set Perforce user account for the Extension to use.
        Parameters:
        extP4USER - Perforce user

      • setExtDebug

        void setExtDebug​(java.lang.String extDebug)
        When the 'ExtDebug' field in the instance config is set to 'tracing' (off of the default of 'none'), every execution of the instance of the Extension will append execution traces to a log file named '.p4-debug-tracing.txt' in the Extension data directory.
        Parameters:
        extDebug - debug