public interface OpenBISAddon extends ServerAddon
Modifier and Type | Method and Description |
---|---|
void |
addTransferListener(OpenBISListener listener)
Adds a listener which gets informed about the current state of the transfer.
|
void |
cancelTransfer()
Tries to interrupt a running transfer of data.
|
boolean |
isTransferring()
Returns true if there is a currently active transfer taking place, and false otherwise.
|
void |
removeTransferListener(OpenBISListener listener)
Removes a previously added listener.
|
void |
transferMeasurement(java.lang.String sshUser,
java.lang.String sshServer,
java.lang.String sshDirectory,
java.lang.String openBISUser,
java.lang.String projectIdentifier,
java.lang.String measurementIdentifier,
java.lang.String measurementFolder,
boolean overwrite)
Transfers a measurement to OpenBIS and saves it there under openBISUser/projectIdentifier/measurementIdentifier.
|
getAddonDescription, getAddonID, getAddonName, getAddonVersion
void transferMeasurement(java.lang.String sshUser, java.lang.String sshServer, java.lang.String sshDirectory, java.lang.String openBISUser, java.lang.String projectIdentifier, java.lang.String measurementIdentifier, java.lang.String measurementFolder, boolean overwrite) throws java.rmi.RemoteException, OpenBISException
sshUser
- The user name for the SSH connection.sshServer
- The SSH server name (i.e.: the OpenBIS server).sshDirectory
- The directory configured as the drop box on the OpenBIS server, e.g. "~/servers/datastore_server/data/microscope". This folder must be the same as configured in OpenBIS for incoming microscopy files.openBISUser
- Identifier of the OpenBIS user. The user name has to be already configured using the OpenBIS UI. Usually different then the SSH user name.projectIdentifier
- Identifier of the project the measurement belongs to. The project identifier has to be already configured under the user name using the OpenBIS UI.measurementIdentifier
- An identifier for the measurement. The measurement does NOT have to be configured before.measurementFolder
- The folder on the YouScope server where the measurement data is saved.overwrite
- True if an existing measurement in OpenBIS should be overwritten, false if not.java.rmi.RemoteException
OpenBISException
- Thrown if transfer could not be initialized.void cancelTransfer() throws java.rmi.RemoteException
java.rmi.RemoteException
boolean isTransferring() throws java.rmi.RemoteException
java.rmi.RemoteException
void addTransferListener(OpenBISListener listener) throws java.rmi.RemoteException
listener
- Listener to add.java.rmi.RemoteException
void removeTransferListener(OpenBISListener listener) throws java.rmi.RemoteException
listener
- Listener to remove.java.rmi.RemoteException