thredds.inventory.s3

Class MFileS3

java.lang.Object

thredds.inventory.s3.MFileS3

All Implemented Interfaces:

java.lang.Comparable<MFile>, MFile

public class MFileS3
extends java.lang.Object
implements MFile

Implements MFile for objects stored on AWS S3 compatible object stores.

Since:

5.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MFileS3.Provider

Constructor Summary

Constructors

Constructor and Description
MFileS3(CdmS3Uri s3Uri)
MFileS3(CdmS3Uri s3Uri, long len, long lm)
MFileS3(java.lang.String s3Uri)
MFileS3(java.lang.String s3Uri, long len, long lm)

Method Summary

Modifier and Type	Method and Description
int	compareTo(MFile o)
boolean	equals(java.lang.Object o)
boolean	exists() Check if the MFile exists
java.lang.Object	getAuxInfo()
MFileS3	getChild(java.lang.String newFilename) Get child MFile of this MFile
software.amazon.awssdk.core.ResponseInputStream<software.amazon.awssdk.services.s3.model.GetObjectResponse>	getInputStream() Get the MFile InputStream
long	getLastModified() Get time of last modification at the time the MFile object was created
long	getLength() Size of file in bytes
java.lang.String	getName() The name is the farthest element from the root in the directory hierarchy.
MFile	getParent() Get the parent of this
java.lang.String	getPath() Get full path name, replace \\ with /
int	hashCode()
boolean	isDirectory()
java.lang.String	relativize(MFile other) Construct a relative key path (as if it were a file path) between this MFile and a given MFile.
void	setAuxInfo(java.lang.Object auxInfo)
long	updateLastModified() Update last modified by fetching from a head request
long	updateLength() Update file length by fetching from a head request
void	writeToStream(java.io.OutputStream outputStream) Write the MFile to an OutputStream
void	writeToStream(java.io.OutputStream outputStream, long offset, long maxBytes) Write the MFile to an OutputStream

Methods inherited from class java.lang.Object

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

Methods inherited from interface thredds.inventory.MFile

isReadable, isZipFile

Constructor Detail

MFileS3

public MFileS3(java.lang.String s3Uri)
        throws java.io.IOException

Throws:

java.io.IOException

MFileS3

public MFileS3(CdmS3Uri s3Uri)

MFileS3

public MFileS3(java.lang.String s3Uri,
               long len,
               long lm)
        throws java.io.IOException

Throws:

java.io.IOException

MFileS3

public MFileS3(CdmS3Uri s3Uri,
               long len,
               long lm)

Method Detail

getLastModified

public long getLastModified()

Description copied from interface: MFile

Get time of last modification at the time the MFile object was created

Specified by:

getLastModified in interface MFile

Returns:

time of last modification in Unix time (msecs since reference), or -1 if unknown

updateLastModified

public long updateLastModified()

Update last modified by fetching from a head request

getLength

public long getLength()

Description copied from interface: MFile

Size of file in bytes

Specified by:

getLength in interface MFile

Returns:

Size of file in bytes or -1 if unknown

updateLength

public long updateLength()

Update file length by fetching from a head request

isDirectory

public boolean isDirectory()

Specified by:

isDirectory in interface MFile

getPath

public java.lang.String getPath()

Description copied from interface: MFile

Get full path name, replace \\ with /

Specified by:

getPath in interface MFile

Returns:

full path name

getName

public java.lang.String getName()

Description copied from interface: MFile

The name is the farthest element from the root in the directory hierarchy.

Specified by:

getName in interface MFile

Returns:

the file name

getParent

@Nullable
public MFile getParent()
                          throws java.io.IOException

Description copied from interface: MFile

Get the parent of this

Specified by:

getParent in interface MFile

Returns:

the parent or null

Throws:

java.io.IOException

compareTo

public int compareTo(MFile o)

Specified by:

compareTo in interface java.lang.Comparable<MFile>

Specified by:

compareTo in interface MFile

getAuxInfo

@Nullable
public java.lang.Object getAuxInfo()

Specified by:

getAuxInfo in interface MFile

setAuxInfo

public void setAuxInfo(java.lang.Object auxInfo)

Specified by:

setAuxInfo in interface MFile

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

exists

public boolean exists()

Description copied from interface: MFile

Check if the MFile exists

Specified by:

exists in interface MFile

Returns:

true if the MFile exists, else false

getInputStream

public software.amazon.awssdk.core.ResponseInputStream<software.amazon.awssdk.services.s3.model.GetObjectResponse> getInputStream()

Description copied from interface: MFile

Get the MFile InputStream

Specified by:

getInputStream in interface MFile

Returns:

the MFile InputStream

writeToStream

public void writeToStream(java.io.OutputStream outputStream)
                   throws java.io.IOException

Description copied from interface: MFile

Write the MFile to an OutputStream

Specified by:

writeToStream in interface MFile

Parameters:

outputStream - the OutputStream the MFile contents should be written to

Throws:

java.io.IOException

writeToStream

public void writeToStream(java.io.OutputStream outputStream,
                          long offset,
                          long maxBytes)
                   throws java.io.IOException

Description copied from interface: MFile

Write the MFile to an OutputStream

Specified by:

writeToStream in interface MFile

Parameters:

outputStream - the OutputStream the MFile contents should be written to

offset - the index of the first byte to write out

maxBytes - the maximum number of bytes to copy

Throws:

java.io.IOException

getChild

@Nullable
public MFileS3 getChild(java.lang.String newFilename)

Description copied from interface: MFile

Get child MFile of this MFile

Specified by:

getChild in interface MFile

Parameters:

newFilename - the relative file path of the new MFile

Returns:

the new MFile or null if the file can't be resolved

relativize

public java.lang.String relativize(MFile other)

Construct a relative key path (as if it were a file path) between this MFile and a given MFile. They must have same delimiter and bucket, otherwise the path returned is empty.

Specified by:

relativize in interface MFile

Parameters:

other - the MFile to relativize against this MFile's path

Returns:

the resulting relative path as a String, or an empty path if both paths are equal