Package io.jenkins.plugins.artifact_manager_jclouds

Class BlobStoreProvider

java.lang.Object

hudson.model.AbstractDescribableImpl<BlobStoreProvider>

io.jenkins.plugins.artifact_manager_jclouds.BlobStoreProvider

All Implemented Interfaces:

ExtensionPoint, Describable<BlobStoreProvider>, Serializable

Direct Known Subclasses:

S3BlobStore

@Restricted(org.kohsuke.accmod.restrictions.Beta.class)
public abstract class BlobStoreProvider
extends AbstractDescribableImpl<BlobStoreProvider>
implements ExtensionPoint, Serializable

Provider for blob stores usable for artifact storage, backed by the AWS SDK. An instance will be copied into a build record together with any fields it defines.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BlobStoreProvider.HttpMethod

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
BlobStoreProvider()

Method Summary

Modifier and Type	Method	Description
Map<String,URL>	artifactUrls(Map<String,String> artifacts, Map<String,String> contentTypes, String key)
protected String	getBlobPath(String key, String path)
abstract software.amazon.awssdk.services.s3.S3Client	getClient()	Creates a client usable for working with the blob store.
abstract String	getContainer()	A constant for the blob container name to use.
BlobStoreProviderDescriptor	getDescriptor()
abstract String	getPrefix()	A constant for the blob path prefix to use.
abstract boolean	isDeleteArtifacts()	A constant to define whether we should delete artifacts or leave them to be managed on the blob service side.
abstract boolean	isDeleteStashes()	A constant to define whether we should delete stashes or leave them to be managed on the blob service side.
abstract URL	toExternalURL(String container, String key, String contentType, BlobStoreProvider.HttpMethod httpMethod)	Generate a URL valid for downloading OR uploading the blob for a limited period of time
abstract URI	toURI(String container, String key)	Get a provider-specific URI.

Methods inherited from class java.lang.Object

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

Constructor Details

BlobStoreProvider

public BlobStoreProvider()

Method Details

getPrefix

@NonNull
public abstract String getPrefix()

A constant for the blob path prefix to use.

getContainer

@NonNull
public abstract String getContainer()

A constant for the blob container name to use.

isDeleteArtifacts

public abstract boolean isDeleteArtifacts()

A constant to define whether we should delete artifacts or leave them to be managed on the blob service side.

isDeleteStashes

public abstract boolean isDeleteStashes()

A constant to define whether we should delete stashes or leave them to be managed on the blob service side.

getClient

@NonNull
public abstract software.amazon.awssdk.services.s3.S3Client getClient()
                                                               throws IOException

Creates a client usable for working with the blob store. Callers are responsible for closing it.

Throws:

IOException

toURI

@NonNull
public abstract URI toURI(@NonNull
 String container,
 @NonNull
 String key)

Get a provider-specific URI.

Parameters:

container - container where this exists.

key - fully qualified name relative to the container.

Returns:

the URI

toExternalURL

@NonNull
public abstract URL toExternalURL(@NonNull
 String container,
 @NonNull
 String key,
 @CheckForNull
 String contentType,
 @NonNull
 BlobStoreProvider.HttpMethod httpMethod)
                           throws IOException

Generate a URL valid for downloading OR uploading the blob for a limited period of time

Parameters:

container - container where the blob exists (or will exist).

key - fully qualified name relative to the container.

contentType - content type to associate with the object; only relevant for uploads, may be null otherwise.

httpMethod - HTTP method to create a URL for (downloads or uploads)

Returns:

the URL

Throws:

IOException

getDescriptor

public BlobStoreProviderDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<BlobStoreProvider>

artifactUrls

public Map<String,URL> artifactUrls(Map<String,String> artifacts,
 Map<String,String> contentTypes,
 String key)
                             throws IOException

Throws:

IOException

getBlobPath

protected String getBlobPath(String key,
 String path)