Class PortalModule

java.lang.Object

ecmwf.common.ectrans.TransferModule

ecmwf.common.ectrans.module.PortalModule

All Implemented Interfaces:

Closeable, AutoCloseable

public final class PortalModule
extends TransferModule

The Class PortalModule.

Constructor Summary

Constructors

Constructor	Description
PortalModule()

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.
String	getStatus()	Gets the current status of the transfer module.
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.
long	size(String name)	Give the size of the file given by its name.

Methods inherited from class ecmwf.common.ectrans.TransferModule

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

Methods inherited from class java.lang.Object

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

Constructor Details

PortalModule

public PortalModule()

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

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 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.

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.

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.

close

public void close()
           throws IOException

Close.

Throws:

IOException