Package org.craftercms.commons.spring.resources

Class S3Resource

java.lang.Object

org.craftercms.commons.spring.resources.S3Resource

All Implemented Interfaces:

RangeAwareResource, org.springframework.core.io.InputStreamSource, org.springframework.core.io.Resource

public class S3Resource
extends Object
implements RangeAwareResource

Implementation of Resource for S3 files.

Author:

avasquez

Constructor Summary

Constructors

Constructor	Description
S3Resource(S3ClientCachingFactory clientFactory, S3Profile profile, String key)
S3Resource(S3ClientCachingFactory clientFactory, S3Profile profile, String bucket, String key)

Method Summary

Modifier and Type	Method	Description
long	contentLength()
org.springframework.core.io.Resource	createRelative(String relativePath)
boolean	exists()
protected String	getActualKey()
String	getDescription()
File	getFile()
String	getFilename()
InputStream	getInputStream()
InputStream	getInputStream(long start, long end)	Returns a range of bytes from the resource's content.
URI	getURI()
URL	getURL()
boolean	isOpen()
boolean	isReadable()
long	lastModified()
String	toString()

Methods inherited from class java.lang.Object

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

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

isFile, readableChannel

Constructor Details

S3Resource

public S3Resource(S3ClientCachingFactory clientFactory,
 S3Profile profile,
 String key)

S3Resource

public S3Resource(S3ClientCachingFactory clientFactory,
 S3Profile profile,
 String bucket,
 String key)

Method Details

getActualKey

protected String getActualKey()

exists

public boolean exists()

Specified by:

exists in interface org.springframework.core.io.Resource

isReadable

public boolean isReadable()

Specified by:

isReadable in interface org.springframework.core.io.Resource

isOpen

public boolean isOpen()

Specified by:

isOpen in interface org.springframework.core.io.Resource

getURL

public URL getURL()
           throws IOException

Specified by:

getURL in interface org.springframework.core.io.Resource

Throws:

IOException

getURI

public URI getURI()
           throws IOException

Specified by:

getURI in interface org.springframework.core.io.Resource

Throws:

IOException

getFile

public File getFile()
             throws IOException

Specified by:

getFile in interface org.springframework.core.io.Resource

Throws:

IOException

contentLength

public long contentLength()
                   throws IOException

Specified by:

contentLength in interface org.springframework.core.io.Resource

Throws:

IOException

lastModified

public long lastModified()
                  throws IOException

Specified by:

lastModified in interface org.springframework.core.io.Resource

Throws:

IOException

createRelative

public org.springframework.core.io.Resource createRelative(String relativePath)
                                                    throws IOException

Specified by:

createRelative in interface org.springframework.core.io.Resource

Throws:

IOException

getFilename

public String getFilename()

Specified by:

getFilename in interface org.springframework.core.io.Resource

getDescription

public String getDescription()

Specified by:

getDescription in interface org.springframework.core.io.Resource

getInputStream

public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface org.springframework.core.io.InputStreamSource

Throws:

IOException

getInputStream

public InputStream getInputStream(long start,
 long end)
                           throws IOException

Description copied from interface: RangeAwareResource

Returns a range of bytes from the resource's content.

Specified by:

getInputStream in interface RangeAwareResource

Parameters:

start - the start of the range

end - the end of the range

Returns:

an input stream with the content range

Throws:

IOException - if an IO error occurs

toString

public String toString()

Overrides:

toString in class Object