Index (api-only-subscriber 0.3.0 API)

A C E F G H I L M N P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

ApiOnlySubscriberExtension - Class in com.arc_e_tect.gradle.apionly.subscriber: The apiOnlySubscriber block: which contracts this project builds against, and where they come from.
ApiOnlySubscriberExtension(ObjectFactory) - Constructor for class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberExtension: Creates the extension.
ApiOnlySubscriberPlugin - Class in com.arc_e_tect.gradle.apionly.subscriber: The consumer half of the API-Only pair.
ApiOnlySubscriberPlugin() - Constructor for class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberPlugin: Creates the plugin.
apply(Project) - Method in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberPlugin: Registers the apiOnlySubscriber extension and the tasks that act on it.
applyCleanupDsl(boolean) - Method in class com.arc_e_tect.gradle.apionly.subscriber.UpdateApiOnlySubscriberDslTask: Sets UpdateApiOnlySubscriberDslTask.getCleanupDsl() for this run.
applyGenerateDsl(boolean) - Method in class com.arc_e_tect.gradle.apionly.subscriber.UpdateApiOnlySubscriberDslTask: Sets UpdateApiOnlySubscriberDslTask.getGenerateDsl() for this run.

C

channel() - Method in record class com.arc_e_tect.gradle.apionly.subscriber.Lockfile.Entry: Returns the value of the channel record component.
channel(Action<? super ChannelSpec>) - Method in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberExtension: Configures the channel.
channel(Action<? super ChannelSpec>) - Method in class com.arc_e_tect.gradle.apionly.subscriber.Subscription: Configures a channel of this subscription's own.
ChannelSpec - Class in com.arc_e_tect.gradle.apionly.subscriber: Where subscribed contracts are fetched from.
ChannelSpec() - Constructor for class com.arc_e_tect.gradle.apionly.subscriber.ChannelSpec: Creates the specification with maven as the channel type.
CLIENT_RESOURCES - Static variable in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberPlugin: The classpath directory the documents of an API a project calls are copied under, followed by the target name: "contracts".
closureSha256() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Manifest: The content hash of the producer's dependency closure for this target.
com.arc_e_tect.gradle.apionly.subscriber - package com.arc_e_tect.gradle.apionly.subscriber
CONTRACT_VERSION_PROPERTY - Static variable in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberPlugin: The project property apiOnlySubscriber.version defaults to: "apiContractVersion".

E

Entry(String, String, String, Map<String, String>) - Constructor for record class com.arc_e_tect.gradle.apionly.subscriber.Lockfile.Entry: Creates an instance of a Entry record class.
equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.subscriber.Lockfile.Entry: Indicates whether some other object is "equal to" this one.
EXTENSION_NAME - Static variable in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberPlugin: The name this plugin's extension is registered under: "apiOnlySubscriber".

F

fetch() - Method in class com.arc_e_tect.gradle.apionly.subscriber.FetchApiSpecTask: Unpacks the archive, verifies it against its own manifest, and records the result in the lockfile.
FETCH_TASK - Static variable in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberPlugin: The aggregate task that fetches every subscribed contract: "fetchApiSpec".
FetchApiSpecTask - Class in com.arc_e_tect.gradle.apionly.subscriber: Unpacks a subscribed contract into the build, and records what it unpacked.
FetchApiSpecTask() - Constructor for class com.arc_e_tect.gradle.apionly.subscriber.FetchApiSpecTask: Creates the task.
files() - Method in record class com.arc_e_tect.gradle.apionly.subscriber.Lockfile.Entry: Returns the value of the files record component.
files() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Manifest: Each declared document mapped to its SHA-256.
FORMAT_VERSION - Static variable in class com.arc_e_tect.gradle.apionly.subscriber.Lockfile: The format this class reads and writes.

G

get(String) - Method in class com.arc_e_tect.gradle.apionly.subscriber.Lockfile: The entry for one target.
getAllowPrerelease() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Subscription: Whether this subscription may resolve a pre-release contract.
getArchive() - Method in class com.arc_e_tect.gradle.apionly.subscriber.FetchApiSpecTask: The resolved archive.
getArchives() - Method in class com.arc_e_tect.gradle.apionly.subscriber.FetchApiSpecTask: Gradle's archive operations, used to unpack the fetched .tgz.
getArtifactId() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Subscription: Overrides the artifact name this target is published under.
getAsyncapi() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Subscription: The fetched AsyncAPI document.
getBuildFile() - Method in class com.arc_e_tect.gradle.apionly.subscriber.UpdateApiOnlySubscriberDslTask: The consumer project's build.gradle.
getChannel() - Method in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberExtension: The channel every subscription in this project resolves through.
getChannel() - Method in class com.arc_e_tect.gradle.apionly.subscriber.FetchApiSpecTask: Which channel the archive came from.
getChannel() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Subscription: The channel this subscription resolves through.
getCleanupDsl() - Method in class com.arc_e_tect.gradle.apionly.subscriber.UpdateApiOnlySubscriberDslTask: Whether to remove managed comments from the DSL block.
getDirectory() - Method in class com.arc_e_tect.gradle.apionly.subscriber.ChannelSpec: The directory the file channel reads from.
getExtension() - Method in class com.arc_e_tect.gradle.apionly.subscriber.ChannelSpec: The artifact extension the contracts are published with.
getFiles() - Method in class com.arc_e_tect.gradle.apionly.subscriber.FetchApiSpecTask: Gradle's filesystem operations, used to clear and repopulate the destination.
getGenerateDsl() - Method in class com.arc_e_tect.gradle.apionly.subscriber.UpdateApiOnlySubscriberDslTask: Whether to generate a missing outer DSL block.
getGroupId() - Method in class com.arc_e_tect.gradle.apionly.subscriber.ChannelSpec: The Maven group the contracts are published under.
getGroupId() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Subscription: Overrides ChannelSpec.getGroupId() for this one target.
getInto() - Method in class com.arc_e_tect.gradle.apionly.subscriber.FetchApiSpecTask: Where the documents are unpacked to.
getInto() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Subscription: Where the fetched documents land.
getInto() - Method in class com.arc_e_tect.gradle.apionly.subscriber.VerifyApiSpecTask: Where the fetched documents are, and are checked.
getLockfile() - Method in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberExtension: Where the resolved versions and file hashes are recorded.
getLockfile() - Method in class com.arc_e_tect.gradle.apionly.subscriber.FetchApiSpecTask: The lockfile this task records what it unpacked in.
getLockfile() - Method in class com.arc_e_tect.gradle.apionly.subscriber.VerifyApiSpecTask: The lockfile the fetched documents are checked against.
getName() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Subscription: The name this subscription is keyed by in its container.
getOpenapi() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Subscription: The fetched OpenAPI document.
getSubscriptions() - Method in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberExtension: Every declared subscription, keyed by target name.
getTarget() - Method in class com.arc_e_tect.gradle.apionly.subscriber.FetchApiSpecTask: The contract being fetched.
getTarget() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Subscription: The contract this subscription is for.
getTarget() - Method in class com.arc_e_tect.gradle.apionly.subscriber.VerifyApiSpecTask: The contract being checked.
getType() - Method in class com.arc_e_tect.gradle.apionly.subscriber.ChannelSpec: Which kind of channel to resolve through.
getVersion() - Method in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberExtension: The contract version every subscription in this project resolves, unless it sets its own.
getVersion() - Method in class com.arc_e_tect.gradle.apionly.subscriber.FetchApiSpecTask: The version being fetched.
getVersion() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Subscription: The version of this target's contract to build against.

H

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.subscriber.Lockfile.Entry: Returns a hash code value for this object.

I

isClient() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Subscription: Whether this subscription is for an API the project calls, rather than for the contract it implements.

L

Lockfile - Class in com.arc_e_tect.gradle.apionly.subscriber: apionly.lock -- what this project is actually building against.
Lockfile() - Constructor for class com.arc_e_tect.gradle.apionly.subscriber.Lockfile: Creates an empty lockfile.
Lockfile.Entry - Record Class in com.arc_e_tect.gradle.apionly.subscriber: What is locked for one target.
LockfileAccess - Class in com.arc_e_tect.gradle.apionly.subscriber: Serialises access to one project's apionly.lock.
LockfileAccess() - Constructor for class com.arc_e_tect.gradle.apionly.subscriber.LockfileAccess: Creates the service.

M

Manifest - Class in com.arc_e_tect.gradle.apionly.subscriber: The manifest.json the Publisher ships inside every archive.

N

NAME - Static variable in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberExtension: The name used to register this extension in a consumer build.

P

put(Lockfile.Entry) - Method in class com.arc_e_tect.gradle.apionly.subscriber.Lockfile: Adds or replaces the entry for a target.

R

read(File) - Static method in class com.arc_e_tect.gradle.apionly.subscriber.Lockfile: Reads a lockfile, or returns an empty one if it does not exist.
read(File) - Static method in class com.arc_e_tect.gradle.apionly.subscriber.Manifest: Reads the manifest from a fetched archive.

S

sha256(File) - Static method in class com.arc_e_tect.gradle.apionly.subscriber.Lockfile: The SHA-256 of a file, lowercase hexadecimal.
subscribe(String) - Method in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberExtension: Declares the contract this project implements, without configuring it.
subscribe(String, Action<? super Subscription>) - Method in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberExtension: Declares the contract this project implements, and configures it.
subscribeAsClient(String) - Method in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberExtension: Declares an API this project calls, without configuring it.
subscribeAsClient(String, Action<? super Subscription>) - Method in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberExtension: Declares an API this project calls, and configures it.
subscription(String) - Method in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberExtension: Looks up a declared subscription, so a build file can wire its documents into whatever consumes them.
Subscription - Class in com.arc_e_tect.gradle.apionly.subscriber: One subscribed contract: which target, at which version, landing where.
Subscription(String, ObjectFactory) - Constructor for class com.arc_e_tect.gradle.apionly.subscriber.Subscription: Creates a subscription for one target.

T

target() - Method in record class com.arc_e_tect.gradle.apionly.subscriber.Lockfile.Entry: Returns the value of the target record component.
target() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Manifest: The contract this archive holds.
targets() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Lockfile: Every target with an entry, in sorted order.
toString() - Method in record class com.arc_e_tect.gradle.apionly.subscriber.Lockfile.Entry: Returns a string representation of this record class.

U

UPDATE_DSL_TASK - Static variable in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberPlugin: The DSL-updating task registered by this plugin.
UpdateApiOnlySubscriberDslTask - Class in com.arc_e_tect.gradle.apionly.subscriber: Adds missing apiOnlySubscriber DSL properties to a consumer's build.gradle, using their real plugin defaults.
UpdateApiOnlySubscriberDslTask() - Constructor for class com.arc_e_tect.gradle.apionly.subscriber.UpdateApiOnlySubscriberDslTask: Creates a new task instance.
updateDsl() - Method in class com.arc_e_tect.gradle.apionly.subscriber.UpdateApiOnlySubscriberDslTask: Updates the consumer build file, keeping a byte-for-byte backup before writing.

V

verify() - Method in class com.arc_e_tect.gradle.apionly.subscriber.VerifyApiSpecTask: Fails when a fetched contract no longer matches what was locked.
VERIFY_TASK - Static variable in class com.arc_e_tect.gradle.apionly.subscriber.ApiOnlySubscriberPlugin: The aggregate task that checks every fetched contract: "verifyApiSpec".
VerifyApiSpecTask - Class in com.arc_e_tect.gradle.apionly.subscriber: Fails when a fetched contract no longer matches what was locked.
VerifyApiSpecTask() - Constructor for class com.arc_e_tect.gradle.apionly.subscriber.VerifyApiSpecTask: Creates the task.
version() - Method in record class com.arc_e_tect.gradle.apionly.subscriber.Lockfile.Entry: Returns the value of the version record component.
version() - Method in class com.arc_e_tect.gradle.apionly.subscriber.Manifest: The version the producer published this archive as.

W

write(File) - Method in class com.arc_e_tect.gradle.apionly.subscriber.Lockfile: Writes the lockfile, with targets and their files in sorted order.

A C E F G H I L M N P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values