Interface ManagementInterface

All Superinterfaces:

Remote

public interface ManagementInterface
extends Remote

The Interface ManagementInterface.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DESTINATION_STATE_CLOSING	The Constant DESTINATION_STATE_CLOSING.
static final int	DESTINATION_STATE_JAMMED	The Constant DESTINATION_STATE_JAMMED.
static final int	DESTINATION_STATE_OFFLINE	The Constant DESTINATION_STATE_OFFLINE.
static final int	DESTINATION_STATE_ONHOLD	The Constant DESTINATION_STATE_ONHOLD.
static final int	DESTINATION_STATE_ONLINE	The Constant DESTINATION_STATE_ONLINE.
static final int	DESTINATION_STATE_OPENING	The Constant DESTINATION_STATE_OPENING.

Method Summary

Modifier and Type	Method	Description
void	approvePortalSubscriber(ECpdsSession session, PortalSubscriber sub)	Activates a PortalSubscriber and sends the credentials email to the subscriber.
void	cleanDataWindow(ECpdsSession session, Host host)	Clean the data window host.
String	cloneHost(ECpdsSession session, String hostName)	Clone a host without associating it to any destination.
void	closeECpdsSession(ECpdsSession session, boolean expired)	Close ecpds session.
void	closeIncomingConnection(ECpdsSession session, String id)	Close an incoming connection.
String	computeFilterEfficiency(ECpdsSession session, String destinationName, String email, String filter, long date, boolean includeStdby, String pattern)	Compute filter efficiency.
DestinationCache	copyDestination(ECpdsSession session, String fromDestination, String toDestination, String label, boolean copySharedHost)	Copy destination.
DestinationCache	copyHost(ECpdsSession session, String destinationName, String hostName)	Copy host.
byte[]	exec(ECpdsSession session, Map<String,String> environment, byte[] request, String service)	Exec.
String	execDirScript(ECpdsSession session, Host host, String script)	Execute a Directory script on the DataMover for the given host and return the result as a GZIPped input stream.
void	exportDestination(ECpdsSession session, String targetMaster, String fromDestination, String toDestinationName, boolean copySharedHost)	Export destination.
String	fetchUrlContent(ECpdsSession session, Host host, String source, int maxBytes)	Fetch the raw content of a remote URL/path via the host's configured ECtrans module on the DataMover.
Map<String,String>	getContacts()	Gets the contacts.
Map<String, DestinationCache>	getDestinationCaches()	Gets the destination caches.
DataTransfer	getDestinationLastFailedTransfer(String destinationName)	Gets the destination last failed transfer.
DataTransfer	getDestinationLastTransfer(String destinationName)	Gets the destination last transfer.
List<String>	getDestinationNamesForContact(List<Map.Entry<String,String>> emailPattern, boolean caseSensitive)	Get the destination names which have the provided email address in their contacts!
DestinationSchedulerCache	getDestinationSchedulerCache(String destinationName)	Gets the destination scheduler cache.
int	getDestinationSize(String destinationName)	Gets the destination size.
Date	getDestinationStartDate(String destinationName)	Gets the destination start date.
String	getDestinationStatus(String destinationName)	Gets the destination status.
Map<String,int[]>	getDownloadMetrics()	Returns a snapshot of the current in-flight download counts for all data movers and all volumes.
ECpdsSession	getECpdsSession(String user, String password, String host, String agent, String comment)	Gets the ecpds session.
String	getHostReport(ECpdsSession session, Host proxyHost, Host host)	Gets the host report.
MonitorManager	getMonitorManager(String destinationName)	Gets the monitor manager.
List<long[]>	getMoverAvailability(String moverName, int hours)	Returns availability snapshots for the given DataMover from the database.
String	getMoverReport(ECpdsSession session, Host proxyHost)	Gets the mover report.
Map<String,long[][]>	getMoverVolumeUsage(String moverName)	Gets a snapshot of per-volume disk usage for one or all DataMovers.
RemoteInputStream	getOutput(ECpdsSession session, Host host)	Gets the host output.
int	getPendingDataTransfersCount(String destinationName)	Gets the pending data transfers count.
List<PortalSubscriber>	getPortalSubscribersByUser(ECpdsSession session, String inuId)	Gets all PortalSubscribers for a given IncomingUser.
String	getReport(ECpdsSession session, Host host)	Gets the report.
String	getReport(ECpdsSession session, TransferServer server)	Gets the report.
long	getRetrieved(long dataFileId)	Gets the retrieved.
String	getTransferServerName(long dataFileId)	Gets the transfer server name.
Map<String,long[][]>	getVolumeUsage(String groupName)	Gets a snapshot of volume disk usage for one or all transfer groups.
void	holdAllDestinations(ECpdsSession session, boolean graceful)	Hold all destinations.
DestinationSchedulerCache	holdDestination(ECpdsSession session, String destinationName, boolean graceful)	Hold destination.
String	insertPortalSubscriber(ECpdsSession session, String inuId, String email, String name, String iso)	Creates a new PortalSubscriber for the given IncomingUser with the specified attributes.
void	interruptAcquisition(ECpdsSession session, Host host)	Interrupt a running acquisition thread for the given Host and immediately restart it.
boolean	interruptDataTransferRetrieval(ECpdsSession session, long id)	Interrupt data transfer retrieval.
void	invalidatePortalSessionsForUser(ECpdsSession session, String user)	Invalidate all portal session cookies for a data user on all movers.
boolean	isAcquisitionRunning(ECpdsSession session, Host host)	Check whether an acquisition thread is currently running for the given Host.
void	refreshContactsCache()	Forces the contacts cache to reload on next access (e.g. after a metadata import).
void	removeCategory(ECpdsSession session, Category category)	Removes the category.
void	removeDataFile(ECpdsSession session, DataFile file)	Removes the data file.
void	removeDataTransfer(ECpdsSession session, DataTransfer transfer)	Removes the data transfer.
void	removeDestination(ECpdsSession session, String destinationName)	Removes the destination.
void	removeDestination(ECpdsSession session, String destinationName, boolean cleanOnly, boolean removeAll)	Removes the destination.
void	removeECtransModule(ECpdsSession session, ECtransModule module)	Removes the ectrans module.
void	removeHost(ECpdsSession session, Host host)	Removes the host.
void	removeIncomingPolicy(ECpdsSession session, IncomingPolicy policy)	Removes the IncomingPolicy.
void	removeIncomingUser(ECpdsSession session, IncomingUser user)	Removes the IncomingUser.
void	removePortalSubscriber(ECpdsSession session, PortalSubscriber sub)	Removes a PortalSubscriber permanently.
void	removeTransferGroup(ECpdsSession session, TransferGroup group)	Removes the transfer group.
void	removeTransferMethod(ECpdsSession session, TransferMethod method)	Removes the transfer method.
void	removeTransferServer(ECpdsSession session, TransferServer server)	Removes the transfer server.
void	removeUrl(ECpdsSession session, Url url)	Removes the url.
void	removeWebUser(ECpdsSession session, WebUser user)	Removes the web user.
void	resendDataTransferEvents(String root, DataTransferEventRequest[] dataTransferEventRequests)	Resend data transfer events.
void	resetTransferScheduleDate(ECpdsSession session, long id)	Reset transfer schedule date.
void	resetTransferStatistics(ECpdsSession session, Host host)	Reset the host stats.
String	resolveDirText(ECpdsSession session, Host host, String text)	Resolve all static placeholder tokens in a plain-text Directory field and return the resolved text.
void	restartAllDestinations(ECpdsSession session, boolean graceful)	Restart all destinations.
DestinationSchedulerCache	restartDestination(ECpdsSession session, String destinationName, boolean graceful)	Restart destination.
void	saveWebUser(ECpdsSession session, WebUser webUser)	Creates the web user.
void	shutdown(ECpdsSession session, boolean graceful, boolean restart)	Shutdown.
void	shutdownTransferServer(ECpdsSession session, TransferServer server, boolean graceful, boolean restart)	Shutdown transfer server.
long	transfer(ECpdsSession session, byte[] bytes, Host host, String target, long remotePosn)	Transfer.
boolean	transferStatusUpdateAllowed(long id, String code)	Transfer status update allowed.
void	triggerAcquisition(ECpdsSession session, Host host)	Trigger acquisition for the given Host immediately by resetting its acquisition time.
void	updateExpiryTime(ECpdsSession session, long id, Timestamp timetamp)	Update expiry time.
void	updateFileMonitoringValue(ECpdsSession session, MonitoringValue value)	Update file monitoring value.
Host	updateHost(ECpdsSession session, Host host)	Update host.
void	updatePortalSubscriber(ECpdsSession session, PortalSubscriber sub)	Updates a PortalSubscriber.
void	updateTransferMonitoringValue(ECpdsSession session, MonitoringValue value)	Update transfer monitoring value.
void	updateTransferPriority(ECpdsSession session, long id, int priority)	Update transfer priority.
boolean	updateTransferStatus(ECpdsSession session, long id, String code)	Update transfer status.

Field Details

DESTINATION_STATE_ONLINE

static final int DESTINATION_STATE_ONLINE

The Constant DESTINATION_STATE_ONLINE.

See Also:

• Constant Field Values

DESTINATION_STATE_OPENING

static final int DESTINATION_STATE_OPENING

The Constant DESTINATION_STATE_OPENING.

See Also:

• Constant Field Values

DESTINATION_STATE_CLOSING

static final int DESTINATION_STATE_CLOSING

The Constant DESTINATION_STATE_CLOSING.

See Also:

• Constant Field Values

DESTINATION_STATE_OFFLINE

static final int DESTINATION_STATE_OFFLINE

The Constant DESTINATION_STATE_OFFLINE.

See Also:

• Constant Field Values

DESTINATION_STATE_JAMMED

static final int DESTINATION_STATE_JAMMED

The Constant DESTINATION_STATE_JAMMED.

See Also:

• Constant Field Values

DESTINATION_STATE_ONHOLD

static final int DESTINATION_STATE_ONHOLD

The Constant DESTINATION_STATE_ONHOLD.

See Also:

• Constant Field Values

Method Details

getDestinationNamesForContact

List<String> getDestinationNamesForContact(List<Map.Entry<String,String>> emailPattern,
 boolean caseSensitive)
                                    throws IOException

Get the destination names which have the provided email address in their contacts!

Parameters:

emailPattern - the email pattern

caseSensitive - is it case sensitive

Returns:

the destination names

Throws:

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

getContacts

Map<String,String> getContacts()
                        throws MasterException,
IOException

Gets the contacts.

Returns:

the contacts

Throws:

MasterException - the master exception

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

refreshContactsCache

void refreshContactsCache()
                   throws RemoteException

Forces the contacts cache to reload on next access (e.g. after a metadata import).

Throws:

RemoteException - the remote exception

getDestinationCaches

Map<String, DestinationCache> getDestinationCaches()
                                            throws MonitorException,
MasterException,
DataBaseException,
RemoteException

Gets the destination caches.

Returns:

the destination caches

Throws:

MonitorException - the monitor exception

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

getMonitorManager

MonitorManager getMonitorManager(String destinationName)
                          throws MonitorException,
MasterException,
RemoteException

Gets the monitor manager.

Parameters:

destinationName - the destination name

Returns:

the monitor manager

Throws:

MonitorException - the monitor exception

MasterException - the master exception

RemoteException - the remote exception

getDestinationStatus

String getDestinationStatus(String destinationName)
                     throws MasterException,
DataBaseException,
RemoteException

Gets the destination status.

Parameters:

destinationName - the Destination name

Returns:

the destination status

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

getDestinationSize

int getDestinationSize(String destinationName)
                throws MasterException,
RemoteException

Gets the destination size.

Parameters:

destinationName - the Destination name

Returns:

the destination size

Throws:

MasterException - the master exception

RemoteException - the remote exception

getDestinationStartDate

Date getDestinationStartDate(String destinationName)
                      throws MasterException,
RemoteException

Gets the destination start date.

Parameters:

destinationName - the Destination name

Returns:

the destination start date

Throws:

MasterException - the master exception

RemoteException - the remote exception

getPendingDataTransfersCount

int getPendingDataTransfersCount(String destinationName)
                          throws MasterException,
RemoteException

Gets the pending data transfers count.

Parameters:

destinationName - the destination name

Returns:

the pending data transfers count

Throws:

MasterException - the master exception

RemoteException - the remote exception

getDestinationLastTransfer

DataTransfer getDestinationLastTransfer(String destinationName)
                                 throws MasterException,
RemoteException

Gets the destination last transfer.

Parameters:

destinationName - the Destination name

Returns:

the destination last transfer

Throws:

MasterException - the master exception

RemoteException - the remote exception

getDestinationLastFailedTransfer

DataTransfer getDestinationLastFailedTransfer(String destinationName)
                                       throws MasterException,
RemoteException

Gets the destination last failed transfer.

Parameters:

destinationName - the Destination name

Returns:

the destination last failed transfer

Throws:

MasterException - the master exception

RemoteException - the remote exception

getRetrieved

long getRetrieved(long dataFileId)
           throws DataBaseException,
RemoteException

Gets the retrieved.

Parameters:

dataFileId - the data file id

Returns:

the retrieved

Throws:

DataBaseException - the data base exception

RemoteException - the remote exception

getTransferServerName

String getTransferServerName(long dataFileId)
                      throws DataBaseException,
RemoteException

Gets the transfer server name.

Parameters:

dataFileId - the data file id

Returns:

the transfer server name

Throws:

DataBaseException - the data base exception

RemoteException - the remote exception

getECpdsSession

ECpdsSession getECpdsSession(String user,
 String password,
 String host,
 String agent,
 String comment)
                      throws MasterException,
DataBaseException,
RemoteException

Gets the ecpds session.

Parameters:

user - the user

password - the password

host - the host

agent - the agent

comment - the comment

Returns:

the ecpds session

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

saveWebUser

void saveWebUser(ECpdsSession session,
 WebUser webUser)
          throws MasterException,
DataBaseException,
RemoteException

Creates the web user.

Parameters:

session - the session

webUser - the web user

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

copyDestination

DestinationCache copyDestination(ECpdsSession session,
 String fromDestination,
 String toDestination,
 String label,
 boolean copySharedHost)
                          throws MasterException,
DataBaseException,
RemoteException

Copy destination.

Parameters:

session - the session

fromDestination - the from destination

toDestination - the to destination

label - the label

copySharedHost - the copy shared host

Returns:

the destination cache

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

copyHost

DestinationCache copyHost(ECpdsSession session,
 String destinationName,
 String hostName)
                   throws MasterException,
DataBaseException,
RemoteException

Copy host.

Parameters:

session - the session

destinationName - the destination name

hostName - the host name

Returns:

the destination cache

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

cloneHost

String cloneHost(ECpdsSession session,
 String hostName)
          throws MasterException,
DataBaseException,
RemoteException

Clone a host without associating it to any destination.

Parameters:

session - the session

hostName - the host name

Returns:

the cloned host name

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

exportDestination

void exportDestination(ECpdsSession session,
 String targetMaster,
 String fromDestination,
 String toDestinationName,
 boolean copySharedHost)
                throws MasterException,
DataBaseException,
RemoteException

Export destination.

Parameters:

session - the session

targetMaster - the target master

fromDestination - the from destination

copySharedHost - the copy shared host

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

closeECpdsSession

void closeECpdsSession(ECpdsSession session,
 boolean expired)
                throws RemoteException

Close ecpds session.

Parameters:

session - the session

expired - the expired

Throws:

RemoteException - the remote exception

closeIncomingConnection

void closeIncomingConnection(ECpdsSession session,
 String id)
                      throws IOException

Close an incoming connection.

Parameters:

session - the session

id - the id

Throws:

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

RemoteException - the remote exception

invalidatePortalSessionsForUser

void invalidatePortalSessionsForUser(ECpdsSession session,
 String user)
                              throws RemoteException

Invalidate all portal session cookies for a data user on all movers. Forces re-authentication immediately when the user's Portal Service mode or password changes.

Parameters:

session - the session

user - the data user login name

Throws:

RemoteException - the remote exception

restartDestination

DestinationSchedulerCache restartDestination(ECpdsSession session,
 String destinationName,
 boolean graceful)
                                      throws MasterException,
RemoteException,
DataBaseException

Restart destination.

Parameters:

session - the session

destinationName - the destination name

graceful - the graceful

Returns:

the destination scheduler cache

Throws:

MasterException - the master exception

RemoteException - the remote exception

DataBaseException - the data base exception

restartAllDestinations

void restartAllDestinations(ECpdsSession session,
 boolean graceful)
                     throws MasterException,
RemoteException

Restart all destinations.

Parameters:

session - the session

graceful - the graceful

Throws:

MasterException - the master exception

RemoteException - the remote exception

shutdownTransferServer

void shutdownTransferServer(ECpdsSession session,
 TransferServer server,
 boolean graceful,
 boolean restart)
                     throws MasterException,
RemoteException

Shutdown transfer server.

Parameters:

session - the session

server - the server

graceful - the graceful

restart - the restart

Throws:

MasterException - the master exception

RemoteException - the remote exception

holdDestination

DestinationSchedulerCache holdDestination(ECpdsSession session,
 String destinationName,
 boolean graceful)
                                   throws MasterException,
RemoteException,
DataBaseException

Hold destination.

Parameters:

session - the session

destinationName - the Destination name

graceful - the graceful

Returns:

the destination scheduler cache

Throws:

MasterException - the master exception

RemoteException - the remote exception

DataBaseException - the data base exception

holdAllDestinations

void holdAllDestinations(ECpdsSession session,
 boolean graceful)
                  throws MasterException,
RemoteException

Hold all destinations.

Parameters:

session - the session

graceful - the graceful

Throws:

MasterException - the master exception

RemoteException - the remote exception

transferStatusUpdateAllowed

boolean transferStatusUpdateAllowed(long id,
 String code)
                             throws MasterException,
RemoteException

Transfer status update allowed.

Parameters:

id - the id

code - the code

Returns:

true, if successful

Throws:

MasterException - the master exception

RemoteException - the remote exception

updateTransferStatus

boolean updateTransferStatus(ECpdsSession session,
 long id,
 String code)
                      throws MasterException,
RemoteException

Update transfer status.

Parameters:

session - the session

id - the id

code - the code

Returns:

true, if successful

Throws:

MasterException - the master exception

RemoteException - the remote exception

resetTransferScheduleDate

void resetTransferScheduleDate(ECpdsSession session,
 long id)
                        throws MasterException,
DataBaseException,
RemoteException

Reset transfer schedule date.

Parameters:

session - the session

id - the id

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

updateTransferPriority

void updateTransferPriority(ECpdsSession session,
 long id,
 int priority)
                     throws MasterException,
DataBaseException,
RemoteException

Update transfer priority.

Parameters:

session - the session

id - the id

priority - the priority

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

updateExpiryTime

void updateExpiryTime(ECpdsSession session,
 long id,
 Timestamp timetamp)
               throws MasterException,
DataBaseException,
RemoteException

Update expiry time.

Parameters:

session - the session

id - the id

timetamp - the timetamp

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

transfer

long transfer(ECpdsSession session,
 byte[] bytes,
 Host host,
 String target,
 long remotePosn)
       throws MasterException,
DataBaseException,
IOException

Transfer.

Parameters:

session - the session

bytes - the bytes

host - the host

target - the target

remotePosn - the remote posn

Returns:

the long

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

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

getMoverReport

String getMoverReport(ECpdsSession session,
 Host proxyHost)
               throws MasterException,
DataBaseException,
IOException

Gets the mover report.

Parameters:

session - the session

proxyHost - the proxy host

Returns:

the mover report

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

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

getHostReport

String getHostReport(ECpdsSession session,
 Host proxyHost,
 Host host)
              throws MasterException,
DataBaseException,
IOException

Gets the host report.

Parameters:

session - the session

proxyHost - the proxy host

host - the host

Returns:

the host report

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

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

cleanDataWindow

void cleanDataWindow(ECpdsSession session,
 Host host)
              throws MasterException,
DataBaseException,
IOException

Clean the data window host.

Parameters:

session - the session

host - the host

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

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

resetTransferStatistics

void resetTransferStatistics(ECpdsSession session,
 Host host)
                      throws MasterException,
DataBaseException,
IOException

Reset the host stats.

Parameters:

session - the session

host - the host

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

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

getReport

String getReport(ECpdsSession session,
 Host host)
          throws MasterException,
DataBaseException,
IOException

Gets the report.

Parameters:

session - the session

host - the host

Returns:

the report

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

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

getOutput

RemoteInputStream getOutput(ECpdsSession session,
 Host host)
                     throws MasterException,
DataBaseException,
IOException

Gets the host output.

Parameters:

session - the session

host - the host

Returns:

the report

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

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

isAcquisitionRunning

boolean isAcquisitionRunning(ECpdsSession session,
 Host host)
                      throws RemoteException

Check whether an acquisition thread is currently running for the given Host.

Parameters:

session - the session

host - the host

Returns:

true if an acquisition thread for this host is active right now

Throws:

RemoteException

triggerAcquisition

void triggerAcquisition(ECpdsSession session,
 Host host)
                 throws RemoteException

Trigger acquisition for the given Host immediately by resetting its acquisition time. Does nothing if the host is already running.

Parameters:

session - the session

host - the host

Throws:

RemoteException - the remote exception

execDirScript

String execDirScript(ECpdsSession session,
 Host host,
 String script)
              throws MasterException,
DataBaseException,
IOException

Execute a Directory script on the DataMover for the given host and return the result as a GZIPped input stream. This replicates the production acquisition path: the script is sent to a DataMover in the host's transfer group.

Parameters:

session - the session

host - the host

script - the script content, optionally prefixed with "python:" or "js:" to select the language

Returns:

a GZIPped input stream containing the script output (a newline-separated list of paths or a URL)

Throws:

MasterException - the master exception

DataBaseException - the data base exception

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

resolveDirText

String resolveDirText(ECpdsSession session,
 Host host,
 String text)
               throws MasterException,
DataBaseException,
IOException

Resolve all static placeholder tokens in a plain-text Directory field and return the resolved text. Substitutes $host[...], $transferMethod[...], $ectransModule[...] and $date/$dirdate tokens using the current date. Does not require a DataMover — runs entirely on the MasterServer.

Parameters:

session - the session

host - the host whose fields are used for substitution

text - the plain-text directory content

Returns:

the resolved text

Throws:

MasterException - the master exception

DataBaseException - the data base exception

IOException

fetchUrlContent

String fetchUrlContent(ECpdsSession session,
 Host host,
 String source,
 int maxBytes)
                throws MasterException,
DataBaseException,
IOException

Fetch the raw content of a remote URL/path via the host's configured ECtrans module on the DataMover.

Parameters:

session - the session

host - the host whose ECtrans module is used

source - the remote URL or path to retrieve

maxBytes - maximum number of bytes to return

Returns:

the content as a UTF-8 string (truncated if needed)

Throws:

MasterException - the master exception

DataBaseException - the data base exception

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

interruptAcquisition

void interruptAcquisition(ECpdsSession session,
 Host host)
                   throws RemoteException

Interrupt a running acquisition thread for the given Host and immediately restart it. If no acquisition is running the host output is still reset, triggering a fresh run on the next scheduler cycle.

Parameters:

session - the session

host - the host

Throws:

RemoteException - the remote exception

getReport

String getReport(ECpdsSession session,
 TransferServer server)
          throws MasterException,
DataBaseException,
IOException

Gets the report.

Parameters:

session - the session

server - the server

Returns:

the report

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

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

updateHost

Host updateHost(ECpdsSession session,
 Host host)
         throws MasterException,
DataBaseException,
RemoteException

Update host.

Parameters:

session - the session

host - the host

Returns:

the host

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

updateTransferMonitoringValue

void updateTransferMonitoringValue(ECpdsSession session,
 MonitoringValue value)
                            throws MasterException,
DataBaseException,
RemoteException

Update transfer monitoring value.

Parameters:

session - the session

value - the monitoring value

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

updateFileMonitoringValue

void updateFileMonitoringValue(ECpdsSession session,
 MonitoringValue value)
                        throws MasterException,
DataBaseException,
RemoteException

Update file monitoring value.

Parameters:

session - the session

value - the monitoring value

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

shutdown

void shutdown(ECpdsSession session,
 boolean graceful,
 boolean restart)
       throws MasterException,
RemoteException

Shutdown.

Parameters:

session - the session

graceful - the graceful

restart - the restart

Throws:

MasterException - the master exception

RemoteException - the remote exception

removeTransferMethod

void removeTransferMethod(ECpdsSession session,
 TransferMethod method)
                   throws MasterException,
DataBaseException,
RemoteException

Removes the transfer method.

Parameters:

session - the session

method - the method

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removeECtransModule

void removeECtransModule(ECpdsSession session,
 ECtransModule module)
                  throws MasterException,
DataBaseException,
RemoteException

Removes the ectrans module.

Parameters:

session - the session

module - the module

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removeTransferGroup

void removeTransferGroup(ECpdsSession session,
 TransferGroup group)
                  throws MasterException,
DataBaseException,
RemoteException

Removes the transfer group.

Parameters:

session - the session

group - the group

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removeDestination

void removeDestination(ECpdsSession session,
 String destinationName)
                throws MasterException,
DataBaseException,
RemoteException

Removes the destination.

Parameters:

session - the session

destinationName - the Destination name

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removeDestination

void removeDestination(ECpdsSession session,
 String destinationName,
 boolean cleanOnly,
 boolean removeAll)
                throws MasterException,
DataBaseException,
RemoteException

Removes the destination.

Parameters:

session - the session

destinationName - the Destination name

cleanOnly - clean only and don't delete the Destination

removeAll - remove all files or only deleted, expired, stopped and failed ones if clean only

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removeTransferServer

void removeTransferServer(ECpdsSession session,
 TransferServer server)
                   throws MasterException,
DataBaseException,
RemoteException

Removes the transfer server.

Parameters:

session - the session

server - the server

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removeHost

void removeHost(ECpdsSession session,
 Host host)
         throws MasterException,
DataBaseException,
RemoteException

Removes the host.

Parameters:

session - the session

host - the host

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removeIncomingUser

void removeIncomingUser(ECpdsSession session,
 IncomingUser user)
                 throws MasterException,
DataBaseException,
RemoteException

Removes the IncomingUser.

Parameters:

session - the session

user - the incoming user

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

getPortalSubscribersByUser

List<PortalSubscriber> getPortalSubscribersByUser(ECpdsSession session,
 String inuId)
                                           throws MasterException,
DataBaseException,
RemoteException

Gets all PortalSubscribers for a given IncomingUser.

Parameters:

session - the session

inuId - the incoming user id

Returns:

the portal subscribers

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

updatePortalSubscriber

void updatePortalSubscriber(ECpdsSession session,
 PortalSubscriber sub)
                     throws MasterException,
DataBaseException,
RemoteException

Updates a PortalSubscriber.

Parameters:

session - the session

sub - the portal subscriber

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

approvePortalSubscriber

void approvePortalSubscriber(ECpdsSession session,
 PortalSubscriber sub)
                      throws MasterException,
DataBaseException,
RemoteException

Activates a PortalSubscriber and sends the credentials email to the subscriber. This is the method to call when an administrator manually approves a pending subscriber. The subscriber's stored password is included in the email along with any extra text configured via portal.registrationEmailExtraAccess.

Parameters:

session - the session

sub - the portal subscriber to approve

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removePortalSubscriber

void removePortalSubscriber(ECpdsSession session,
 PortalSubscriber sub)
                     throws MasterException,
DataBaseException,
RemoteException

Removes a PortalSubscriber permanently.

Parameters:

session - the session

sub - the portal subscriber

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

insertPortalSubscriber

String insertPortalSubscriber(ECpdsSession session,
 String inuId,
 String email,
 String name,
 String iso)
                       throws MasterException,
DataBaseException,
RemoteException

Creates a new PortalSubscriber for the given IncomingUser with the specified attributes. The subscriber is created in the active state (no email verification required) and a random password is generated and returned.

Parameters:

session - the session

inuId - the IncomingUser login to associate the subscriber with

email - the subscriber email address

name - the subscriber display name

iso - the ISO 3166-1 alpha-2 country code (may be null or empty)

Returns:

the generated plaintext password for the new subscriber

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removeIncomingPolicy

void removeIncomingPolicy(ECpdsSession session,
 IncomingPolicy policy)
                   throws MasterException,
DataBaseException,
RemoteException

Removes the IncomingPolicy.

Parameters:

session - the session

policy - the policy

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removeDataTransfer

void removeDataTransfer(ECpdsSession session,
 DataTransfer transfer)
                 throws MasterException,
DataBaseException,
RemoteException

Removes the data transfer.

Parameters:

session - the session

transfer - the transfer

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

interruptDataTransferRetrieval

boolean interruptDataTransferRetrieval(ECpdsSession session,
 long id)
                                throws MasterException,
RemoteException,
DataBaseException

Interrupt data transfer retrieval.

Parameters:

session - the session

id - the id

Returns:

true, if successful

Throws:

MasterException - the master exception

RemoteException - the remote exception

DataBaseException - the data base exception

removeDataFile

void removeDataFile(ECpdsSession session,
 DataFile file)
             throws MasterException,
DataBaseException,
RemoteException

Removes the data file.

Parameters:

session - the session

file - the file

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removeWebUser

void removeWebUser(ECpdsSession session,
 WebUser user)
            throws MasterException,
DataBaseException,
RemoteException

Removes the web user.

Parameters:

session - the session

user - the web user

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removeCategory

void removeCategory(ECpdsSession session,
 Category category)
             throws MasterException,
DataBaseException,
RemoteException

Removes the category.

Parameters:

session - the session

category - the category

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

removeUrl

void removeUrl(ECpdsSession session,
 Url url)
        throws MasterException,
DataBaseException,
RemoteException

Removes the url.

Parameters:

session - the session

url - the url

Throws:

MasterException - the master exception

DataBaseException - the data base exception

RemoteException - the remote exception

resendDataTransferEvents

void resendDataTransferEvents(String root,
 DataTransferEventRequest[] dataTransferEventRequests)
                       throws RemoteException

Resend data transfer events.

Parameters:

root - the root

dataTransferEventRequests - the data transfer event requests

Throws:

RemoteException - the remote exception

exec

byte[] exec(ECpdsSession session,
 Map<String,String> environment,
 byte[] request,
 String service)
     throws MasterException,
IOException

Exec.

Parameters:

session - the session

environment - the environment

request - the request

service - the service

Returns:

the byte[]

Throws:

MasterException - the master exception

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

RemoteException - the remote exception

getDestinationSchedulerCache

DestinationSchedulerCache getDestinationSchedulerCache(String destinationName)
                                                throws MasterException,
RemoteException

Gets the destination scheduler cache.

Parameters:

destinationName - the destination name

Returns:

the destination scheduler cache

Throws:

MasterException - the master exception

RemoteException - the remote exception

computeFilterEfficiency

String computeFilterEfficiency(ECpdsSession session,
 String destinationName,
 String email,
 String filter,
 long date,
 boolean includeStdby,
 String pattern)
                        throws DataBaseException,
MasterException,
RemoteException

Compute filter efficiency.

Parameters:

session - the session

destinationName - the destination name

email - the email

filter - the filter

date - the date

includeStdby - the include stdby

pattern - the pattern

Returns:

the string

Throws:

DataBaseException - the data base exception

MasterException - the master exception

RemoteException - the remote exception

getVolumeUsage

Map<String,long[][]> getVolumeUsage(String groupName)
                             throws MasterException,
RemoteException

Gets a snapshot of volume disk usage for one or all transfer groups.

Returns the most recently polled used and total bytes per volume index, as maintained by the background usage updater in TransferServerProvider.WeightedAllocator. No DataMover RMI calls are made; the result comes from the in-memory cache only.

Parameters:

groupName - the transfer group name to query, or null for all registered groups

Returns:

a map of group name to long[volumeIndex][2] where [i][0] is used bytes and [i][1] is total bytes; never null; empty if no data has been collected yet

Throws:

MasterException - the master exception

RemoteException - the remote exception

getMoverVolumeUsage

Map<String,long[][]> getMoverVolumeUsage(String moverName)
                                  throws MasterException,
RemoteException

Gets a snapshot of per-volume disk usage for one or all DataMovers.

Returns the most recently polled used and total bytes per volume index for each DataMover, as cached by the background usage updater. No DataMover RMI calls are made at query time.

Parameters:

moverName - the DataMover name to query, or null for all DataMovers

Returns:

a map of mover name to long[2][volumeCount] where [0][i] is used bytes and [1][i] is total bytes for volume i; never null

Throws:

MasterException - the master exception

RemoteException - the remote exception

getMoverAvailability

List<long[]> getMoverAvailability(String moverName,
 int hours)
                           throws MasterException,
RemoteException

Returns availability snapshots for the given DataMover from the database.

Each element is a long[2] where [0] is the minute bucket in epoch-ms and [1] is 1 (mover was up) or 0 (mover was down) during that minute.

Parameters:

moverName - the data mover name

hours - how many hours of history to return

Returns:

time-ordered list of minute-bucket availability entries; never null

Throws:

MasterException - the master exception

RemoteException - the remote exception

getDownloadMetrics

Map<String,int[]> getDownloadMetrics()
                              throws MasterException,
RemoteException

Returns a snapshot of the current in-flight download counts for all data movers and all volumes.

The map key is "groupName.moverName" (e.g. "group-04.bodh1ecpdmv-04"). The value is an int[] where index i holds the current download count on volume i. Only movers with at least one recorded download event appear in the map.

Returns:

a sorted snapshot of download counts per mover and volume; never null

Throws:

MasterException - the master exception

RemoteException - the remote exception