Class RESTClient

java.lang.Object

ecmwf.ecpds.mover.service.RESTClient

All Implemented Interfaces:

RESTInterface

public final class RESTClient
extends Object
implements RESTInterface

The Class RESTClient.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RESTClient.CloseableClientResponse	A wrapper around HttpResponse that implements Closeable.
static final class	RESTClient.MonitorRequest	The Class MonitorRequest.
static final class	RESTClient.PutRequest	The Class PutRequest.
static class	RESTClient.RestException	Replacement for the legacy RestException.
static final class	RESTClient.UpdateDataRequest	The Class UpdateDataRequest.

Method Summary

Modifier and Type	Method	Description
void	close(DataTransfer dataTransfer)	Stops the transmission of the DataTransfer on the mover.
void	del(DataFile dataFile)	Deletes the physical file associated to the DataFile on the mover.
ECauthToken	getECauthToken(String user)	Requests a ecauth token to allow a connection to a ecauth compliant server.
String	getHostReport(Host host)	Requests a report for the specified Host (e.g. traceroute, paping).
String	getMoverReport()	Requests a report from the Data Mover (e.g. df, sar).
static RESTClient.PutRequest	getPutRequest(DataTransfer transfer, String fileName, Long localPosn, Long remotePosn)	Request for a transmission of a DataTransfer.
String	getVersion()	Gets the version of the remote ECaccess software (mover).
boolean	isValidDataFile(long dataFileId)	Checks if the DataFile exists and is not expired.
long	proxyHostIsAlive(String name)	Live message sent from the ProxyHost to the Master server.
void	purge(List<ExistingStorageDirectory> directories)	Requests an asynchronous purge of the DataFiles on the data mover which are more than the specified date.
String	put(DataTransfer transfer, String fileName, long localPosn, long remotePosn)	Requests a transmission of the DataTransfer with the target name as specified in fileName.
void	sendMessage(RESTClient.MonitorRequest request)	Sends a message to Monitor.
void	updateData(Host host)	Requests an update of the data part of the Host on the master (e.g. when the data is updated by the ectrans module).
void	updateDataRequest(RESTClient.UpdateDataRequest request)	Requests an update of the data part of the Host on the master (e.g. when the data is updated by the ectrans module).
void	updateDataTransfers(List<DataTransfer> transfers)	Requests an update of the transfers on the master (e.g. status).
void	updateLocation(Host host)	Requests an update of the location part of the Host on the master (e.g. when the IP is updated by the ectrans module).

Methods inherited from class Object

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

Method Details

getVersion

public String getVersion()
                  throws RESTClient.RestException

Description copied from interface: RESTInterface

Gets the version of the remote ECaccess software (mover).

Specified by:

getVersion in interface RESTInterface

Returns:

the version

Throws:

RESTClient.RestException

del

public void del(DataFile dataFile)
         throws RESTClient.RestException

Description copied from interface: RESTInterface

Deletes the physical file associated to the DataFile on the mover.

Specified by:

del in interface RESTInterface

Parameters:

dataFile - the data file

Throws:

RESTClient.RestException

close

public void close(DataTransfer dataTransfer)
           throws RESTClient.RestException

Description copied from interface: RESTInterface

Stops the transmission of the DataTransfer on the mover.

Specified by:

close in interface RESTInterface

Parameters:

dataTransfer - the data transfer

Throws:

RESTClient.RestException

purge

public void purge(List<ExistingStorageDirectory> directories)
           throws RESTClient.RestException

Description copied from interface: RESTInterface

Requests an asynchronous purge of the DataFiles on the data mover which are more than the specified date.

Specified by:

purge in interface RESTInterface

Parameters:

directories - the directories

Throws:

RESTClient.RestException

getHostReport

public String getHostReport(Host host)
                     throws RESTClient.RestException

Description copied from interface: RESTInterface

Requests a report for the specified Host (e.g. traceroute, paping).

Specified by:

getHostReport in interface RESTInterface

Parameters:

host - the host

Returns:

the host report

Throws:

RESTClient.RestException

getMoverReport

public String getMoverReport()
                      throws RESTClient.RestException

Description copied from interface: RESTInterface

Requests a report from the Data Mover (e.g. df, sar).

Specified by:

getMoverReport in interface RESTInterface

Returns:

the mover report

Throws:

RESTClient.RestException

put

public String put(DataTransfer transfer,
 String fileName,
 long localPosn,
 long remotePosn)
           throws RESTClient.RestException

Description copied from interface: RESTInterface

Requests a transmission of the DataTransfer with the target name as specified in fileName. Return the name of the DataMover used for the transmission.

Specified by:

put in interface RESTInterface

Parameters:

transfer - the transfer

fileName - the file name

localPosn - the local posn

remotePosn - the remote posn

Returns:

the string

Throws:

RESTClient.RestException

getECauthToken

public ECauthToken getECauthToken(String user)
                           throws RESTClient.RestException

Description copied from interface: RESTInterface

Requests a ecauth token to allow a connection to a ecauth compliant server.

Specified by:

getECauthToken in interface RESTInterface

Parameters:

user - the user

Returns:

the ecauth token

Throws:

RESTClient.RestException

isValidDataFile

public boolean isValidDataFile(long dataFileId)
                        throws RESTClient.RestException

Description copied from interface: RESTInterface

Checks if the DataFile exists and is not expired.

Specified by:

isValidDataFile in interface RESTInterface

Parameters:

dataFileId - the data file id

Returns:

true, if is valid data file

Throws:

RESTClient.RestException

proxyHostIsAlive

public long proxyHostIsAlive(String name)
                      throws RESTClient.RestException

Description copied from interface: RESTInterface

Live message sent from the ProxyHost to the Master server.

Specified by:

proxyHostIsAlive in interface RESTInterface

Parameters:

name - the name

Returns:

the long

Throws:

RESTClient.RestException

updateDataRequest

public void updateDataRequest(RESTClient.UpdateDataRequest request)
                       throws RESTClient.RestException

Description copied from interface: RESTInterface

Requests an update of the data part of the Host on the master (e.g. when the data is updated by the ectrans module).

Specified by:

updateDataRequest in interface RESTInterface

Parameters:

request - the request

Throws:

RESTClient.RestException

updateData

public void updateData(Host host)
                throws RESTClient.RestException

Description copied from interface: RESTInterface

Requests an update of the data part of the Host on the master (e.g. when the data is updated by the ectrans module).

Specified by:

updateData in interface RESTInterface

Parameters:

host - the host

Throws:

RESTClient.RestException

updateLocation

public void updateLocation(Host host)
                    throws RESTClient.RestException

Description copied from interface: RESTInterface

Requests an update of the location part of the Host on the master (e.g. when the IP is updated by the ectrans module).

Specified by:

updateLocation in interface RESTInterface

Parameters:

host - the host

Throws:

RESTClient.RestException

updateDataTransfers

public void updateDataTransfers(List<DataTransfer> transfers)
                         throws RESTClient.RestException

Description copied from interface: RESTInterface

Requests an update of the transfers on the master (e.g. status).

Specified by:

updateDataTransfers in interface RESTInterface

Parameters:

transfers - the transfers

Throws:

RESTClient.RestException

sendMessage

public void sendMessage(RESTClient.MonitorRequest request)
                 throws RESTClient.RestException

Description copied from interface: RESTInterface

Sends a message to Monitor.

Specified by:

sendMessage in interface RESTInterface

Parameters:

request - the request

Throws:

RESTClient.RestException

getPutRequest

public static RESTClient.PutRequest getPutRequest(DataTransfer transfer,
 String fileName,
 Long localPosn,
 Long remotePosn)

Request for a transmission of a DataTransfer.

Parameters:

transfer - the transfer

fileName - the file name

localPosn - the local posn

remotePosn - the remote posn

Returns:

the puts the request