Package io.awspring.cloud.s3

Class S3Resource

java.lang.Object

org.springframework.core.io.AbstractResource

io.awspring.cloud.s3.S3Resource

All Implemented Interfaces:

InputStreamSource, Resource, WritableResource

public class S3Resource
extends AbstractResource
implements WritableResource

Resource implementation for S3 objects.

Since:

3.0

Author:

Agim Emruli, Alain Sahli, Maciej Walkowiak, Yuki Yoshida

Field Summary

Fields

Modifier and Type	Field	Description
protected final Location	location
protected final software.amazon.awssdk.services.s3.S3Client	s3Client
protected final S3OutputStreamProvider	s3OutputStreamProvider

Constructor Summary

Constructors

Constructor	Description
S3Resource(Location location, software.amazon.awssdk.services.s3.S3Client s3Client, S3OutputStreamProvider s3OutputStreamProvider)
S3Resource(String bucket, String key, software.amazon.awssdk.services.s3.S3Client s3Client, S3OutputStreamProvider s3OutputStreamProvider)
S3Resource(String location, software.amazon.awssdk.services.s3.S3Client s3Client, S3OutputStreamProvider s3OutputStreamProvider)

Method Summary

Modifier and Type	Method	Description
long	contentLength()
String	contentType()
static S3Resource	create(String location, software.amazon.awssdk.services.s3.S3Client s3Client, S3OutputStreamProvider s3OutputStreamProvider)
S3Resource	createRelative(String relativePath)
boolean	exists()
String	getDescription()
File	getFile()
String	getFilename()
InputStream	getInputStream()
Location	getLocation()
OutputStream	getOutputStream()
URL	getURL()
long	lastModified()
Map<String,String>	metadata()
void	setObjectMetadata(ObjectMetadata objectMetadata)

Methods inherited from class org.springframework.core.io.AbstractResource

equals, getFileForLastModifiedCheck, getURI, hashCode, isFile, isOpen, isReadable, readableChannel, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.core.io.Resource

getURI, isFile, isOpen, isReadable, readableChannel

Methods inherited from interface org.springframework.core.io.WritableResource

isWritable, writableChannel

Field Details

location

protected final Location location

s3Client

protected final software.amazon.awssdk.services.s3.S3Client s3Client

s3OutputStreamProvider

protected final S3OutputStreamProvider s3OutputStreamProvider

Constructor Details

S3Resource

public S3Resource(String location,
 software.amazon.awssdk.services.s3.S3Client s3Client,
 S3OutputStreamProvider s3OutputStreamProvider)

S3Resource

public S3Resource(String bucket,
 String key,
 software.amazon.awssdk.services.s3.S3Client s3Client,
 S3OutputStreamProvider s3OutputStreamProvider)

S3Resource

public S3Resource(Location location,
 software.amazon.awssdk.services.s3.S3Client s3Client,
 S3OutputStreamProvider s3OutputStreamProvider)

Method Details

create

@Nullable
public static S3Resource create(String location,
 software.amazon.awssdk.services.s3.S3Client s3Client,
 S3OutputStreamProvider s3OutputStreamProvider)

getURL

public URL getURL()
           throws IOException

Specified by:

getURL in interface Resource

Overrides:

getURL in class AbstractResource

Throws:

IOException

getDescription

public String getDescription()

Specified by:

getDescription in interface Resource

createRelative

public S3Resource createRelative(String relativePath)

Specified by:

createRelative in interface Resource

Overrides:

createRelative in class AbstractResource

getInputStream

public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface InputStreamSource

Throws:

IOException

contentType

public String contentType()

setObjectMetadata

public void setObjectMetadata(@Nullable
 ObjectMetadata objectMetadata)

exists

public boolean exists()

Specified by:

exists in interface Resource

Overrides:

exists in class AbstractResource

contentLength

public long contentLength()
                   throws IOException

Specified by:

contentLength in interface Resource

Overrides:

contentLength in class AbstractResource

Throws:

IOException

lastModified

public long lastModified()
                  throws IOException

Specified by:

lastModified in interface Resource

Overrides:

lastModified in class AbstractResource

Throws:

IOException

getFile

public File getFile()
             throws IOException

Specified by:

getFile in interface Resource

Overrides:

getFile in class AbstractResource

Throws:

IOException

metadata

public Map<String,String> metadata()

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Specified by:

getOutputStream in interface WritableResource

Throws:

IOException

getFilename

public String getFilename()

Specified by:

getFilename in interface Resource

Overrides:

getFilename in class AbstractResource

getLocation

public Location getLocation()