Package ch.ethz.sis.openbis.generic.dssapi.v3

Interface IDataStoreServerApi

All Superinterfaces:

IRpcService

public interface IDataStoreServerApi
extends IRpcService

V3 data store server API. Detailed documentation on how to use the API together code examples in both Java and Javascript can be found at "openBIS V3 API" openBIS WIKI page.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_SERVICE_URL
static final int	MAJOR_VERSION
static final int	MINOR_VERSION
static final String	SERVICE_NAME	Name of this service for which it is registered at the RPC name server.
static final String	SERVICE_URL	Application part of the URL to access this service remotely.

Method Summary

Modifier and Type	Method	Description
List<DataSetPermId>	createDataSets(String sessionToken, List<FullDataSetCreation> newDataSets)	Creates full data sets (i.e.
FastDownloadSession	createFastDownloadSession(String sessionToken, List<? extends IDataSetFileId> fileIds, FastDownloadSessionOptions options)	Creates a download session for fast download of the requested files.
DataSetPermId	createUploadedDataSet(String sessionToken, UploadedDataSetCreation newDataSet)	Creates a data set which files have been already uploaded to data store server /store_share_file_upload servlet.
InputStream	downloadFiles(String sessionToken, List<? extends IDataSetFileId> fileIds, DataSetFileDownloadOptions downloadOptions)	Downloads files with the provided IDataSetFileId ids.
Object	executeCustomDSSService(String sessionToken, ICustomDSSServiceId serviceId, CustomDSSServiceExecutionOptions options)	Executes a custom data store server service with the provided ICustomDSSServiceId id.
SearchResult<DataSetFile>	searchFiles(String sessionToken, DataSetFileSearchCriteria searchCriteria, DataSetFileFetchOptions fetchOptions)	Searches for metadata of data set files basing on the provided DataSetFileSearchCriteria.

Methods inherited from interface ch.systemsx.cisd.common.api.IRpcService

getMajorVersion, getMinorVersion

Field Details

SERVICE_NAME

static final String SERVICE_NAME

Name of this service for which it is registered at the RPC name server.

See Also:

• Constant Field Values

SERVICE_URL

static final String SERVICE_URL

Application part of the URL to access this service remotely.

See Also:

• Constant Field Values

JSON_SERVICE_URL

static final String JSON_SERVICE_URL

See Also:

• Constant Field Values

MAJOR_VERSION

static final int MAJOR_VERSION

See Also:

• Constant Field Values

MINOR_VERSION

static final int MINOR_VERSION

See Also:

• Constant Field Values

Method Details

searchFiles

SearchResult<DataSetFile> searchFiles(String sessionToken,
 DataSetFileSearchCriteria searchCriteria,
 DataSetFileFetchOptions fetchOptions)

Searches for metadata of data set files basing on the provided DataSetFileSearchCriteria.

By default the returned data set files metdata contains only basic information. Any additional information to be fetched has to be explicitly requested via DataSetFileFetchOptions.

Required access rights: PROJECT_OBSERVER or stronger

Throws:

UserFailureException - in case of any problems

downloadFiles

InputStream downloadFiles(String sessionToken,
 List<? extends IDataSetFileId> fileIds,
 DataSetFileDownloadOptions downloadOptions)

Downloads files with the provided IDataSetFileId ids. The requested files are returned as a single InputStream. DataSetFileDownloadReader can be used to easily read individual files from that stream. Additional download options can be set via DataSetFileDownloadOptions.

Required access rights: PROJECT_OBSERVER or stronger

Throws:

UserFailureException - in case of any problems

createFastDownloadSession

FastDownloadSession createFastDownloadSession(String sessionToken,
 List<? extends IDataSetFileId> fileIds,
 FastDownloadSessionOptions options)

Creates a download session for fast download of the requested files.

Required access rights: PROJECT_OBSERVER or stronger

Throws:

UserFailureException - in case of any problems

createUploadedDataSet

DataSetPermId createUploadedDataSet(String sessionToken,
 UploadedDataSetCreation newDataSet)

Creates a data set which files have been already uploaded to data store server /store_share_file_upload servlet. Uploaded files and a data set to be created have to share the same upload id (the id can be set via uploadID request parameter during the upload and via UploadedDataSetCreation during a data set creation).

Required access rights: PROJECT_USER or stronger

Throws:

UserFailureException - in case of any problems

createDataSets

List<DataSetPermId> createDataSets(String sessionToken,
 List<FullDataSetCreation> newDataSets)

Creates full data sets (i.e. both data set metadata as well as data set files metadata).

Required access rights: SPACE_ETL_SERVER or stronger

Throws:

UserFailureException - in case of any problems

executeCustomDSSService

Object executeCustomDSSService(String sessionToken,
 ICustomDSSServiceId serviceId,
 CustomDSSServiceExecutionOptions options)

Executes a custom data store server service with the provided ICustomDSSServiceId id. Additional execution options (e.g. parameters) can be set via CustomDSSServiceExecutionOptions.

Required access rights: PROJECT_OBSERVER or stronger

Throws:

UserFailureException - in case of any problems