AgaveHandler Class Reference

The AgaveHandler is a class for communicating with an Agave server over an https connection. More...

Public Slots
virtual QString	getUserName ()
virtual RemoteDataReply *	closeAllConnections ()
virtual RemoteDataReply *	performAuth (QString uname, QString passwd)
virtual RemoteDataReply *	remoteLS (QString dirPath)
virtual RemoteDataReply *	deleteFile (QString toDelete)
virtual RemoteDataReply *	moveFile (QString from, QString to)
virtual RemoteDataReply *	copyFile (QString from, QString to)
virtual RemoteDataReply *	renameFile (QString fullName, QString newName)
virtual RemoteDataReply *	mkRemoteDir (QString location, QString newName)
virtual RemoteDataReply *	uploadFile (QString location, QString localFileName)
virtual RemoteDataReply *	uploadBuffer (QString location, QByteArray fileData, QString newFileName)
virtual RemoteDataReply *	downloadFile (QString localDest, QString remoteName)
virtual RemoteDataReply *	downloadBuffer (QString remoteName)
virtual RemoteDataReply *	runRemoteJob (QString jobName, ParamMap jobParameters, QString remoteWorkingDir, QString indivJobName="", QString archivePath="")
virtual RemoteDataReply *	getListOfJobs ()
virtual RemoteDataReply *	getJobDetails (QString IDstr)
virtual RemoteDataReply *	stopJob (QString IDstr)
virtual RemoteDataReply *	deleteJob (QString IDstr)
virtual RemoteDataInterfaceState	getInterfaceState ()
void	registerAgaveAppInfo (QString agaveAppName, QString fullAgaveName, QStringList parameterList, QStringList inputList, QString workingDirParameter)
AgaveTaskReply *	getAgaveAppList ()
void	setAgaveConnectionParams (QString tenant, QString clientId, QString storage)
RemoteDataReply *	runAgaveJob (QJsonDocument rawJobJSON)
Public Slots inherited from RemoteDataInterface
virtual QString	getUserName ()=0
	After login, getUserName will return the name of the user logged in.
virtual RemoteDataReply *	closeAllConnections ()=0
virtual RemoteDataReply *	performAuth (QString uname, QString passwd)=0
virtual RemoteDataReply *	remoteLS (QString dirPath)=0
virtual RemoteDataReply *	deleteFile (QString toDelete)=0
virtual RemoteDataReply *	moveFile (QString from, QString to)=0
virtual RemoteDataReply *	copyFile (QString from, QString to)=0
virtual RemoteDataReply *	renameFile (QString fullName, QString newName)=0
virtual RemoteDataReply *	mkRemoteDir (QString location, QString newName)=0
virtual RemoteDataReply *	uploadFile (QString location, QString localFileName)=0
virtual RemoteDataReply *	uploadBuffer (QString location, QByteArray fileData, QString newFileName)=0
virtual RemoteDataReply *	downloadFile (QString localDest, QString remoteName)=0
virtual RemoteDataReply *	downloadBuffer (QString remoteName)=0
virtual RemoteDataReply *	runRemoteJob (QString jobName, ParamMap jobParameters, QString remoteWorkingDir, QString indivJobName="", QString archivePath="")=0
virtual RemoteDataReply *	getListOfJobs ()=0
virtual RemoteDataReply *	getJobDetails (QString IDstr)=0
virtual RemoteDataReply *	stopJob (QString IDstr)=0
virtual RemoteDataReply *	deleteJob (QString IDstr)=0
virtual RemoteDataInterfaceState	getInterfaceState ()=0
static QString	interpretRequestState (RequestState theState)
static QString	removeDoubleSlashes (QString stringIn)

Public Member Functions
	AgaveHandler (QNetworkAccessManager *netAccessManager, QObject *parent=nullptr)
Public Member Functions inherited from RemoteDataInterface
	RemoteDataInterface (QObject *parent=nullptr)
	Brief Constructor description. Brief Constructor description continued. More...

Protected Member Functions
void	handleInternalTask (AgaveTaskReply *agaveReply, QNetworkReply *rawReply)
void	handleInternalTask (AgaveTaskReply *agaveReply, RequestState taskState)

Friends
class	AgaveTaskReply

Additional Inherited Members
Signals inherited from RemoteDataInterface
void	connectionStateChanged (RemoteDataInterfaceState newState)

Detailed Description

The AgaveHandler is a class for communicating with an Agave server over an https connection.

Each AgaveHandler is one use, from initialization, to login, through multiple remote requests, to logout. If an application wishes to re-login, a new AgaveHandler object should be created.

First, the setAgaveConnectionParams meshod should be invoked, to define some basic Agave parameters, such as the remote tenant name. Then, the performAuth method should be invoked until a successful reply is given. After that, the various remote tasks can be performed. When finished, the closeAllConnections method will logout of the remote Agave server.