io.github.intisy.gradle.github.api.model

Class ResolutionRequest

java.lang.Object

io.github.intisy.gradle.github.api.model.ResolutionRequest

public final class ResolutionRequest
extends java.lang.Object

A single coordinate to resolve to a jar, naming a release version, a GitHub source branch and commit, an arbitrary git clone URL and ref, or a direct jar URL. Callers construct one via fromRelease(String, String, String), fromSource(String, String, String, String), fromGit(String, String), or fromUrl(String, Map, String) and pass it to JarResolver.resolve(io.github.intisy.gradle.github.api.model.ResolutionRequest).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResolutionRequest.Strategy Which capability a ResolutionRequest is satisfied by.

Method Summary

Modifier and Type	Method and Description
static ResolutionRequest	fromGit(java.lang.String cloneUrl, java.lang.String ref)
static ResolutionRequest	fromRelease(java.lang.String owner, java.lang.String repo, java.lang.String version)
static ResolutionRequest	fromSource(java.lang.String owner, java.lang.String repo, java.lang.String branch, java.lang.String commitSha)
static ResolutionRequest	fromUrl(java.lang.String jarUrl, java.util.Map<java.lang.String,java.lang.String> headers) Same as fromUrl(String, Map, String) with no expected sha256.
static ResolutionRequest	fromUrl(java.lang.String jarUrl, java.util.Map<java.lang.String,java.lang.String> headers, java.lang.String sha256)
java.lang.String	getBranch()
java.lang.String	getCloneUrl()
java.lang.String	getCommitSha()
java.util.Map<java.lang.String,java.lang.String>	getHeaders()
java.lang.String	getJarUrl()
java.lang.String	getOwner()
java.lang.String	getRef()
java.lang.String	getRepo()
java.lang.String	getSha256()
ResolutionRequest.Strategy	getStrategy()
java.lang.String	getVersion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fromRelease

public static ResolutionRequest fromRelease(java.lang.String owner,
                                            java.lang.String repo,
                                            java.lang.String version)

Parameters:

owner - the GitHub account or organization that owns the repository.

repo - the repository name, without the owner prefix.

version - the release tag to resolve.

Returns:

a request that JarResolver.resolve(io.github.intisy.gradle.github.api.model.ResolutionRequest) satisfies from a published release.

Throws:

java.lang.IllegalArgumentException - if any argument is null.

fromSource

public static ResolutionRequest fromSource(java.lang.String owner,
                                           java.lang.String repo,
                                           java.lang.String branch,
                                           java.lang.String commitSha)

Parameters:

owner - the GitHub account or organization that owns the repository.

repo - the repository name, without the owner prefix.

branch - the branch to clone or pull.

commitSha - the commit to build, or null to use the branch's latest commit.

Returns:

a request that JarResolver.resolve(io.github.intisy.gradle.github.api.model.ResolutionRequest) satisfies by building from source.

Throws:

java.lang.IllegalArgumentException - if owner, repo, or branch is null.

fromGit

public static ResolutionRequest fromGit(java.lang.String cloneUrl,
                                        java.lang.String ref)

Parameters:

cloneUrl - the exact URL to clone from; any git host, not just github.com.

ref - the branch, tag, or commit to build, or null for the remote's default branch.

Returns:

a request that JarResolver.resolve(io.github.intisy.gradle.github.api.model.ResolutionRequest) satisfies by cloning and building cloneUrl.

Throws:

java.lang.IllegalArgumentException - if cloneUrl is null.

fromUrl

public static ResolutionRequest fromUrl(java.lang.String jarUrl,
                                        java.util.Map<java.lang.String,java.lang.String> headers)

Same as fromUrl(String, Map, String) with no expected sha256.

Parameters:

jarUrl - the exact URL to download a jar from.

headers - request headers (for example, an auth token) to send with the download; may be null or empty.

Returns:

a request that JarResolver.resolve(io.github.intisy.gradle.github.api.model.ResolutionRequest) satisfies by downloading jarUrl.

Throws:

java.lang.IllegalArgumentException - if jarUrl is null.

fromUrl

public static ResolutionRequest fromUrl(java.lang.String jarUrl,
                                        java.util.Map<java.lang.String,java.lang.String> headers,
                                        java.lang.String sha256)

Parameters:

jarUrl - the exact URL to download a jar from.

headers - request headers (for example, an auth token) to send with the download; may be null or empty.

sha256 - the expected SHA-256 of the downloaded jar, hex-encoded, or null to skip integrity verification.

Returns:

a request that JarResolver.resolve(io.github.intisy.gradle.github.api.model.ResolutionRequest) satisfies by downloading jarUrl.

Throws:

java.lang.IllegalArgumentException - if jarUrl is null.

getOwner

public java.lang.String getOwner()

Returns:

the GitHub account or organization that owns the requested repository, or null for a ResolutionRequest.Strategy.GIT or ResolutionRequest.Strategy.URL request.

getRepo

public java.lang.String getRepo()

Returns:

the requested repository name, without the owner prefix, or null for a ResolutionRequest.Strategy.GIT or ResolutionRequest.Strategy.URL request.

getStrategy

public ResolutionRequest.Strategy getStrategy()

Returns:

which capability this request is satisfied by.

getVersion

public java.lang.String getVersion()

Returns:

the release tag to resolve, or null unless this is a ResolutionRequest.Strategy.RELEASE request.

getBranch

public java.lang.String getBranch()

Returns:

the branch to clone or pull, or null unless this is a ResolutionRequest.Strategy.SOURCE request.

getCommitSha

public java.lang.String getCommitSha()

Returns:

the commit to build, or null unless this is a ResolutionRequest.Strategy.SOURCE request naming one.

getCloneUrl

public java.lang.String getCloneUrl()

Returns:

the exact URL to clone from, or null unless this is a ResolutionRequest.Strategy.GIT request.

getRef

public java.lang.String getRef()

Returns:

the branch, tag, or commit to build, or null unless this is a ResolutionRequest.Strategy.GIT request.

getJarUrl

public java.lang.String getJarUrl()

Returns:

the exact URL to download a jar from, or null unless this is a ResolutionRequest.Strategy.URL request.

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

Returns:

the request headers to send with a ResolutionRequest.Strategy.URL download; never null, empty when none were given or this is not a ResolutionRequest.Strategy.URL request.

getSha256

public java.lang.String getSha256()

Returns:

the expected SHA-256 of the downloaded jar, hex-encoded, or null if none was given or this is not a ResolutionRequest.Strategy.URL request.