|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDssServiceRpcGeneric
Generic functionality for interacting with the DSS.
Field Summary | |
---|---|
static java.lang.String |
DSS_SERVICE_NAME
|
Method Summary | |
---|---|
QueryTableModel |
createReportFromAggregationService(java.lang.String sessionToken,
java.lang.String aggregationServiceName,
java.util.Map<java.lang.String,java.lang.Object> parameters)
Create the report from the specified aggregation service. |
QueryTableModel |
createReportFromDataSets(java.lang.String sessionToken,
java.lang.String serviceKey,
java.util.List<java.lang.String> dataSetCodes)
Creates for the specified data sets a report. |
boolean |
deleteSessionWorkspaceFile(java.lang.String sessionToken,
java.lang.String path)
Delete a file or directory in the session workspace. |
java.lang.String |
getDownloadUrlForFileForDataSet(java.lang.String sessionToken,
DataSetFileDTO fileOrFolder)
Returns an URL from which the requested file. |
java.lang.String |
getDownloadUrlForFileForDataSet(java.lang.String sessionToken,
java.lang.String dataSetCode,
java.lang.String path)
Returns an URL from which the requested file of the specified data set can be downloaded. |
java.lang.String |
getDownloadUrlForFileForDataSetWithTimeout(java.lang.String sessionToken,
DataSetFileDTO fileOrFolder,
long validityDurationInSeconds)
Returns an URL from which the requested file. |
java.lang.String |
getDownloadUrlForFileForDataSetWithTimeout(java.lang.String sessionToken,
java.lang.String dataSetCode,
java.lang.String path,
long validityDurationInSeconds)
Returns an URL from which the requested file of the specified data set can be downloaded. |
java.io.InputStream |
getFileForDataSet(java.lang.String sessionToken,
DataSetFileDTO fileOrFolder)
Deprecated. use getDownloadUrlForFileForDataSet(String, DataSetFileDTO) . |
java.io.InputStream |
getFileForDataSet(java.lang.String sessionToken,
java.lang.String dataSetCode,
java.lang.String path)
Deprecated. use getDownloadUrlForFileForDataSet(String, String, String) . |
java.io.InputStream |
getFileFromSessionWorkspace(java.lang.String sessionToken,
java.lang.String filePath)
Download a file from the user's session workspace. |
java.lang.String |
getPathToDataSet(java.lang.String sessionToken,
java.lang.String dataSetCode,
java.lang.String overrideStoreRootPathOrNull)
Get a path to the data set. |
java.lang.String |
getValidationScript(java.lang.String sessionToken,
java.lang.String dataSetTypeOrNull)
Get the validation script for the specified data set type. |
java.util.List<AggregationServiceDescription> |
listAggregationServices(java.lang.String sessionToken)
Returns metadata for all aggregation services. |
java.util.List<ShareInfo> |
listAllShares(java.lang.String sessionToken)
Lists all shares. |
FileInfoDssDTO[] |
listFilesForDataSet(java.lang.String sessionToken,
DataSetFileDTO fileOrFolder)
Get an array of FileInfoDss objects that describe the file-system structure of the data set. |
FileInfoDssDTO[] |
listFilesForDataSet(java.lang.String sessionToken,
java.lang.String dataSetCode,
java.lang.String path,
boolean isRecursive)
Get an array of FileInfoDss objects that describe the file-system structure of the data set. |
java.util.List<ReportDescription> |
listTableReportDescriptions(java.lang.String sessionToken)
Returns meta data for all reporting plugins which deliver a table. |
java.lang.String |
putDataSet(java.lang.String sessionToken,
NewDataSetDTO newDataset,
java.io.InputStream inputStream)
Upload a new data set to the DSS. |
long |
putFileSliceToSessionWorkspace(java.lang.String sessionToken,
java.lang.String filePath,
long slicePosition,
java.io.InputStream sliceInputStream)
Upload a file slice to the user's session workspace. |
long |
putFileToSessionWorkspace(java.lang.String sessionToken,
java.lang.String filePath,
java.io.InputStream inputStream)
Upload a new file to the user's session workspace. |
void |
shuffleDataSet(java.lang.String sessionToken,
java.lang.String dataSetCode,
java.lang.String shareId)
Moves specified data set to specified share. |
Methods inherited from interface ch.systemsx.cisd.common.api.IRpcService |
---|
getMajorVersion, getMinorVersion |
Field Detail |
---|
static final java.lang.String DSS_SERVICE_NAME
Method Detail |
---|
FileInfoDssDTO[] listFilesForDataSet(java.lang.String sessionToken, DataSetFileDTO fileOrFolder) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked, java.lang.IllegalArgumentException
sessionToken
- The session tokenfileOrFolder
- The file or folder to get information on
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if an IOException occurs when listing the files
java.lang.IllegalArgumentException
- Thrown if the dataSetCode or startPath are not valid@Deprecated java.io.InputStream getFileForDataSet(java.lang.String sessionToken, DataSetFileDTO fileOrFolder) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked, java.lang.IllegalArgumentException
getDownloadUrlForFileForDataSet(String, DataSetFileDTO)
.
sessionToken
- The session tokenfileOrFolder
- The file or folder to retrieve
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if an IOException occurs when listing the files
java.lang.IllegalArgumentException
- Thrown if the dataSetCode or startPath are not validjava.lang.String getDownloadUrlForFileForDataSet(java.lang.String sessionToken, DataSetFileDTO fileOrFolder) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked, java.lang.IllegalArgumentException
sessionToken
- The session tokenfileOrFolder
- The file or folder to retrieve
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if an IOException occurs when listing the files
java.lang.IllegalArgumentException
- Thrown if the dataSetCode or startPath are not validjava.lang.String getDownloadUrlForFileForDataSetWithTimeout(java.lang.String sessionToken, DataSetFileDTO fileOrFolder, long validityDurationInSeconds) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked, java.lang.IllegalArgumentException
sessionToken
- The session tokenfileOrFolder
- The file or folder to retrievevalidityDurationInSeconds
- The number of seconds for which the download URL should be
valid. The validity is clipped to the durations defined in the properties
data-stream-timeout and data-stream-max-timeout, which default
to 5 seconds and 4 hours, respectively.
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if an IOException occurs when listing the files
java.lang.IllegalArgumentException
- Thrown if the dataSetCode or startPath are not validFileInfoDssDTO[] listFilesForDataSet(java.lang.String sessionToken, java.lang.String dataSetCode, java.lang.String path, boolean isRecursive) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked, java.lang.IllegalArgumentException
sessionToken
- The session tokendataSetCode
- The data set to retrieve file information aboutpath
- The path within the data set to retrieve file information aboutisRecursive
- Should the result include information for sub folders?
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if an IOException occurs when listing the files
java.lang.IllegalArgumentException
- Thrown if the dataSetCode or startPath are not valid@Deprecated java.io.InputStream getFileForDataSet(java.lang.String sessionToken, java.lang.String dataSetCode, java.lang.String path) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked, java.lang.IllegalArgumentException
getDownloadUrlForFileForDataSet(String, String, String)
.
sessionToken
- The session tokendataSetCode
- The data set to retrieve file frompath
- The path within the data set to retrieve file information about
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if an IOException occurs when listing the files
java.lang.IllegalArgumentException
- Thrown if the dataSetCode or startPath are not validjava.lang.String getDownloadUrlForFileForDataSet(java.lang.String sessionToken, java.lang.String dataSetCode, java.lang.String path) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked, java.lang.IllegalArgumentException
sessionToken
- The session tokendataSetCode
- The data set to retrieve file frompath
- The path within the data set to retrieve file information about
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if an IOException occurs when listing the files
java.lang.IllegalArgumentException
- Thrown if the dataSetCode or startPath are not validjava.lang.String getDownloadUrlForFileForDataSetWithTimeout(java.lang.String sessionToken, java.lang.String dataSetCode, java.lang.String path, long validityDurationInSeconds) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked, java.lang.IllegalArgumentException
sessionToken
- The session tokendataSetCode
- The data set to retrieve file frompath
- The path within the data set to retrieve file information aboutvalidityDurationInSeconds
- The number of seconds for which the download URL should be
valid.
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if an IOException occurs when listing the files
java.lang.IllegalArgumentException
- Thrown if the dataSetCode or startPath are not validjava.lang.String putDataSet(java.lang.String sessionToken, NewDataSetDTO newDataset, java.io.InputStream inputStream) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked, java.lang.IllegalArgumentException
sessionToken
- The session tokennewDataset
- The new data set that should be registeredinputStream
- An input stream on the file or folder to register
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if an IOException occurs when listing the files
java.lang.IllegalArgumentException
- Thrown if the dataSetCode or startPath are not validlong putFileToSessionWorkspace(java.lang.String sessionToken, java.lang.String filePath, java.io.InputStream inputStream) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
sessionToken
- The session token.filePath
- The file path (including the sub-directory) to upload the file to.inputStream
- An input stream on the file to upload.
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if because filePath does not exist.long putFileSliceToSessionWorkspace(java.lang.String sessionToken, java.lang.String filePath, long slicePosition, java.io.InputStream sliceInputStream) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
sessionToken
- The session token.filePath
- The file path (including the sub-directory) to upload the slice to.slicePosition
- The position the slice should be inserted at.sliceInputStream
- An input stream of the slice to be uploaded.
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if IOException occurs.java.io.InputStream getFileFromSessionWorkspace(java.lang.String sessionToken, java.lang.String filePath) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
sessionToken
- The session token.filePath
- The file path (including the sub-directory) to download the file from.
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if an IOException occurs.boolean deleteSessionWorkspaceFile(java.lang.String sessionToken, java.lang.String path)
true
if the path doesn't exist anymore.java.lang.String getPathToDataSet(java.lang.String sessionToken, java.lang.String dataSetCode, java.lang.String overrideStoreRootPathOrNull) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked, java.lang.IllegalArgumentException
NOTE: This method shouldn't be called for a container data set. No file would exist with the returned path.
sessionToken
- The session tokendataSetCode
- The data set to retrieve file fromoverrideStoreRootPathOrNull
- The path to replace the store path (see return comment).
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- if an IOException occurs when listing the files.
java.lang.IllegalArgumentException
- if dataSetCode is a container dataset.java.util.List<ShareInfo> listAllShares(java.lang.String sessionToken)
void shuffleDataSet(java.lang.String sessionToken, java.lang.String dataSetCode, java.lang.String shareId)
java.lang.IllegalArgumentException
- if data set does not exit or is a container data set or
share does not exist.java.lang.String getValidationScript(java.lang.String sessionToken, java.lang.String dataSetTypeOrNull) throws ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked, java.lang.IllegalArgumentException
sessionToken
- The session tokendataSetTypeOrNull
- The data set type the script should validate, or null to request the
generic validation script.
ch.systemsx.cisd.base.exceptions.IOExceptionUnchecked
- Thrown if an IOException occurs when accessing the script
java.lang.IllegalArgumentException
- Thrown if the data set type or startPath are not validjava.util.List<AggregationServiceDescription> listAggregationServices(java.lang.String sessionToken)
IQueryApiServer.listAggregationServices(String)
QueryTableModel createReportFromAggregationService(java.lang.String sessionToken, java.lang.String aggregationServiceName, java.util.Map<java.lang.String,java.lang.Object> parameters)
IQueryApiServer.createReportFromAggregationService(String, String, String, Map)
java.util.List<ReportDescription> listTableReportDescriptions(java.lang.String sessionToken)
IQueryApiServer.listTableReportDescriptions(String)
QueryTableModel createReportFromDataSets(java.lang.String sessionToken, java.lang.String serviceKey, java.util.List<java.lang.String> dataSetCodes)
IQueryApiServer.createReportFromDataSets(String, String, String, List)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |