Package com.palantir.gradle.dist

Class BaseDistributionExtension

java.lang.Object
com.palantir.gradle.dist.BaseDistributionExtension
Direct Known Subclasses:
AssetDistributionExtension, JavaServiceDistributionExtension
public class BaseDistributionExtension extends Object

  • Constructor Details

    • BaseDistributionExtension

      @Inject public BaseDistributionExtension(org.gradle.api.Project project)

  • Method Details

    • getDistributionServiceGroup

      public final org.gradle.api.provider.Provider<String> getDistributionServiceGroup()

    • getServiceGroup

      @Deprecated public final String getServiceGroup()
      Deprecated.
      Do not use this method directly, instead use getDistributionServiceGroup.
      The group of the distribution being created.

    • setServiceGroup

      public final void setServiceGroup(String serviceGroup)

    • getDistributionServiceName

      public final org.gradle.api.provider.Provider<String> getDistributionServiceName()

    • getServiceName

      @Deprecated public final String getServiceName()
      Deprecated.
      Do not use this method directly, instead use getDistributionServiceName.
      The name of the distribution being created.

    • setServiceName

      public final void setServiceName(String serviceName)

    • getProductType

      public final org.gradle.api.provider.Provider<ProductType> getProductType()

    • setProductType

      public final void setProductType(ProductType productType)

    • getArtifacts

      public final org.gradle.api.DomainObjectSet<ArtifactLocator> getArtifacts()

    • artifact

      public final void artifact(@DelegatesTo(ArtifactLocator.class) groovy.lang.Closure<ArtifactLocator> closure)
      Lazily configures and adds a ArtifactLocator.

    • artifact

      public final void artifact(org.gradle.api.Action<ArtifactLocator> action)

    • getProductDependencies

      @Deprecated public final org.gradle.api.provider.Provider<List<com.palantir.gradle.dist.ProductDependency>> getProductDependencies()
      Deprecated.
      use getAllProductDependencies() instead
      The product dependencies of this distribution.

    • getAllProductDependencies

      public final org.gradle.api.provider.ListProperty<com.palantir.gradle.dist.ProductDependency> getAllProductDependencies()

    • productDependency

      public final void productDependency(String mavenCoordVersionRange)

    • productDependency

      public final void productDependency(String mavenCoordVersionRange, String recommendedVersion)

    • productDependency

      public final void productDependency(String dependencyGroup, String dependencyName, String minVersion)

    • productDependency

      public final void productDependency(String dependencyGroup, String dependencyName, String minVersion, String maxVersion)

    • productDependency

      public final void productDependency(String dependencyGroup, String dependencyName, String minVersion, String maxVersion, String recommendedVersion)

    • productDependency

      public final void productDependency(@DelegatesTo(com.palantir.gradle.dist.ProductDependency.class) groovy.lang.Closure<com.palantir.gradle.dist.ProductDependency> closure)
      Lazily configures and adds a ProductDependency.

    • getOptionalProductDependencies

      public final org.gradle.api.provider.Provider<Set<ProductId>> getOptionalProductDependencies()

    • optionalProductDependency

      public final void optionalProductDependency(String productGroup, String productName)

    • optionalProductDependency

      public final void optionalProductDependency(String optionalProductId)

    • getIgnoredProductDependencies

      public final org.gradle.api.provider.Provider<Set<ProductId>> getIgnoredProductDependencies()

    • ignoredProductDependency

      public final void ignoredProductDependency(String productGroup, String productName)

    • ignoredProductDependency

      public final void ignoredProductDependency(String ignoredProductId)

    • ignoredProductDependency

      public final void ignoredProductDependency(@DelegatesTo(ProductId.class) groovy.lang.Closure<ProductId> closure)

    • getManifestExtensions

      public final org.gradle.api.provider.MapProperty<String,Object> getManifestExtensions()

    • manifestExtensions

      public final void manifestExtensions(Map<String,Object> extensions)

    • setManifestExtension

      public final void setManifestExtension(String extensionName, Object extension)

    • setManifestExtensions

      public final void setManifestExtensions(Map<String,Object> extensions)

    • getConfigurationYml

      public final org.gradle.api.file.RegularFileProperty getConfigurationYml()

    • getProductDependenciesConfig

      public final org.gradle.api.artifacts.Configuration getProductDependenciesConfig()

    • getConsumableProductDependenciesConfigName

      public final org.gradle.api.provider.Provider<String> getConsumableProductDependenciesConfigName()

    • setProductDependenciesConfig

      public final void setProductDependenciesConfig(org.gradle.api.artifacts.Configuration productDependenciesConfig)
      Passing in a non-consumable Configuration is deprecated as it won't be compatible with Gradle 9. It will be an error in version 4.0.0. We work around this by creating a consumable Configuration that extends the given productDependenciesConfig Configuration. This is somewhat surprising behaviour, and undesirable, but here to maintain backwards compatibility as we transition to Gradle 9.

      You should be able to just extend ProductDependencies.PRODUCT_DEPENDENCY_DISCOVERY_CONFIGURATION_NAME with the configuration in question for example: 

       configurations {
   productDependencyDiscovery {
     extendsFrom configurations.nonConsumableConfiguration
   }
 }
      Ideally, a consumable configuration is used, and even still, this method is not required. An easier way would be to just add a dependency on the consumable configuration like so: 
       dependencies {
     productDependencyDiscovery project(name: project.path, conf: 'myConsumableConfiguration')
 }