Package org.eclipse.hawkbit.artifact.urlresolver

Interface ArtifactUrlResolver

All Known Implementing Classes:

PropertyBasedArtifactUrlResolver

public interface ArtifactUrlResolver

Interface declaration of the ArtifactUrlResolver which generates the URLs to specific artifacts.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ArtifactUrlResolver.ApiType	hawkBit API type.
static final record	ArtifactUrlResolver.DownloadDescriptor	Container for variables available to the ArtifactUrlResolver.

Method Summary

Modifier and Type	Method	Description
List<ArtifactUrl>	getUrls(ArtifactUrlResolver.DownloadDescriptor downloadDescriptor, ArtifactUrlResolver.ApiType api)	Returns a generated download URL for a given artifact parameters for a specific protocol.
List<ArtifactUrl>	getUrls(ArtifactUrlResolver.DownloadDescriptor downloadDescriptor, ArtifactUrlResolver.ApiType api, URI requestUri)	Returns a generated download URL for a given artifact parameters for a specific protocol.

Method Details

getUrls

List<ArtifactUrl> getUrls(ArtifactUrlResolver.DownloadDescriptor downloadDescriptor,
 ArtifactUrlResolver.ApiType api)

Returns a generated download URL for a given artifact parameters for a specific protocol.

Parameters:

downloadDescriptor - data for URL generation

api - given protocol that URL needs to support

Returns:

a URL for the given artifact parameters in a given protocol

getUrls

List<ArtifactUrl> getUrls(ArtifactUrlResolver.DownloadDescriptor downloadDescriptor,
 ArtifactUrlResolver.ApiType api,
 URI requestUri)

Returns a generated download URL for a given artifact parameters for a specific protocol.

Parameters:

downloadDescriptor - data for URL generation

api - given protocol that URL needs to support

requestUri - of the request that allows the handler to align the generated URL to the original request.

Returns:

a URL for the given artifact parameters in a given protocol