Package io.jenkins.plugins.artifact_manager_jclouds.s3

Class S3BlobStore

java.lang.Object

hudson.model.AbstractDescribableImpl<BlobStoreProvider>

io.jenkins.plugins.artifact_manager_jclouds.BlobStoreProvider

io.jenkins.plugins.artifact_manager_jclouds.s3.S3BlobStore

All Implemented Interfaces:

ExtensionPoint, Describable<BlobStoreProvider>, Serializable

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class S3BlobStore
extends BlobStoreProvider

Extension that customizes JCloudsBlobStore for AWS S3. Credentials are fetched from the environment, env vars, aws profiles,...

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	S3BlobStore.DescriptorImpl

Nested classes/interfaces inherited from class io.jenkins.plugins.artifact_manager_jclouds.BlobStoreProvider

BlobStoreProvider.HttpMethod

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
S3BlobStore()

Method Summary

Modifier and Type	Method	Description
Map<String,URL>	artifactUrls(Map<String,String> artifacts, Map<String,String> contentTypes, String key)
software.amazon.awssdk.services.s3.S3Client	getClient()	Creates a client usable for working with the blob store.
S3BlobStoreConfig	getConfiguration()
String	getContainer()	A constant for the blob container name to use.
String	getPrefix()	A constant for the blob path prefix to use.
String	getRegion()
software.amazon.awssdk.services.s3.presigner.S3Presigner	getS3Presigner(software.amazon.awssdk.services.s3.S3Client s3Client)
boolean	isDeleteArtifacts()	A constant to define whether we should delete artifacts or leave them to be managed on the blob service side.
boolean	isDeleteStashes()	A constant to define whether we should delete stashes or leave them to be managed on the blob service side.
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
String	toString()
URI	toURI(String container, String key)	Get a provider-specific URI.

Methods inherited from class io.jenkins.plugins.artifact_manager_jclouds.BlobStoreProvider

getBlobPath, getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

S3BlobStore

@DataBoundConstructor
public S3BlobStore()

Method Details

getPrefix

public String getPrefix()

Description copied from class: BlobStoreProvider

A constant for the blob path prefix to use.

Specified by:

getPrefix in class BlobStoreProvider

getContainer

public String getContainer()

Description copied from class: BlobStoreProvider

A constant for the blob container name to use.

Specified by:

getContainer in class BlobStoreProvider

getRegion

public String getRegion()

getConfiguration

public S3BlobStoreConfig getConfiguration()

isDeleteArtifacts

public boolean isDeleteArtifacts()

Description copied from class: BlobStoreProvider

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

Specified by:

isDeleteArtifacts in class BlobStoreProvider

isDeleteStashes

public boolean isDeleteStashes()

Description copied from class: BlobStoreProvider

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

Specified by:

isDeleteStashes in class BlobStoreProvider

getClient

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

Description copied from class: BlobStoreProvider

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

Specified by:

getClient in class BlobStoreProvider

Throws:

IOException

toURI

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

Description copied from class: BlobStoreProvider

Get a provider-specific URI.

Specified by:

toURI in class BlobStoreProvider

Parameters:

container - container where this exists.

key - fully qualified name relative to the container.

Returns:

the URI

getS3Presigner

public software.amazon.awssdk.services.s3.presigner.S3Presigner getS3Presigner(software.amazon.awssdk.services.s3.S3Client s3Client)

toExternalURL

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

Description copied from class: BlobStoreProvider

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

Specified by:

toExternalURL in class BlobStoreProvider

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

See Also:

• Generate a Pre-signed Object URL using AWS SDK for Java

artifactUrls

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

Overrides:

artifactUrls in class BlobStoreProvider

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object