Package com.gradle.maven.extension.api

Interface GradleEnterpriseApi

  • @Deprecated
public interface GradleEnterpriseApi
    Deprecated.
    since 1.21, replaced by DevelocityApi
    Allows to interact with the Develocity Maven extension.
    Since:
    1.10.1

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getAccessKey()
      Deprecated.
      Returns the access key for authenticating with the Develocity server.
      boolean getAllowUntrustedServer()
      Deprecated.
      Whether it is acceptable to communicate with a Develocity server with an untrusted SSL certificate.
      BuildCacheApi getBuildCache()
      Deprecated.
      The build cache API.
      BuildScanApi getBuildScan()
      Deprecated.
      The build scan API.
      java.lang.String getProjectId()
      Deprecated.
      Returns the project identifier.
      java.lang.String getServer()
      Deprecated.
      Returns the URL of the Develocity server.
      java.nio.file.Path getStorageDirectory()
      Deprecated.
      Returns the Develocity Maven extension storage directory.
      boolean isEnabled()
      Deprecated.
      Whether the Develocity Maven extension is enabled.
      void setAccessKey​(java.lang.String accessKey)
      Deprecated.
      Sets the access key for authenticating with the Develocity server.
      void setAllowUntrustedServer​(boolean allow)
      Deprecated.
      Specifies whether it is acceptable to communicate with a Develocity server using an untrusted SSL certificate.
      void setEnabled​(boolean enabled)
      Deprecated.
      Sets whether to enable the Develocity Maven extension.
      void setProjectId​(java.lang.String projectId)
      Deprecated.
      Sets the project identifier.
      default void setServer​(java.lang.String url)
      Deprecated.
      Sets the URL of the Develocity server.
      void setServer​(java.net.URI url)
      Deprecated.
      Sets the URL of the Develocity server.
      void setStorageDirectory​(java.nio.file.Path path)
      Deprecated.
      Sets the Develocity Maven extension storage directory to the specified path.

    • Method Detail

      • isEnabled

        boolean isEnabled()
        Deprecated.
        Whether the Develocity Maven extension is enabled.
        Returns:
        true if the Develocity Maven extension is enabled, false otherwise
        Since:
        1.10.3

      • setEnabled

        void setEnabled​(boolean enabled)
        Deprecated.
        Sets whether to enable the Develocity Maven extension.

        Configuration via the gradle.enterprise.enabled system property will always take precedence.

        Parameters:
        enabled - whether to enable the Develocity Maven extension
        Since:
        1.10.3

      • setProjectId

        void setProjectId​(@Nullable
                  java.lang.String projectId)
        Deprecated.
        Sets the project identifier. The value must not be empty or exceed 256 characters.
        Parameters:
        projectId - the project identifier
        Since:
        1.19

      • getProjectId

        @Nullable
java.lang.String getProjectId()
        Deprecated.
        Returns the project identifier.
        Returns:
        null when no project identifier is configured
        Since:
        1.19

      • getStorageDirectory

        java.nio.file.Path getStorageDirectory()
        Deprecated.
        Returns the Develocity Maven extension storage directory.
        Returns:
        the Develocity Maven extension storage directory.
        Since:
        1.10.1
        See Also:
        Develocity Maven extension documentation.

      • setStorageDirectory

        void setStorageDirectory​(java.nio.file.Path path)
        Deprecated.
        Sets the Develocity Maven extension storage directory to the specified path.

        Configuration via the develocity.storage.directory system property will always take precedence.

        Parameters:
        path - The new storage directory
        Since:
        1.10.1
        See Also:
        Develocity Maven extension documentation.

      • setServer

        default void setServer​(@Nullable
                       java.lang.String url)
        Deprecated.
        Sets the URL of the Develocity server.

        Configuration via the gradle.enterprise.url system property will always take precedence.

        Parameters:
        url - the server URL
        Since:
        1.10.1

      • setServer

        void setServer​(@Nullable
               java.net.URI url)
        Deprecated.
        Sets the URL of the Develocity server.

        Configuration via the gradle.enterprise.url system property will always take precedence.

        Parameters:
        url - the server URL
        Since:
        1.10.3

      • getServer

        @Nullable
java.lang.String getServer()
        Deprecated.
        Returns the URL of the Develocity server.
        Returns:
        null when no Develocity server is configured
        Since:
        1.10.1

      • setAllowUntrustedServer

        void setAllowUntrustedServer​(boolean allow)
        Deprecated.
        Specifies whether it is acceptable to communicate with a Develocity server using an untrusted SSL certificate.

        The default (public) Develocity server uses SSL certificates that are trusted by default by standard modern Java environments. If you are using a different Develocity server, it may use an untrusted certificate. This may be due to the use of an internally provisioned or self-signed certificate.

        In such a scenario, you can either configure the build JVM environment to trust the certificate, or call this method with true to disable verification of the server's identity. Alternatively, you may disable SSL completely for Develocity installation but this is not recommended.

        Allowing communication with untrusted servers keeps data encrypted during transmission, but makes it easy for a man-in-the-middle to impersonate the intended server and capture data.

        This value has no effect if a server is specified using the HTTP protocol (i.e. has SSL disabled).

        Configuration via the develocity.allowUntrustedServer system property will always take precedence.

        Parameters:
        allow - whether to allow communication with a HTTPS server with an untrusted certificate
        Since:
        1.10.1

      • getAllowUntrustedServer

        boolean getAllowUntrustedServer()
        Deprecated.
        Whether it is acceptable to communicate with a Develocity server with an untrusted SSL certificate.
        Returns:
        true if it is acceptable to communicate with a build scan server with an untrusted SSL certificate
        Since:
        1.10.1

      • setAccessKey

        void setAccessKey​(java.lang.String accessKey)
        Deprecated.
        Sets the access key for authenticating with the Develocity server.

        An access key configured this way will take precedence over the GRADLE_ENTERPRISE_ACCESS_KEY environment variable or access key file entry associated with the server.

        Parameters:
        accessKey - a Develocity server access key without any hostname prefix
        Since:
        1.11

      • getAccessKey

        @Nullable
java.lang.String getAccessKey()
        Deprecated.
        Returns the access key for authenticating with the Develocity server.

        Only the value of the explicitly configured access key (via setAccessKey(String) or gradle-enterprise.xml) is returned but not the value of an access key configured via the GRADLE_ENTERPRISE_ACCESS_KEY environment variable or access key file entry.

        Returns:
        the configured Develocity server access key, if available; otherwise, null
        Since:
        1.11

      • getBuildScan

        BuildScanApi getBuildScan()
        Deprecated.
        The build scan API.
        Returns:
        the build scan API
        Since:
        1.10.1

      • getBuildCache

        BuildCacheApi getBuildCache()
        Deprecated.
        The build cache API.
        Returns:
        the build cache API
        Since:
        1.10.1