Package io.jenkins.plugins.artifact_manager_jclouds.s3

Class S3BlobStoreConfig

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

io.jenkins.plugins.aws.global_configuration.AbstractAwsGlobalConfiguration

io.jenkins.plugins.artifact_manager_jclouds.s3.S3BlobStoreConfig

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster

@Symbol("s3")
@Extension
public final class S3BlobStoreConfig
extends io.jenkins.plugins.aws.global_configuration.AbstractAwsGlobalConfiguration

Store the S3BlobStore configuration to save it on a separate file. This make that the change of container does not affected to the Artifact functionality, you could change the container and it would still work if both container contains the same data.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
S3BlobStoreConfig()

Method Summary

Modifier and Type	Method	Description
com.amazonaws.services.s3.model.Bucket	createS3Bucket(String name)	create an S3 Bucket.
FormValidation	doCheckContainer(String container)
FormValidation	doCheckCustomEndpoint(String customEndpoint)
FormValidation	doCheckCustomSigningRegion(String customSigningRegion)
FormValidation	doCheckPrefix(String prefix)
FormValidation	doCreateS3Bucket(String container, boolean disableSessionToken)
FormValidation	doValidateS3BucketConfig(String container, String prefix, boolean useHttp, boolean useTransferAcceleration, boolean usePathStyleUrl, boolean disableSessionToken, String customEndpoint, String customSigningRegion)
static S3BlobStoreConfig	get()
com.amazonaws.services.s3.AmazonS3ClientBuilder	getAmazonS3ClientBuilderWithCredentials()
String	getContainer()
String	getCustomEndpoint()
String	getCustomSigningRegion()
boolean	getDisableSessionToken()
String	getDisplayName()
String	getPrefix()
String	getResolvedCustomEndpoint()
boolean	getUseHttp()
boolean	getUsePathStyleUrl()
boolean	getUseTransferAcceleration()
boolean	isDeleteArtifacts()
boolean	isDeleteStashes()
void	setContainer(String container)
void	setCustomEndpoint(String customEndpoint)
void	setCustomSigningRegion(String customSigningRegion)
void	setDisableSessionToken(boolean disableSessionToken)
void	setPrefix(String prefix)
void	setUseHttp(boolean useHttp)
void	setUsePathStyleUrl(boolean usePathStyleUrl)
void	setUseTransferAcceleration(boolean useTransferAcceleration)

Methods inherited from class io.jenkins.plugins.aws.global_configuration.AbstractAwsGlobalConfiguration

getCategory, processExceptionMessage

Methods inherited from class jenkins.model.GlobalConfiguration

all, configure, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

S3BlobStoreConfig

public S3BlobStoreConfig()

Method Detail

getContainer

public String getContainer()

setContainer

@DataBoundSetter
public void setContainer(String container)

getPrefix

public String getPrefix()

setPrefix

@DataBoundSetter
public void setPrefix(String prefix)

isDeleteArtifacts

public boolean isDeleteArtifacts()

isDeleteStashes

public boolean isDeleteStashes()

getUsePathStyleUrl

public boolean getUsePathStyleUrl()

setUsePathStyleUrl

@DataBoundSetter
public void setUsePathStyleUrl(boolean usePathStyleUrl)

getUseHttp

public boolean getUseHttp()

setUseHttp

@DataBoundSetter
public void setUseHttp(boolean useHttp)

getUseTransferAcceleration

public boolean getUseTransferAcceleration()

setUseTransferAcceleration

@DataBoundSetter
public void setUseTransferAcceleration(boolean useTransferAcceleration)

getDisableSessionToken

public boolean getDisableSessionToken()

setDisableSessionToken

@DataBoundSetter
public void setDisableSessionToken(boolean disableSessionToken)

getCustomEndpoint

public String getCustomEndpoint()

setCustomEndpoint

@DataBoundSetter
public void setCustomEndpoint(String customEndpoint)

getResolvedCustomEndpoint

public String getResolvedCustomEndpoint()

getCustomSigningRegion

public String getCustomSigningRegion()

setCustomSigningRegion

@DataBoundSetter
public void setCustomSigningRegion(String customSigningRegion)

getDisplayName

@NonNull
public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<GlobalConfiguration>

get

@NonNull
public static S3BlobStoreConfig get()

getAmazonS3ClientBuilderWithCredentials

public com.amazonaws.services.s3.AmazonS3ClientBuilder getAmazonS3ClientBuilderWithCredentials()
                                                                                        throws IOException

Throws:

IOException

doCheckContainer

public FormValidation doCheckContainer(@QueryParameter
                                       String container)

doCheckPrefix

public FormValidation doCheckPrefix(@QueryParameter
                                    String prefix)

doCheckCustomSigningRegion

public FormValidation doCheckCustomSigningRegion(@QueryParameter
                                                 String customSigningRegion)

doCheckCustomEndpoint

public FormValidation doCheckCustomEndpoint(@QueryParameter
                                            String customEndpoint)

createS3Bucket

public com.amazonaws.services.s3.model.Bucket createS3Bucket(String name)
                                                      throws IOException

create an S3 Bucket.

Parameters:

name - name of the S3 Bucket.

Returns:

return the Bucket created.

Throws:

IOException - in case of error obtaining the credentials, in other kind of errors it will throw the runtime exceptions are thrown by createBucket method.

doCreateS3Bucket

public FormValidation doCreateS3Bucket(@QueryParameter
                                       String container,
                                       @QueryParameter
                                       boolean disableSessionToken)

doValidateS3BucketConfig

public FormValidation doValidateS3BucketConfig(@QueryParameter
                                               String container,
                                               @QueryParameter
                                               String prefix,
                                               @QueryParameter
                                               boolean useHttp,
                                               @QueryParameter
                                               boolean useTransferAcceleration,
                                               @QueryParameter
                                               boolean usePathStyleUrl,
                                               @QueryParameter
                                               boolean disableSessionToken,
                                               @QueryParameter
                                               String customEndpoint,
                                               @QueryParameter
                                               String customSigningRegion)