RepoManagement (BuildSupportPlugin 2.4.2 API)

gov.raptor.gradle.plugins.buildsupport.RepoManagement

DSL support to allow build scripts to configure the repos to be used for fetching dependencies and publishing artifacts produced by the build.
Authors:
Proprietary information subject to the terms of a Non-Disclosure Agreement
Since:
0.4

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`RepoManagement.RepoConfig`	Base repo configuration.

Constructor Summary

Constructors
Constructor and description
`RepoManagement (org.gradle.api.Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`ctiPrivate(java.util.Map props)` Add a CTI Private repo configuration accepting a map of configuration properties.
	`void`	`ctiPublic(java.util.Map props)` Add a CTI Public repo configuration accepting a map of configuration properties.
	`void`	`di2eCentral(java.util.Map props)` Add a DI2E Central configuration accepting a map of configuration properties.
	`void`	`di2ePrivate(java.util.Map props)` Add a DI2E private repo configuration accepting a map of configuration properties.
	`void`	`di2eRaptorx(java.util.Map props)` Add a DI2E RaptorX configuration accepting a map of configuration properties.
	`RepoManagement.RepoConfig`	`getCtiPrivate(java.lang.String name)` @param name The name of the repo to find
	`RepoManagement.RepoConfig`	`getCtiPublic(java.lang.String name)` @param name The name of the repo to find
	`RepoManagement.RepoConfig`	`getDi2eCentral()` Returns: The RepoConfig for the DI2E Central repo.
	`RepoManagement.RepoConfig`	`getDi2ePrivate(java.lang.String name)` @param name The name of the repo to find
	`RepoManagement.RepoConfig`	`getDi2eRaptorx()` Returns: The RepoConfig for the DI2E Raptorx repo.
	`java.util.List<RepoConfig>`	`getPublishingRepoConfigs()` @return All repo configurations where 'publish' is set true
	`java.util.List<RepoConfig>`	`getRepoConfigs()` @return All repo configurations
	`RepoManagement.RepoConfig`	`getTakx()` Returns: The RepoConfig for the TAKX repo.
	`void`	`google()` Include `google( )` in the repository configuration.
	`boolean`	`includeGoogle()` @return `true` if google should be included in the repository configuration
	`boolean`	`includeMavenLocal()` @return `true` if maven local should be included in the repository configuration, `false` if the noMavenLocal() configuration has been specified.
	`void`	`noMavenLocal()` Disallow the use of maven local for dependency resolution.
	`void`	`raptorx(java.util.Map props)` Retained for backward compatibility.
	`void`	`takx(java.util.Map props)` Add the TAKX configuration accepting a map of configuration properties.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - RepoManagement(org.gradle.api.Project project)
- Method Detail
  - void ctiPrivate(java.util.Map props)
    
    Add a CTI Private repo configuration accepting a map of configuration properties. Supported properties are:
    - name - The name/tag of the repo. This is used to determine repo URLs
    - publish - boolean value, true if publishing should be configured for this repo, default false
    - username - (optional) specify a username for this repo
    - password - (optional) specify a password for this repo
    Credentials for this repo type are expected to be managed externally, and no standard credentials discovery will be performed.
    Parameters:
    props - Configuration properties
  - void ctiPublic(java.util.Map props)
    
    Add a CTI Public repo configuration accepting a map of configuration properties. Supported properties are:
    - name - The name/tag of the repo. This is used to determine repo URLs
    - publish - boolean value, true if publishing should be configured for this repo, default false
    - username - (optional) specify a username for this repo
    - password - (optional) specify a password for this repo
    Credentials are typically extracted from the credentials store on the local machine or from an environment variable. For a CTI public repo, the credential store keys are publicRepoUsername and publicRepoPassword. The environment variables used are CTI_PUBLIC_NEXUS_USERNAME and CTI_PUBLIC_NEXUS_PASSWORD.
    Parameters:
    props - Configuration properties
  - void di2eCentral(java.util.Map props)
    
    Add a DI2E Central configuration accepting a map of configuration properties. Supported properties are:
    - username - (optional) specify a username for this repo
    - password - (optional) specify a password for this repo
    Credentials are typically extracted from the credentials store on the local machine or from an environment variable. For the DI2E Central repo, the credential store keys are di2eRepoUsername and di2eRepoPassword. The environment variables DI2E_NEXUS_USERNAME and DI2E_NEXUS_PASSWORD can be used to specify the repo access credentials.
    Parameters:
    props - Configuration properties
  - void di2ePrivate(java.util.Map props)
    
    Add a DI2E private repo configuration accepting a map of configuration properties.
    The pattern for the release repo is: [repoPrefix]_[name]_[releaseRepoSuffix] The pattern for the snapshot repo is: [repoPrefix]_[name]_[snapshotRepoSuffix]
    Supported properties are:
    - name - The name/tag of the repo. This is used to determine repo URLs and credentials
    - publish - boolean value, true if publishing should be configured for this repo, default false
    - nexus3 - (optional) boolean value, false (default) indicates publishing to a Nexus2 repo. true indicates publishing to a Nexus3 repo. This is ignored if !publish. (since v0.7.3)
    - snapshotRepoSuffix - (optional) String value, the repo suffix to use in lieu of default value ("Snapshots") (since v0.7.3)
    - releaseRepoSuffix - (optional) String value, the repo suffix to use in lieu of default value ("Releases") (since v0.7.3)
    - repoPrefix - (optional) String value, the repo prefix to use in lieu of default value ("Private") (since v0.7.3)
    - username - (optional) String value, specify a username for this repo
    - password - (optional) String value, specify a password for this repo (NOT SECURE)
    Credentials are typically extracted from the credentials store on the local machine or from an environment variable. For a DI2E private repo, the credential store keys are [name]RepoUsername and [name]RepoPassword, with a fallback to di2eRepoUsername and di2eRepoPassword. The environment variables used are [name]_NEXUS_USERNAME and [name]_NEXUS_PASSWORD, with a fallback to DI2E_NEXUS_USERNAME and DI2E_NEXUS_PASSWORD.
    Parameters:
    props - Configuration properties
  - void di2eRaptorx(java.util.Map props)
    
    Add a DI2E RaptorX configuration accepting a map of configuration properties. Supported properties are:
    - publish - boolean value, true if publishing should be configured for this repo, default false
    - username - (optional) specify a username for this repo
    - password - (optional) specify a password for this repo
    Credentials are typically extracted from the credentials store on the local machine or from an environment variable. For the DI2E RaptorX repo, the credential store keys are di2eRepoUsername and di2eRepoPassword. The environment variables DI2E_NEXUS_USERNAME and DI2E_NEXUS_PASSWORD can be used to specify the repo access credentials.
    Parameters:
    props - Configuration properties
    Since:
    0.5
  - RepoManagement.RepoConfig getCtiPrivate(java.lang.String name)
    
    Parameters:
    name - The name of the repo to find
    Returns:
    The RepoConfig for the CTI private repo with the given name. Null if not configured.
    Since:
    0.7.2
  - RepoManagement.RepoConfig getCtiPublic(java.lang.String name)
    
    Parameters:
    name - The name of the repo to find
    Returns:
    The RepoConfig for the CTI public repo with the given name. Null if not configured.
    Since:
    0.7.2
  - RepoManagement.RepoConfig getDi2eCentral()
    
    Returns:
    The RepoConfig for the DI2E Central repo. Null if not configured.
    Since:
    0.7.2
  - RepoManagement.RepoConfig getDi2ePrivate(java.lang.String name)
    
    Parameters:
    name - The name of the repo to find
    Returns:
    The RepoConfig for the DI2E private repo with the given name. Null if not configured.
    Since:
    0.7.2
  - RepoManagement.RepoConfig getDi2eRaptorx()
    
    Returns:
    The RepoConfig for the DI2E Raptorx repo. Null if not configured.
    Since:
    0.7.2
  - java.util.List<RepoConfig> getPublishingRepoConfigs()
    
    Returns:
    All repo configurations where 'publish' is set true
  - java.util.List<RepoConfig> getRepoConfigs()
    
    Returns:
    All repo configurations
  - RepoManagement.RepoConfig getTakx()
    
    Returns:
    The RepoConfig for the TAKX repo. Null if not configured.
    Since:
    0.7.6
  - void google()
    
    Include google( ) in the repository configuration.
  - boolean includeGoogle()
    
    Returns:
    true if google should be included in the repository configuration
  - boolean includeMavenLocal()
    
    Returns:
    true if maven local should be included in the repository configuration, false if the noMavenLocal() configuration has been specified.
    Since:
    0.7.6
  - void noMavenLocal()
    
    Disallow the use of maven local for dependency resolution.
  - void raptorx(java.util.Map props)
    
    Retained for backward compatibility. Issues a warning and then redirects to configure di2eRaptorx.
    Parameters:
    props - Configuration properties
  - void takx(java.util.Map props)
    
    Add the TAKX configuration accepting a map of configuration properties. Supported properties are:
    - publish - boolean value, true if publishing should be configured for this repo, default false
    - username - (optional) specify a username for this repo
    - password - (optional) specify a password for this repo
    Credentials are typically extracted from the credentials store on the local machine or from an environment variable. For the TAKX repo, the credential store keys are takRepoUsername and takRepoPassword. The environment variables TAK_USERNAME and TAK_PASSWORD can be used to specify the repo access credentials.
    Parameters:
    props - Configuration properties
    Since:
    0.7.6

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class RepoManagement

Nested Class Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

RepoManagement(org.gradle.api.Project project)

Method Detail

void ctiPrivate(java.util.Map props)

void ctiPublic(java.util.Map props)

void di2eCentral(java.util.Map props)

void di2ePrivate(java.util.Map props)

void di2eRaptorx(java.util.Map props)

RepoManagement.RepoConfig getCtiPrivate(java.lang.String name)

RepoManagement.RepoConfig getCtiPublic(java.lang.String name)

RepoManagement.RepoConfig getDi2eCentral()

RepoManagement.RepoConfig getDi2ePrivate(java.lang.String name)

RepoManagement.RepoConfig getDi2eRaptorx()

java.util.List<RepoConfig> getPublishingRepoConfigs()

java.util.List<RepoConfig> getRepoConfigs()

RepoManagement.RepoConfig getTakx()

void google()

boolean includeGoogle()

boolean includeMavenLocal()

void noMavenLocal()

void raptorx(java.util.Map props)

void takx(java.util.Map props)