Index (konfigyr-plugin-gradle 1.2.0 API)

A C E G I K P R S T U W
All Classes and Interfaces|All Packages

A

apply(Project) - Method in class com.konfigyr.gradle.KonfigyrPlugin
ArtifactMetadataTransform - Class in com.konfigyr.gradle: A Gradle TransformAction that processes each JAR on the runtimeClasspath and produces a self-describing output file containing the PropertyDescriptor metadata.
ArtifactMetadataTransform() - Constructor for class com.konfigyr.gradle.ArtifactMetadataTransform
ArtifactoryService - Class in com.konfigyr.gradle: Gradle BuildService for interacting with the Konfigyr Artifactory REST API.
ArtifactoryService() - Constructor for class com.konfigyr.gradle.ArtifactoryService: Creates a new ArtifactoryService instance.

C

clientCredentials(Action<RegistrySpec.ClientCredentialsSpec>) - Method in class com.konfigyr.gradle.RegistrySpec: Configures ClientCredentials, for the OAuth2 client_credentials grant.
ClientCredentialsSpec(ObjectFactory, ProviderFactory, boolean) - Constructor for class com.konfigyr.gradle.RegistrySpec.ClientCredentialsSpec: Creates a new RegistrySpec.ClientCredentialsSpec, instantiated by Gradle when RegistrySpec.clientCredentials(Action) is first called for a given registry.
com.konfigyr.gradle - package com.konfigyr.gradle
complete(String, String, ServiceRelease) - Method in class com.konfigyr.gradle.ArtifactoryService: Completes the given ServiceRelease, promoting it to the service's current Manifest on the named registry.
createArtifactMetadata(Artifact, File) - Method in class com.konfigyr.gradle.ArtifactoryService: Creates an ArtifactMetadata instances for the given Artifact by loading the serialized configuration metadata from the given File.
CreateServiceReleaseTask - Class in com.konfigyr.gradle: Task that opens (or takes over) this service's current ServiceRelease, uploads metadata for every candidate artifact the server reports as ArtifactUploadStatus.UPLOAD_REQUIRED, then completes the release so it becomes the service's current Manifest.
CreateServiceReleaseTask() - Constructor for class com.konfigyr.gradle.CreateServiceReleaseTask

E

execute() - Method in class com.konfigyr.gradle.ServiceReleaseArtifactUploadAction

G

GenerateArtifactMetadataTask - Class in com.konfigyr.gradle: Task that scans this project's built JAR file archive for Spring Boot configuration metadata and, if found, writes it out as ArtifactMetadata describing this project's artifact.
GenerateArtifactMetadataTask() - Constructor for class com.konfigyr.gradle.GenerateArtifactMetadataTask
getArtifact() - Method in class com.konfigyr.gradle.ArtifactMetadataTransform: The location of the artifact file being transformed.
getArtifacts() - Method in class com.konfigyr.gradle.ResolveServiceDependenciesTask: Collection that contains transformed artifact metadata from the ArtifactMetadataTransform.
getClientId() - Method in class com.konfigyr.gradle.RegistrySpec.ClientCredentialsSpec: Specify the OAuth client_id that is used to get the OAuth access token.
getClientId() - Method in class com.konfigyr.gradle.RegistrySpec.TokenExchangeSpec: Specify the OAuth client_id that is used to get the OAuth access token.
getClientSecret() - Method in class com.konfigyr.gradle.RegistrySpec.ClientCredentialsSpec: Specify the OAuth client_secret that is used to get the OAuth access token.
getDependencies() - Method in class com.konfigyr.gradle.ArtifactMetadataTransform: The file collection containing the dependencies of the artifact being transformed.
getDependencyDirectory() - Method in class com.konfigyr.gradle.CreateServiceReleaseTask: The directory where serialized dependency ArtifactMetadata is located, written by ResolveServiceDependenciesTask.
getDependencyDirectory() - Method in class com.konfigyr.gradle.ResolveServiceDependenciesTask: The output directory where serialized ArtifactMetadata for each dependency should be written.
getDependencyManifest() - Method in class com.konfigyr.gradle.CreateServiceReleaseTask: The manifest file containing the dependency artifact metadata file locations, written by ResolveServiceDependenciesTask.
getDependencyManifest() - Method in class com.konfigyr.gradle.ResolveServiceDependenciesTask: The manifest file that should be written that contains all the processed dependency artifacts.
getInsecure() - Method in class com.konfigyr.gradle.RegistrySpec: Whether this registry's RegistrySpec.url is allowed to use the plain http scheme, beyond the loopback exemption that's always granted for local testing.
getMetadata() - Method in class com.konfigyr.gradle.GenerateArtifactMetadataTask: The file this project's ArtifactMetadata is written to, if GenerateArtifactMetadataTask.getProjectArchive() exposes Spring Boot configuration metadata.
getMetadata() - Method in class com.konfigyr.gradle.PublishArtifactMetadataTask: The file containing this project's own serialized ArtifactMetadata, written by GenerateArtifactMetadataTask.
getName() - Method in class com.konfigyr.gradle.KonfigyrExtension.ServiceSpec: The Konfigyr service this project releases against.
getName() - Method in class com.konfigyr.gradle.RegistrySpec: The name under which this registry is declared in the registries { } container - either the reserved "konfigyrCentral" name, or a custom name passed to KonfigyrExtension.registry(String, Action).
getPollInterval() - Method in class com.konfigyr.gradle.KonfigyrExtension.PublishSpec: The initial time interval in milliseconds between consecutive polling attempts to check for a release.
getPollTimeout() - Method in class com.konfigyr.gradle.KonfigyrExtension.PublishSpec: The maximum time in milliseconds to wait for a successful poll of a release.
getProjectArchive() - Method in class com.konfigyr.gradle.GenerateArtifactMetadataTask: This project's built jar, scanned for Spring Boot configuration metadata.
getProjectArtifact() - Method in class com.konfigyr.gradle.GenerateArtifactMetadataTask: This project's Maven coordinates, used to build the ArtifactMetadata when this project's jar exposes Spring Boot configuration metadata.
getProjectArtifacts() - Method in class com.konfigyr.gradle.ResolveServiceDependenciesTask: A map of every project in the build, keyed by Gradle project path, with each value being a pre-built Artifact descriptor.
getPublish() - Method in class com.konfigyr.gradle.KonfigyrExtension: Direct-publish polling behavior.
getRegistries() - Method in class com.konfigyr.gradle.KonfigyrExtension: Every registry this project should publish its artifact metadata and service releases to.
getRegistryConfigured() - Method in class com.konfigyr.gradle.PublishArtifactMetadataTask: Whether the registry named by PublishArtifactMetadataTask.getRegistryName() is fully configured (a url and either clientCredentials { } or tokenExchange { } grant).
getRegistryName() - Method in class com.konfigyr.gradle.CreateServiceReleaseTask: The name of the registry this task opens the service release against.
getRegistryName() - Method in class com.konfigyr.gradle.PublishArtifactMetadataTask: The name of the registry this task publishes to.
getReleaseConfigured() - Method in class com.konfigyr.gradle.CreateServiceReleaseTask: Whether this task is eligible to run: the project's konfigyr { service { } } block has been configured, and the registry named by CreateServiceReleaseTask.getRegistryName() is fully configured (a url and either clientCredentials { } or tokenExchange { } grant).
getReleasePollingInterval() - Method in class com.konfigyr.gradle.PublishArtifactMetadataTask: The initial time interval in milliseconds between consecutive polling attempts to check for a release.
getReleaseTimeout() - Method in class com.konfigyr.gradle.PublishArtifactMetadataTask: The maximum time in milliseconds to wait for a successful poll of a release.
getRuntimeClasspath() - Method in class com.konfigyr.gradle.GenerateArtifactMetadataTask: This project's own compile/runtime classpath, used purely to build a ClassLoader capable of resolving Java types referenced by this project's own Spring Boot configuration metadata (e.g.
getRuntimeClasspath() - Method in class com.konfigyr.gradle.ResolveServiceDependenciesTask: The collection of files that represent the runtime classpath of the current project.
getService() - Method in class com.konfigyr.gradle.CreateServiceReleaseTask: Returns the ArtifactoryService to use for creating the service release.
getService() - Method in class com.konfigyr.gradle.GenerateArtifactMetadataTask: Returns the ArtifactoryService to use for constructing and writing the artifact metadata.
getService() - Method in class com.konfigyr.gradle.KonfigyrExtension: This project's service identity, used by the service-release scenario.
getService() - Method in class com.konfigyr.gradle.PublishArtifactMetadataTask: Returns the ArtifactoryService to use for publishing the artifact metadata.
getService() - Method in class com.konfigyr.gradle.ResolveServiceDependenciesTask: Returns the ArtifactoryService to use for constructing and writing the artifact metadata.
getServiceArtifactMetadata() - Method in class com.konfigyr.gradle.CreateServiceReleaseTask: The file containing this project's own serialized ArtifactMetadata, written by GenerateArtifactMetadataTask.
getServiceConfigured() - Method in class com.konfigyr.gradle.ResolveServiceDependenciesTask: Whether the project's konfigyr { service { } } block has been configured.
getServiceName() - Method in class com.konfigyr.gradle.CreateServiceReleaseTask: The Konfigyr service name.
getServiceName() - Method in class com.konfigyr.gradle.ResolveServiceDependenciesTask: The Konfigyr service name.
getSubjectToken() - Method in class com.konfigyr.gradle.RegistrySpec.TokenExchangeSpec: The token being exchanged for an access token.
getSubjectTokenType() - Method in class com.konfigyr.gradle.RegistrySpec.TokenExchangeSpec: An identifier, as defined by RFC 8693, for the type of the RegistrySpec.TokenExchangeSpec.subjectToken (for example urn:ietf:params:oauth:token-type:jwt or urn:ietf:params:oauth:token-type:id_token).
getUrl() - Method in class com.konfigyr.gradle.RegistrySpec: The registry's url.
getWorkerExecutor() - Method in class com.konfigyr.gradle.CreateServiceReleaseTask: The WorkerExecutor to use for executing the ServiceReleaseArtifactUploadAction for every artifact the release reports as requiring an upload.

I

isUseEnvironmentConventions() - Method in class com.konfigyr.gradle.RegistrySpec.ClientCredentialsSpec: Whether this grant falls back to Konfigyr's well-known environment variables (KONFIGYR_CLIENT_ID/KONFIGYR_CLIENT_SECRET) when a property is left unset - true only for the reserved "konfigyrCentral" registry, every other registry must set every property explicitly.
isUseEnvironmentConventions() - Method in class com.konfigyr.gradle.RegistrySpec.TokenExchangeSpec: Whether this grant falls back to Konfigyr's well-known environment variables (KONFIGYR_CLIENT_ID/KONFIGYR_SUBJECT_TOKEN) when a property is left unset - true only for the reserved "konfigyrCentral" registry, every other registry must set every property explicitly.

K

konfigyrCentral() - Method in class com.konfigyr.gradle.KonfigyrExtension: Registers (or looks up) the well-known Konfigyr Central registry under the reserved "konfigyrCentral" name.
konfigyrCentral(Action<RegistrySpec>) - Method in class com.konfigyr.gradle.KonfigyrExtension: Registers (or looks up) the well-known Konfigyr Central registry, applying the given action to override its conventions.
KonfigyrExtension - Class in com.konfigyr.gradle: Configuration extension for the Konfigyr Gradle plugin.
KonfigyrExtension(Project, ObjectFactory) - Constructor for class com.konfigyr.gradle.KonfigyrExtension: Creates a new KonfigyrExtension instance.
KonfigyrExtension.PublishSpec - Class in com.konfigyr.gradle: Polling behavior for the direct-publish scenario, used while waiting for a com.konfigyr.artifactory.Publication to be confirmed after PublishArtifactMetadataTask uploads this project's own artifact metadata.
KonfigyrExtension.ServiceSpec - Class in com.konfigyr.gradle: This project's service identity, used to resolve its dependencies and open a service release against the Konfigyr Artifactory.
KonfigyrPlugin - Class in com.konfigyr.gradle: Gradle plugin for publishing Spring Boot configuration metadata to Konfigyr.
KonfigyrPlugin() - Constructor for class com.konfigyr.gradle.KonfigyrPlugin

P

parsePropertyDescriptors(Iterable<? extends ArtifactMetadataResource>, Iterable<? extends File>) - Method in class com.konfigyr.gradle.ArtifactoryService: Attempts to parse the given collection of ArtifactMetadataResources into a list of PropertyDescriptors.
publish(String, ArtifactMetadata, Duration, Duration) - Method in class com.konfigyr.gradle.ArtifactoryService: Starts the publication process for the given ArtifactMetadata against the named registry.
publish(Action<KonfigyrExtension.PublishSpec>) - Method in class com.konfigyr.gradle.KonfigyrExtension: Configures the direct-publish polling behavior.
PublishArtifactMetadataTask - Class in com.konfigyr.gradle: Task that publishes this project's own ArtifactMetadata, generated by GenerateArtifactMetadataTask, directly to the Konfigyr Artifactory.
PublishArtifactMetadataTask() - Constructor for class com.konfigyr.gradle.PublishArtifactMetadataTask

R

readArtifactMetadata(File) - Method in class com.konfigyr.gradle.ArtifactoryService: Reads a single ArtifactMetadata previously written by ArtifactoryService.writeServiceArtifactMetadata(ArtifactMetadata, File).
readArtifactMetadata(File, File) - Method in class com.konfigyr.gradle.ArtifactoryService: Reads ArtifactMetadata from the given directory that are present in the artifact manifest list.
registries(Action<NamedDomainObjectContainer<RegistrySpec>>) - Method in class com.konfigyr.gradle.KonfigyrExtension: Configures the KonfigyrExtension.registries container directly, using Gradle's own container idiom.
registry(String, Action<RegistrySpec>) - Method in class com.konfigyr.gradle.KonfigyrExtension: Registers (or looks up) a custom, self-hosted registry under the given name.
RegistrySpec - Class in com.konfigyr.gradle: Configures a single Konfigyr Artifactory registry within the registries { } container exposed by KonfigyrExtension.
RegistrySpec(String, ObjectFactory, ProviderFactory, boolean) - Constructor for class com.konfigyr.gradle.RegistrySpec: Creates a new RegistrySpec, instantiated by Gradle for each entry added to the KonfigyrExtension.getRegistries() container.
RegistrySpec.ClientCredentialsSpec - Class in com.konfigyr.gradle: Configures ClientCredentials, used for the OAuth2 client_credentials grant, as defined by RFC 6749, Section 4.4.
RegistrySpec.TokenExchangeSpec - Class in com.konfigyr.gradle: Configures a TokenExchange, used for the OAuth2 Token Exchange grant, as defined by RFC 8693.
release(String, String, Collection<? extends ServiceReleaseCandidate>) - Method in class com.konfigyr.gradle.ArtifactoryService: Attempts to publish a new ServiceRelease for the given service, against the named registry.
ResolveServiceDependenciesTask - Class in com.konfigyr.gradle: Task that generates ArtifactMetadata for each of this project's resolved runtime dependencies that expose Spring Boot configuration metadata, then writes the results to the output directory.
ResolveServiceDependenciesTask() - Constructor for class com.konfigyr.gradle.ResolveServiceDependenciesTask

S

service(Action<KonfigyrExtension.ServiceSpec>) - Method in class com.konfigyr.gradle.KonfigyrExtension: Opts this project into the service-release scenario, configuring its service identity.
ServiceReleaseArtifactUploadAction - Class in com.konfigyr.gradle: Implementation of WorkAction that uploads the ArtifactMetadata for a single artifact required by a ServiceRelease using the registered ArtifactoryService.
ServiceReleaseArtifactUploadAction() - Constructor for class com.konfigyr.gradle.ServiceReleaseArtifactUploadAction

T

tokenExchange(Action<RegistrySpec.TokenExchangeSpec>) - Method in class com.konfigyr.gradle.RegistrySpec: Configures a TokenExchange, for the OAuth2 Token Exchange grant.
TokenExchangeSpec(ObjectFactory, ProviderFactory, boolean) - Constructor for class com.konfigyr.gradle.RegistrySpec.TokenExchangeSpec: Creates a new RegistrySpec.TokenExchangeSpec, instantiated by Gradle when RegistrySpec.tokenExchange(Action) is first called for a given registry.
transform(TransformOutputs) - Method in class com.konfigyr.gradle.ArtifactMetadataTransform

U

upload(String, String, ServiceRelease, ArtifactMetadata) - Method in class com.konfigyr.gradle.ArtifactoryService: Uploads the given ArtifactMetadata for the given ServiceRelease, against the named registry.

W

writeArtifactMetadata(ArtifactMetadata, File) - Method in class com.konfigyr.gradle.ArtifactoryService: Writes the given ArtifactMetadata to the given directory.
writePropertyDescriptorMetadata(Iterable<? extends ArtifactMetadataResource>, Iterable<? extends File>, File) - Method in class com.konfigyr.gradle.ArtifactoryService: Generates and writes PropertyDescriptor metadata extracted from the given collection of ArtifactMetadataResources to the given target File.
writeServiceArtifactMetadata(ArtifactMetadata, File) - Method in class com.konfigyr.gradle.ArtifactoryService: Writes the given ArtifactMetadata to the exact given target file, unlike ArtifactoryService.writeArtifactMetadata(ArtifactMetadata, File) which derives a filename from the artifact's coordinates inside a target directory.

A C E G I K P R S T U W
All Classes and Interfaces|All Packages