Class MoverServer

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

ecmwf.common.callback.CallBackObject

ecmwf.common.ecaccess.StarterServer

ecmwf.ecpds.mover.MoverServer

All Implemented Interfaces:

ClientInterface, RemoteServer, MBeanListener, MBeanService, ToBeStarted, MoverInterface, Serializable, Remote

public final class MoverServer
extends StarterServer
implements MoverInterface

The Class MoverServer.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	MoverServer.DownloadRepository	The Class DownloadRepository.
static final class	MoverServer.ECproxyCallback	The Class ECproxyCallback.
final class	MoverServer.FileDescriptor	The Class FileDescriptor.

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Constructor	Description
MoverServer(Starter starter)	Instantiates a new mover server.

Method Summary

Modifier and Type	Method	Description
void	check(long ticket)	Check.
boolean	close(DataTransfer transfer)	Close.
void	closeAllIncomingConnections()	Close all incoming connections.
boolean	closeIncomingConnection(String id)	Close incoming connection.
boolean	del(DataFile dataFile)	Del.
void	del(DataTransfer transfer, String fileName)	Del.
boolean	del(Host proxyHost, DataFile dataFile)	Del.
void	del(Host host, String source)	Del.
DataFile	download(DataFile dataFile, Host hostForSource)	Download.
RemoteInputStream	execute(String script)	Execute.
DataFile	filter(DataFile dataFile, boolean remove)	Filter.
ProxySocket	get(DataFile dataFile, Host[] hostsForSource, long remotePosn, long length)	Gets the.
ProxySocket	get(DataFile dataFile, Host hostForSource, long remotePosn)	Gets the.
ProxySocket	get(Host host, String source, long remotePosn, boolean removeOriginal)	Gets the.
MoverServer.ECproxyCallback	get(OutputStream out, Host host, String source, long remotePosn, DataFile dataFile)	Allow providing an output stream to retrieve a file.
Object	getAttribute(String attributeName)	Gets the attribute.
DataAccessInterface	getDataFileAccessInterface()	Gets the data file access interface.
MoverServer.DownloadRepository	getDownloadRepository()	Gets the download repository.
ECauthToken	getECauthToken(String user)	Gets the ecauth token.
String	getECproxyAddressAndPort()	Gets the ECproxy plugging listen address and port.
GenericFile	getGenericFile(String path)	Gets the generic file.
String	getHostReport(Host proxyHost, Host host)	Gets the host report.
String[]	getIncomingConnectionIds()	Gets the incoming connection ids.
List<IncomingConnection>	getIncomingConnections()	Gets the incoming connections.
MasterInterface	getMasterInterface()	Gets the master interface.
MasterProxy	getMasterProxy()	If the data mover is connected directly to its MasterServer then return a RMI interface to the Master, if the data mover is connected through a delegate data mover then return a REST interface, otherwise through an exception.
MBeanInfo	getMBeanInfo()	Gets the MBean info.
String	getMoverReport(Host proxyHost)	Gets the mover report.
int	getMQTTClientsCount()	Get the number of client connected to the MQTT broker.
MQTTInterface	getMQTTInterface()	Gets the MQTT interface.
String	getPassword()	Gets the password.
String	getReport()	Gets the report.
String	getReport(Host host)	Gets the report.
static String	getRepository()	Gets the repository.
RESTInterface	getRESTInterface(String httpProxy, String httpMover, int connectTimeout)	Gets the REST interface.
String	getRoot()	Gets the root.
String	getService()	Gets the service.
TicketRepository	getTicketRepository()	Gets the ticket repository.
String	getVersion()	Gets the version.
Object	invoke(String operationName, Object[] params, String[] signature)	Invoke.
RemoteInputStream	listAsByteArray(Host host, String directory, String pattern, boolean synchronous)	List2.
String[]	listAsStringArray(Host host, String directory, String pattern)	List.
void	mkdir(Host host, String dir)	Mkdir.
void	move(Host host, String source, String target)	Move.
void	publishToMQTTBroker(String topic, int qos, long expiryInterval, String contentType, String clientId, String payload, boolean retain)	Publish a notification to the MQTT service.
void	purge()	Request from the JMX interface.
void	purge(Host proxyHost, List<ExistingStorageDirectory> directories)	Purge.
void	purge(List<ExistingStorageDirectory> directories)	Purge.
DataTransfer	put(Host[] hostsForSource, DataTransfer transfer, String targetName, long localPosn, long remotePosn)	Puts the.
ProxySocket	put(Host host, String target, long remotePosn, long size)	Puts the.
void	removeFromMQTTBroker(String topic)	Remove a retained notification from the MQTT broker.
DataFile	replicate(DataFile dataFile, Host targetHost, Host[] hostsForSource)	Replicate.
void	resetDataMover()	Is called whenever the DataMover lost the connection with its MasterServer.
void	rmdir(Host host, String dir)	Rmdir.
boolean	setAttribute(String name, Object value)	Sets the attribute.
void	setMQTTInterface(MQTTInterface mqttInterface)	Sets the MQTT interface.
void	setRESTProvider(RESTProvider restProvider)	Sets the REST provider.
void	shutdown()	Shutdown.
long	size(DataTransfer transfer, String fileName)	Size.
long	size(Host host, String source)	Size.

Methods inherited from class ecmwf.common.ecaccess.StarterServer

exit, getGraceful, getInstance, getInstance, getMBeanCenter, getPluginContainer, getPluginInfos, getRemoteCnf, getRestart, getStartDate, handle, handle, handleNotification, shutdown

Methods inherited from class ecmwf.common.callback.CallBackObject

createOrGetRegistry, getPort

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ecmwf.ecpds.mover.MoverInterface

shutdown

Constructor Details

MoverServer

public MoverServer(Starter starter)
            throws IOException,
InstanceAlreadyExistsException,
MBeanRegistrationException,
NotCompliantMBeanException,
MalformedObjectNameException,
InstanceNotFoundException,
ConnectionException

Instantiates a new mover server.

Parameters:

starter - the starter

Throws:

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

InstanceAlreadyExistsException - the instance already exists exception

MBeanRegistrationException - the MBean registration exception

NotCompliantMBeanException - the not compliant m bean exception

MalformedObjectNameException - the malformed object name exception

InstanceNotFoundException - the instance not found exception

ConnectionException - the connection exception

Method Details

resetDataMover

public void resetDataMover()

Is called whenever the DataMover lost the connection with its MasterServer. This method can be called from the MasterManager if it is connected through RMI or from the TransferRepository if it is connected through the REST interface.

setRESTProvider

public void setRESTProvider(RESTProvider restProvider)

Sets the REST provider.

Parameters:

restProvider - the new REST provider

getRESTInterface

public RESTInterface getRESTInterface(String httpProxy,
 String httpMover,
 int connectTimeout)
                               throws MoverException

Gets the REST interface.

Parameters:

httpProxy - the http proxy

httpMover - the http mover

connectTimeout - the connect timeout

Returns:

the REST interface

Throws:

MoverException - the mover exception

setMQTTInterface

public void setMQTTInterface(MQTTInterface mqttInterface)

Sets the MQTT interface.

Parameters:

mqttInterface - the new MQTT interface

getMQTTInterface

public MQTTInterface getMQTTInterface()
                               throws MoverException

Gets the MQTT interface.

Returns:

the MQTT interface

Throws:

MoverException - the mover exception

getGenericFile

public GenericFile getGenericFile(String path)

Gets the generic file.

Parameters:

path - the path

Returns:

the generic file

getDataFileAccessInterface

public DataAccessInterface getDataFileAccessInterface()
                                               throws MasterException

Gets the data file access interface.

Returns:

the data file access interface

Throws:

MasterException - the master exception

getECproxyAddressAndPort

public String getECproxyAddressAndPort()

Gets the ECproxy plugging listen address and port. This is used by the Master Server to update the "TransferServer" entry in the database when the Mover subscribe. This address and port are used when the Master Server send the address of the allocated Mover to the ecpds command. Gets the ECproxy plugging listen address and port. This is used by the Master Server to update the "TransferServer" entry in the database when the Mover subscribe. This address and port are used when the Master Server send the address of the allocated Mover to the ecpds command.

Specified by:

getECproxyAddressAndPort in interface MoverInterface

Returns:

the ECproxyPlugin address and port

getIncomingConnectionIds

public String[] getIncomingConnectionIds()

Gets the incoming connection ids. Gets the incoming connection ids.

Specified by:

getIncomingConnectionIds in interface MoverInterface

Returns:

the incoming connection ids

getIncomingConnections

public List<IncomingConnection> getIncomingConnections()

Gets the incoming connections. Gets the incoming connections.

Specified by:

getIncomingConnections in interface MoverInterface

Returns:

the incoming connections

closeIncomingConnection

public boolean closeIncomingConnection(String id)

Close incoming connection. Close incoming connection.

Specified by:

closeIncomingConnection in interface MoverInterface

Parameters:

id - the id

Returns:

true, if successful

closeAllIncomingConnections

public void closeAllIncomingConnections()

Close all incoming connections. Close all incoming connections.

Specified by:

closeAllIncomingConnections in interface MoverInterface

publishToMQTTBroker

public void publishToMQTTBroker(String topic,
 int qos,
 long expiryInterval,
 String contentType,
 String clientId,
 String payload,
 boolean retain)

Publish a notification to the MQTT service. Publish a notification to the registered MQTT service (if any).

Specified by:

publishToMQTTBroker in interface MoverInterface

Parameters:

topic - the topic

qos - the qos

expiryInterval - the expiry interval

contentType - the content type

clientId - the client id

payload - the payload

retain - the retain

removeFromMQTTBroker

public void removeFromMQTTBroker(String topic)

Remove a retained notification from the MQTT broker. Remove a retained notification from the MQTT broker.

Specified by:

removeFromMQTTBroker in interface MoverInterface

Parameters:

topic - the topic

getMQTTClientsCount

public int getMQTTClientsCount()

Get the number of client connected to the MQTT broker. Get the number of client connected to the MQTT broker.

Specified by:

getMQTTClientsCount in interface MoverInterface

Returns:

the MQTT clients count

getRepository

public static String getRepository()

Gets the repository.

Returns:

the repository

getRoot

public String getRoot()

Gets the root. Gets the root.

Specified by:

getRoot in interface ClientInterface

Returns:

the root

getService

public String getService()

Gets the service. Gets the service.

Specified by:

getService in interface ClientInterface

Returns:

the service

getPassword

public String getPassword()

Gets the password. Gets the password.

Specified by:

getPassword in interface ClientInterface

Returns:

the password

getVersion

public String getVersion()

Gets the version. Gets the version.

Specified by:

getVersion in class StarterServer

Returns:

the version

getMBeanInfo

public MBeanInfo getMBeanInfo()

Gets the MBean info. Gets the MBean info. Gets the MBean info.

Specified by:

getMBeanInfo in interface MBeanService

Overrides:

getMBeanInfo in class StarterServer

Returns:

the MBean info

setAttribute

public boolean setAttribute(String name,
 Object value)
                     throws InvalidAttributeValueException,
MBeanException

Sets the attribute. Sets the attribute. Sets the attribute.

Specified by:

setAttribute in interface MBeanService

Overrides:

setAttribute in class StarterServer

Parameters:

name - the name

value - the value

Returns:

true, if successful

Throws:

InvalidAttributeValueException - the invalid attribute value exception

MBeanException - the MBean exception

getAttribute

public Object getAttribute(String attributeName)
                    throws AttributeNotFoundException,
MBeanException

Gets the attribute. Gets the attribute. Gets the attribute.

Specified by:

getAttribute in interface MBeanService

Overrides:

getAttribute in class StarterServer

Parameters:

attributeName - the attribute name

Returns:

the attribute

Throws:

AttributeNotFoundException - the attribute not found exception

MBeanException - the MBean exception

invoke

public Object invoke(String operationName,
 Object[] params,
 String[] signature)
              throws NoSuchMethodException,
MBeanException

Invoke. Invoke. Invoke.

Specified by:

invoke in interface MBeanService

Overrides:

invoke in class StarterServer

Parameters:

operationName - the operation name

params - the params

signature - the signature

Returns:

the object

Throws:

NoSuchMethodException - the no such method exception

MBeanException - the MBean exception

check

public void check(long ticket)
           throws IOException

Check. Check.

Specified by:

check in interface MoverInterface

Parameters:

ticket - the ticket

Throws:

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

size

public long size(DataTransfer transfer,
 String fileName)
          throws ECtransException,
IOException

Size. Size.

Specified by:

size in interface MoverInterface

Parameters:

transfer - the transfer

fileName - the file name

Returns:

the long

Throws:

ECtransException - the ectrans exception

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

del

public void del(DataTransfer transfer,
 String fileName)
         throws ECtransException,
IOException

Del. Del.

Specified by:

del in interface MoverInterface

Parameters:

transfer - the transfer

fileName - the file name

Throws:

ECtransException - the ectrans exception

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

filter

public DataFile filter(DataFile dataFile,
 boolean remove)
                throws IOException

Filter. Filter.

Specified by:

filter in interface MoverInterface

Parameters:

dataFile - the data file

remove - the remove

Returns:

the data file

Throws:

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

replicate

public DataFile replicate(DataFile dataFile,
 Host targetHost,
 Host[] hostsForSource)
                   throws ECtransException,
SourceNotAvailableException,
IOException

Replicate. Replicate.

Specified by:

replicate in interface MoverInterface

Parameters:

dataFile - the data file

targetHost - the target host

hostsForSource - the hosts for source

Returns:

the data file

Throws:

ECtransException - the ectrans exception

SourceNotAvailableException - the source not available exception

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

getMoverReport

public String getMoverReport(Host proxyHost)
                      throws IOException

Gets the mover report. Gets the mover report.

Specified by:

getMoverReport in interface MoverInterface

Parameters:

proxyHost - the proxy host

Returns:

the mover report

Throws:

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

getHostReport

public String getHostReport(Host proxyHost,
 Host host)
                     throws IOException

Gets the host report. Gets the host report.

Specified by:

getHostReport in interface MoverInterface

Parameters:

proxyHost - the proxy host

host - the host

Returns:

the host report

Throws:

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

getReport

public String getReport()
                 throws IOException

Gets the report. Gets the report.

Specified by:

getReport in interface MoverInterface

Returns:

the report

Throws:

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

getReport

public String getReport(Host host)
                 throws IOException

Gets the report. Gets the report.

Specified by:

getReport in interface MoverInterface

Parameters:

host - the host

Returns:

the report

Throws:

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

download

public DataFile download(DataFile dataFile,
 Host hostForSource)
                  throws SourceNotAvailableException,
IOException

Download. Download.

Specified by:

download in interface MoverInterface

Parameters:

dataFile - the data file

hostForSource - the host for source

Returns:

the data file

Throws:

SourceNotAvailableException - the source not available exception

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

purge

public void purge(Host proxyHost,
 List<ExistingStorageDirectory> directories)
           throws RemoteException

Purge. Purge.

Specified by:

purge in interface MoverInterface

Parameters:

proxyHost - the proxy host

directories - the directories

Throws:

RemoteException - the remote exception

purge

public void purge(List<ExistingStorageDirectory> directories)
           throws RemoteException

Purge. Purge.

Specified by:

purge in interface MoverInterface

Parameters:

directories - the directories

Throws:

RemoteException - the remote exception

purge

public void purge()

Request from the JMX interface.

del

public boolean del(Host proxyHost,
 DataFile dataFile)
            throws ECtransException,
IOException

Del. Del.

Specified by:

del in interface MoverInterface

Parameters:

proxyHost - the proxy host

dataFile - the data file

Returns:

true, if successful

Throws:

ECtransException - the ectrans exception

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

del

public boolean del(DataFile dataFile)
            throws ECtransException,
IOException

Del. Del.

Specified by:

del in interface MoverInterface

Parameters:

dataFile - the data file

Returns:

true, if successful

Throws:

ECtransException - the ectrans exception

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

put

public DataTransfer put(Host[] hostsForSource,
 DataTransfer transfer,
 String targetName,
 long localPosn,
 long remotePosn)
                 throws ECtransException,
SourceNotAvailableException,
IOException

Puts the. Puts the.

Specified by:

put in interface MoverInterface

Parameters:

hostsForSource - the hosts for source

transfer - the transfer

targetName - the file name

localPosn - the local posn

remotePosn - the remote posn

Returns:

the data transfer

Throws:

ECtransException - the ectrans exception

SourceNotAvailableException - the source not available exception

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

put

public ProxySocket put(Host host,
 String target,
 long remotePosn,
 long size)
                throws ECtransException,
IOException

Puts the. Allow getting a ProxySocket to upload a file on a target host. This method should be used only when the file is to be uploaded from a different data mover than the current one.

Specified by:

put in interface MoverInterface

Parameters:

host - the host

target - the target

remotePosn - the remote posn

size - the size

Returns:

the proxy socket

Throws:

ECtransException - the ectrans exception

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

get

public ProxySocket get(Host host,
 String source,
 long remotePosn,
 boolean removeOriginal)
                throws ECtransException,
IOException

Gets the. Allow getting a ProxySocket to retrieve a file on a target host. This method should be used only when the file is to be retrieved from a different data mover than the current one.

Specified by:

get in interface MoverInterface

Parameters:

host - the host

source - the source

remotePosn - the remote posn

removeOriginal - the remove original

Returns:

the proxy socket

Throws:

ECtransException - the ectrans exception

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

get

public MoverServer.ECproxyCallback get(OutputStream out,
 Host host,
 String source,
 long remotePosn,
 DataFile dataFile)
                                throws ECtransException

Allow providing an output stream to retrieve a file. This method should only be used when it is called from the current data mover. The retrieval is done asynchronously. If the retrieval fail then the provided Output Stream is closed.

Parameters:

out - the output stream

host - the host

source - the source

remotePosn - the remote posn

dataFile - the data file

Returns:

the ecproxy callback for checking the outcome of the transmission

Throws:

ECtransException - the ectrans exception

get

public ProxySocket get(DataFile dataFile,
 Host hostForSource,
 long remotePosn)
                throws SourceNotAvailableException,
IOException

Gets the. Gets the.

Specified by:

get in interface MoverInterface

Parameters:

dataFile - the data file

hostForSource - the host for source

remotePosn - the remote posn

Returns:

the proxy socket

Throws:

SourceNotAvailableException - the source not available exception

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

get

public ProxySocket get(DataFile dataFile,
 Host[] hostsForSource,
 long remotePosn,
 long length)
                throws SourceNotAvailableException,
IOException

Gets the. Gets the.

Specified by:

get in interface MoverInterface

Parameters:

dataFile - the data file

hostsForSource - the host for source

remotePosn - the remote posn

length - the length

Returns:

the proxy socket

Throws:

SourceNotAvailableException - the source not available exception

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

size

public long size(Host host,
 String source)
          throws ECtransException,
IOException

Size. Size.

Specified by:

size in interface MoverInterface

Parameters:

host - the host

source - the source

Returns:

the long

Throws:

ECtransException - the ectrans exception

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

listAsStringArray

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

List. List as string array.

Specified by:

listAsStringArray in interface MoverInterface

Parameters:

host - the host

directory - the source

pattern - the pattern

Returns:

the string[]

Throws:

ECtransException - the ectrans exception

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

listAsByteArray

public RemoteInputStream listAsByteArray(Host host,
 String directory,
 String pattern,
 boolean synchronous)
                                  throws ECtransException,
IOException

List2. List as byte array.

Specified by:

listAsByteArray in interface MoverInterface

Parameters:

host - the host

directory - the directory

pattern - the pattern

synchronous - the synchronous

Returns:

the remote input stream

Throws:

ECtransException - the ectrans exception

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

execute

public RemoteInputStream execute(String script)
                          throws ScriptException,
IOException

Execute. Execute.

Specified by:

execute in interface MoverInterface

Parameters:

script - the script

Returns:

the remote input stream

Throws:

ScriptException - the script exception

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

del

public void del(Host host,
 String source)
         throws ECtransException,
IOException

Del. Del.

Specified by:

del in interface MoverInterface

Parameters:

host - the host

source - the source

Throws:

ECtransException - the ectrans exception

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

mkdir

public void mkdir(Host host,
 String dir)
           throws ECtransException,
IOException

Mkdir. Mkdir.

Specified by:

mkdir in interface MoverInterface

Parameters:

host - the host

dir - the dir

Throws:

ECtransException - the ectrans exception

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

rmdir

public void rmdir(Host host,
 String dir)
           throws ECtransException,
IOException

Rmdir. Rmdir.

Specified by:

rmdir in interface MoverInterface

Parameters:

host - the host

dir - the dir

Throws:

ECtransException - the ectrans exception

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

move

public void move(Host host,
 String source,
 String target)
          throws ECtransException,
IOException

Move. Move.

Specified by:

move in interface MoverInterface

Parameters:

host - the host

source - the source

target - the target

Throws:

ECtransException - the ectrans exception

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

close

public boolean close(DataTransfer transfer)
              throws ECtransException,
IOException

Close. Close.

Specified by:

close in interface MoverInterface

Parameters:

transfer - the transfer

Returns:

true, if successful

Throws:

ECtransException - the ectrans exception

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

getMasterProxy

public MasterProxy getMasterProxy()
                           throws MoverException

If the data mover is connected directly to its MasterServer then return a RMI interface to the Master, if the data mover is connected through a delegate data mover then return a REST interface, otherwise through an exception.

Returns:

the master proxy

Throws:

MoverException - the mover exception

getMasterInterface

public MasterInterface getMasterInterface()
                                   throws ConnectionException

Gets the master interface.

Returns:

the master interface

Throws:

ConnectionException - the connection exception

getECauthToken

public ECauthToken getECauthToken(String user)
                           throws IOException

Gets the ecauth token.

Parameters:

user - the user

Returns:

the ecauth token

Throws:

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

getTicketRepository

public TicketRepository getTicketRepository()

Gets the ticket repository.

Returns:

the ticket repository

getDownloadRepository

public MoverServer.DownloadRepository getDownloadRepository()

Gets the download repository.

Returns:

the download repository

shutdown

public void shutdown()

Shutdown. Shutdown. Shutdown.

Specified by:

shutdown in interface ToBeStarted

Overrides:

shutdown in class StarterServer