Package io.jmix.awsfs

Class AwsFileStorage

java.lang.Object

io.jmix.awsfs.AwsFileStorage

All Implemented Interfaces:

FileStorage

@Component("awsfs_FileStorage")
public class AwsFileStorage
extends Object
implements FileStorage

Field Summary

Fields

Modifier and Type	Field	Description
protected String	accessKey
protected String	bucket
protected int	chunkSize
protected String	endpointUrl
protected AwsFileStorageProperties	properties
protected String	region
protected AtomicReference<software.amazon.awssdk.services.s3.S3Client>	s3ClientReference
protected String	secretAccessKey
protected String	storageName
protected TimeSource	timeSource

Constructor Summary

Constructors

Constructor	Description
AwsFileStorage()
AwsFileStorage(String storageName)
AwsFileStorage(String storageName, String accessKey, String secretAccessKey, String region, String bucket, int chunkSize, String endpointUrl)	Optional constructor that allows you to override AwsFileStorageProperties.

Method Summary

Modifier and Type	Method	Description
protected String	createDateDir()
protected String	createFileKey(String fileName)
protected String	createUuidFilename(String fileName)
boolean	fileExists(FileRef reference)	Tests whether the file denoted by this file reference exists.
protected software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	getAwsCredentialsProvider()
String	getStorageName()	Returns the name of this storage, which will be saved in FileRefs.
protected void	initS3Client(org.springframework.boot.context.event.ApplicationStartedEvent event)
InputStream	openStream(FileRef reference)	Returns an input stream to load a file contents.
protected void	refreshProperties()
void	refreshS3Client()
void	removeFile(FileRef reference)	Removes a file from the file storage.
FileRef	saveStream(String fileName, InputStream inputStream)	Saves an InputStream contents into the file storage.
void	setAccessKey(String accessKey)
void	setBucket(String bucket)
void	setChunkSize(int chunkSize)
void	setEndpointUrl(String endpointUrl)
void	setRegion(String region)
void	setSecretAccessKey(String secretAccessKey)

Methods inherited from class java.lang.Object

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

Field Details

storageName

protected String storageName

properties

@Autowired
protected AwsFileStorageProperties properties

accessKey

protected String accessKey

secretAccessKey

protected String secretAccessKey

region

protected String region

bucket

protected String bucket

chunkSize

protected int chunkSize

endpointUrl

protected String endpointUrl

timeSource

@Autowired
protected TimeSource timeSource

s3ClientReference

protected AtomicReference<software.amazon.awssdk.services.s3.S3Client> s3ClientReference

Constructor Details

AwsFileStorage

public AwsFileStorage()

AwsFileStorage

public AwsFileStorage(String storageName)

AwsFileStorage

public AwsFileStorage(String storageName,
 String accessKey,
 String secretAccessKey,
 String region,
 String bucket,
 int chunkSize,
 @Nullable
 String endpointUrl)

Optional constructor that allows you to override AwsFileStorageProperties.

Method Details

initS3Client

@EventListener
protected void initS3Client(org.springframework.boot.context.event.ApplicationStartedEvent event)

refreshProperties

protected void refreshProperties()

getAwsCredentialsProvider

protected software.amazon.awssdk.auth.credentials.AwsCredentialsProvider getAwsCredentialsProvider()

refreshS3Client

public void refreshS3Client()

getStorageName

public String getStorageName()

Description copied from interface: FileStorage

Returns the name of this storage, which will be saved in FileRefs.

Each file storage in the application should have a unique name.

Specified by:

getStorageName in interface FileStorage

createFileKey

protected String createFileKey(String fileName)

createDateDir

protected String createDateDir()

createUuidFilename

protected String createUuidFilename(String fileName)

saveStream

public FileRef saveStream(String fileName,
 InputStream inputStream)

Description copied from interface: FileStorage

Saves an InputStream contents into the file storage.

Specified by:

saveStream in interface FileStorage

Parameters:

fileName - file name

inputStream - input stream, must be closed in the calling code

Returns:

file reference

openStream

public InputStream openStream(FileRef reference)

Description copied from interface: FileStorage

Returns an input stream to load a file contents.

Specified by:

openStream in interface FileStorage

Parameters:

reference - file reference

Returns:

input stream, must be closed after use

removeFile

public void removeFile(FileRef reference)

Description copied from interface: FileStorage

Removes a file from the file storage.

Specified by:

removeFile in interface FileStorage

Parameters:

reference - file reference

fileExists

public boolean fileExists(FileRef reference)

Description copied from interface: FileStorage

Tests whether the file denoted by this file reference exists.

Specified by:

fileExists in interface FileStorage

Parameters:

reference - file reference

Returns:

true if the file denoted by this file reference exists

setAccessKey

public void setAccessKey(String accessKey)

setSecretAccessKey

public void setSecretAccessKey(String secretAccessKey)

setRegion

public void setRegion(String region)

setBucket

public void setBucket(String bucket)

setChunkSize

public void setChunkSize(int chunkSize)

setEndpointUrl

public void setEndpointUrl(@Nullable
 String endpointUrl)