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 java.lang.String
JSON_SERVICE_URL
static java.lang.String
SERVICE_NAME
Name of this service for which it is registered at the RPC name server.static java.lang.String
SERVICE_URL
Application part of the URL to access this service remotely.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<DataSetPermId>
createDataSets(java.lang.String sessionToken, java.util.List<FullDataSetCreation> newDataSets)
Creates full data sets (i.e.FastDownloadSession
createFastDownloadSession(java.lang.String sessionToken, java.util.List<? extends IDataSetFileId> fileIds, FastDownloadSessionOptions options)
Creates a download session for fast download of the requested files.DataSetPermId
createUploadedDataSet(java.lang.String sessionToken, UploadedDataSetCreation newDataSet)
Creates a data set which files have been already uploaded to data store server /store_share_file_upload servlet.java.io.InputStream
downloadFiles(java.lang.String sessionToken, java.util.List<? extends IDataSetFileId> fileIds, DataSetFileDownloadOptions downloadOptions)
Downloads files with the providedIDataSetFileId
ids.SearchResult<DataSetFile>
searchFiles(java.lang.String sessionToken, DataSetFileSearchCriteria searchCriteria, DataSetFileFetchOptions fetchOptions)
Searches for metadata of data set files basing on the providedDataSetFileSearchCriteria
.-
Methods inherited from interface ch.systemsx.cisd.common.api.IRpcService
getMajorVersion, getMinorVersion
-
-
-
-
Field Detail
-
SERVICE_NAME
static final java.lang.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 java.lang.String SERVICE_URL
Application part of the URL to access this service remotely.- See Also:
- Constant Field Values
-
JSON_SERVICE_URL
static final java.lang.String JSON_SERVICE_URL
- See Also:
- Constant Field Values
-
-
Method Detail
-
searchFiles
SearchResult<DataSetFile> searchFiles(java.lang.String sessionToken, DataSetFileSearchCriteria searchCriteria, DataSetFileFetchOptions fetchOptions)
Searches for metadata of data set files basing on the providedDataSetFileSearchCriteria
.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
java.io.InputStream downloadFiles(java.lang.String sessionToken, java.util.List<? extends IDataSetFileId> fileIds, DataSetFileDownloadOptions downloadOptions)
Downloads files with the providedIDataSetFileId
ids. The requested files are returned as a singleInputStream
.DataSetFileDownloadReader
can be used to easily read individual files from that stream. Additional download options can be set viaDataSetFileDownloadOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
createFastDownloadSession
FastDownloadSession createFastDownloadSession(java.lang.String sessionToken, java.util.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(java.lang.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 viauploadID
request parameter during the upload and viaUploadedDataSetCreation
during a data set creation).Required access rights:
PROJECT_USER
or stronger- Throws:
UserFailureException
- in case of any problems
-
createDataSets
java.util.List<DataSetPermId> createDataSets(java.lang.String sessionToken, java.util.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
-
-