Class WebDavModule

java.lang.Object

ecmwf.common.ectrans.TransferModule

ecmwf.common.ectrans.module.WebDavModule

All Implemented Interfaces:

Closeable, AutoCloseable

public final class WebDavModule
extends TransferModule

WebDAV transfer module.

Constructor Summary

Constructors

Constructor	Description
WebDavModule()

Method Summary

Modifier and Type	Method	Description
void	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.
String	getConnectedRemoteAddress()	Gets the real IP address of the remote host this module most recently connected to, if the underlying protocol implementation tracks it.
int	getPort(ECtransSetup setup)	Gets the port from the setup.
void	list(String directory, String pattern, OutputStream out)	Default implementation to write the list to the provided output stream.
String[]	listAsStringArray(String directory, String pattern)	List as a string array.
void	mkdir(String dir)	Make directory by name.
void	move(String source, String target)	Move source to target.
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 dir)	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 TransferModule

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

Methods inherited from class Object

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

Constructor Details

WebDavModule

public WebDavModule()

Method Details

updateSocketStatistics

public void updateSocketStatistics()
                            throws IOException

Description copied from class: TransferModule

Force an update of the statistics from the underlying socket.

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

Description copied from class: TransferModule

Connect.

Specified by:

connect in class TransferModule

Parameters:

location - the location

setup - the setup

Throws:

IOException

getPort

public int getPort(ECtransSetup setup)

Description copied from class: TransferModule

Gets the port from the setup.

Overrides:

getPort in class TransferModule

Parameters:

setup - the setup

Returns:

the port

del

public void del(String name)
         throws IOException

Description copied from class: TransferModule

Delete by name.

Specified by:

del in class TransferModule

Parameters:

name - the name

Throws:

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

get

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

Description copied from class: TransferModule

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

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.

put

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

Description copied from class: TransferModule

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.

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

Description copied from class: TransferModule

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

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.

size

public long size(String name)
          throws IOException

Description copied from class: TransferModule

Give the size of the file given by its name.

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 dir)
           throws IOException

Description copied from class: TransferModule

Make directory by name.

Overrides:

mkdir in class TransferModule

Parameters:

dir - the dir

Throws:

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

rmdir

public void rmdir(String dir)
           throws IOException

Description copied from class: TransferModule

Remove directory by name.

Overrides:

rmdir in class TransferModule

Parameters:

dir - the dir

Throws:

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

move

public void move(String source,
 String target)
          throws IOException

Description copied from class: TransferModule

Move source to target.

Overrides:

move in class TransferModule

Parameters:

source - the source

target - the target

Throws:

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

list

public void list(String directory,
 String pattern,
 OutputStream out)
          throws IOException

Description copied from class: TransferModule

Default implementation to write the list to the provided output stream. The implementation should give a better implementation as this one is relying on the non optimal listAsStringArray method by default.

Overrides:

list in class TransferModule

Parameters:

directory - the directory

pattern - the pattern

out - the out

Throws:

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

listAsStringArray

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

Description copied from class: TransferModule

List as a 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.

close

public void close()
           throws IOException

Throws:

IOException

getConnectedRemoteAddress

public String getConnectedRemoteAddress()

Gets the real IP address of the remote host this module most recently connected to, if the underlying protocol implementation tracks it. This can differ from the configured Host address for anycast/load-balanced endpoints (e.g. Amazon S3, Google Cloud Storage), where a fresh DNS lookup of the same hostname performed later (e.g. for "Live ECPDS Earth" geolocation) may return a different IP than the one actually used for the transfer. Overridden by modules that track this (currently s3 and http/https); other modules keep the default of null, meaning the configured Host address should be used instead. Returns the real IP address of the remote host most recently connected to, tracked via the connection socket factories. Preferred over resolving the Host address via DNS again later, since some WebDAV endpoints may resolve to a different IP on every lookup (e.g. anycast/load-balanced services).

Overrides:

getConnectedRemoteAddress in class TransferModule

Returns:

the remote IP address, or null if not tracked or not yet connected