Top Description Fields Constructors Methods
org.eclipse.jgit.lfs.server.s3

public Class S3Config

extends Object
Class Inheritance

Configuration for an Amazon AWS S3 bucket
Since
4.3

Field Summary

Modifier and TypeField and Description
private final String
private final String
private final boolean
private final int
private final String
private final String
private final String
private final String

Constructor Summary

AccessConstructor and Description
public
S3Config(String
S3 API host
hostname
,
String
AWS region
region
,
String
S3 storage bucket
bucket
,
String
S3 storage class
storageClass
,
String
access key for authenticating to AWS
accessKey
,
String
secret key for authenticating to AWS
secretKey
,
int
period in seconds after which requests signed for this bucket will expire
expirationSeconds
,
boolean
if true disable Amazon server certificate and hostname verification
disableSslVerify
)

Constructor for S3Config.

public
S3Config(String
AWS region
region
,
String
S3 storage bucket
bucket
,
String
S3 storage class
storageClass
,
String
access key for authenticating to AWS
accessKey
,
String
secret key for authenticating to AWS
secretKey
,
int
period in seconds after which requests signed for this bucket will expire
expirationSeconds
,
boolean
if true disable Amazon server certificate and hostname verification
disableSslVerify
)

Constructor for S3Config.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

access key for authenticating to AWS
getAccessKey
()

Get the accessKey.

public String

Returns:

Get S3 storage bucket name
getBucket
()

Get the bucket.

public int

Returns:

period in seconds after which requests signed for this bucket will expire
getExpirationSeconds
()

Get the expirationSeconds.

public String

Returns:

Get the S3 API host
getHostname
()

Get the hostname.

public String

Returns:

Get name of AWS region this bucket resides in
getRegion
()

Get the region.

public String

Returns:

secret key for authenticating to AWS
getSecretKey
()

Get the secretKey.

public String

Returns:

S3 storage class to use for objects stored in this bucket
getStorageClass
()

Get the storageClass.

pack-priv boolean

Returns:

true if Amazon server certificate and hostname verification is disabled
isDisableSslVerify
()

Whether SSL verification is disabled

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

accessKeyback to summary
private final String accessKey
bucketback to summary
private final String bucket
disableSslVerifyback to summary
private final boolean disableSslVerify
expirationSecondsback to summary
private final int expirationSeconds
hostnameback to summary
private final String hostname
regionback to summary
private final String region
secretKeyback to summary
private final String secretKey
storageClassback to summary
private final String storageClass

Constructor Detail

S3Configback to summary
public S3Config(String hostname, String region, String bucket, String storageClass, String accessKey, String secretKey, int expirationSeconds, boolean disableSslVerify)

Constructor for S3Config.

Parameters
hostname:String

S3 API host

region:String

AWS region

bucket:String

S3 storage bucket

storageClass:String

S3 storage class

accessKey:String

access key for authenticating to AWS

secretKey:String

secret key for authenticating to AWS

expirationSeconds:int

period in seconds after which requests signed for this bucket will expire

disableSslVerify:boolean

if true disable Amazon server certificate and hostname verification

Since
5.8
S3Configback to summary
public S3Config(String region, String bucket, String storageClass, String accessKey, String secretKey, int expirationSeconds, boolean disableSslVerify)

Constructor for S3Config.

Parameters
region:String

AWS region

bucket:String

S3 storage bucket

storageClass:String

S3 storage class

accessKey:String

access key for authenticating to AWS

secretKey:String

secret key for authenticating to AWS

expirationSeconds:int

period in seconds after which requests signed for this bucket will expire

disableSslVerify:boolean

if true disable Amazon server certificate and hostname verification

Method Detail

getAccessKeyback to summary
public String getAccessKey()

Get the accessKey.

Returns:String

access key for authenticating to AWS

getBucketback to summary
public String getBucket()

Get the bucket.

Returns:String

Get S3 storage bucket name

getExpirationSecondsback to summary
public int getExpirationSeconds()

Get the expirationSeconds.

Returns:int

period in seconds after which requests signed for this bucket will expire

getHostnameback to summary
public String getHostname()

Get the hostname.

Returns:String

Get the S3 API host

Since
5.8
getRegionback to summary
public String getRegion()

Get the region.

Returns:String

Get name of AWS region this bucket resides in

getSecretKeyback to summary
public String getSecretKey()

Get the secretKey.

Returns:String

secret key for authenticating to AWS

getStorageClassback to summary
public String getStorageClass()

Get the storageClass.

Returns:String

S3 storage class to use for objects stored in this bucket

isDisableSslVerifyback to summary
pack-priv boolean isDisableSslVerify()

Whether SSL verification is disabled

Returns:boolean

true if Amazon server certificate and hostname verification is disabled