Class AmazonS3Module

java.lang.Object

ecmwf.common.ectrans.TransferModule

ecmwf.common.ectrans.module.AmazonS3Module

All Implemented Interfaces:

Closeable, AutoCloseable

public final class AmazonS3Module
extends TransferModule

The Class AmazonS3Module.

Constructor Summary

Constructors

Constructor	Description
AmazonS3Module()

Method Summary

Modifier and Type	Method	Description
void	close()	Close.
void	connect(String location, ECtransSetup setup)	Connect.
void	del(String name)	Delete by name.
InputStream	get(String name, long posn)	Gets the input stream to read the file given by name starting at posn.
int	getPort(ECtransSetup setup)	Gets the port from the setup.
String	getStatus()	Gets the current status of the transfer module.
byte[]	listAsByteArray(String directory, String pattern)	Default implementation to provide the list as a GZIPed byte array.
String[]	listAsStringArray(String directory, String pattern)	List as a string array.
void	mkdir(String directory)	Make directory by name.
boolean	put(InputStream in, String name, long posn, long size)	Write the content of the file given by its name, starting at position posn and writing to the provided input stream.
OutputStream	put(String name, long posn, long size)	Provide an output stream to write the content of the file given by its name starting at position posn.
void	rmdir(String directory)	Remove directory by name.
long	size(String name)	Give the size of the file given by its name.
void	updateSocketStatistics()	Force an update of the statistics from the underlying socket.

Methods inherited from class ecmwf.common.ectrans.TransferModule

check, containsAttribute, copy, delegateChecksum, get, getAttribute, getAttribute, getAvailable, getClearPassword, getClosedOnError, getCookie, getDebug, getECtransDestination, getECtransModule, getECUser, getMSUser, getRemoteProvider, list, move, preGet, prePut, setAttribute, setAttribute, setAvailable, setClosedOnError, setDebug, setInputFilter, setInputMd5, setInputSize, setOutputFilter

Methods inherited from class java.lang.Object

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

Constructor Details

AmazonS3Module

public AmazonS3Module()

Method Details

getStatus

public String getStatus()

Gets the current status of the transfer module. Gets the status.

Overrides:

getStatus in class TransferModule

Returns:

the status

getPort

public int getPort(ECtransSetup setup)

Gets the port from the setup. Gets the port.

Overrides:

getPort in class TransferModule

Parameters:

setup - the setup

Returns:

the port

updateSocketStatistics

public void updateSocketStatistics()
                            throws IOException

Force an update of the statistics from the underlying socket. Update socket statistics.

Overrides:

updateSocketStatistics in class TransferModule

Throws:

IOException - Signals that an I/O exception has occurred.

connect

public void connect(String location,
 ECtransSetup setup)
             throws IOException

Connect. Connect.

Specified by:

connect in class TransferModule

Parameters:

location - the location

setup - the setup

Throws:

IOException

del

public void del(String name)
         throws IOException

Delete by name. Del.

Specified by:

del in class TransferModule

Parameters:

name - the name

Throws:

IOException - Signals that an I/O exception has occurred.

put

public boolean put(InputStream in,
 String name,
 long posn,
 long size)
            throws IOException

Write the content of the file given by its name, starting at position posn and writing to the provided input stream. By default, doing nothing and returning false. Put.

Overrides:

put in class TransferModule

Parameters:

in - the in

name - the name

posn - the posn

size - the size

Returns:

true, if successful

Throws:

IOException - Signals that an I/O exception has occurred.

put

public OutputStream put(String name,
 long posn,
 long size)
                 throws IOException

Provide an output stream to write the content of the file given by its name starting at position posn. Put.

Specified by:

put in class TransferModule

Parameters:

name - the name

posn - the posn

size - the size

Returns:

the output stream

Throws:

IOException - Signals that an I/O exception has occurred.

get

public InputStream get(String name,
 long posn)
                throws IOException

Gets the input stream to read the file given by name starting at posn. Gets the.

Specified by:

get in class TransferModule

Parameters:

name - the name

posn - the posn

Returns:

the input stream

Throws:

IOException - Signals that an I/O exception has occurred.

size

public long size(String name)
          throws IOException

Give the size of the file given by its name. Size.

Specified by:

size in class TransferModule

Parameters:

name - the name

Returns:

the long

Throws:

IOException - Signals that an I/O exception has occurred.

mkdir

public void mkdir(String directory)
           throws IOException

Make directory by name. Mkdir.

Overrides:

mkdir in class TransferModule

Parameters:

directory - the dir

Throws:

IOException - Signals that an I/O exception has occurred.

rmdir

public void rmdir(String directory)
           throws IOException

Remove directory by name. Rmdir.

Overrides:

rmdir in class TransferModule

Parameters:

directory - the dir

Throws:

IOException - Signals that an I/O exception has occurred.

listAsStringArray

public String[] listAsStringArray(String directory,
 String pattern)
                           throws IOException

List as a string array. List as string array.

Overrides:

listAsStringArray in class TransferModule

Parameters:

directory - the directory

pattern - the pattern

Returns:

the string[]

Throws:

IOException - Signals that an I/O exception has occurred.

listAsByteArray

public byte[] listAsByteArray(String directory,
 String pattern)
                       throws IOException

Default implementation to provide the list as a GZIPed byte array. The implementation should give a better implementation as this one is relying on the non optimal listAsStringArray method by default. List as byte array.

Overrides:

listAsByteArray in class TransferModule

Parameters:

directory - the directory

pattern - the pattern

Returns:

the bytes

Throws:

IOException - Signals that an I/O exception has occurred.

close

public void close()
           throws IOException

Close.

Throws:

IOException