|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDssComponent
A component that manages a connection to openBIS and 1 or more data store servers.
The component is a kind of state machine. In the initial state, only login is allowed. After login, other operations may be called. Thus clients should follow the following usage pattern:
The IDssComponent itself is designed to be used in a single thread, though it may return objects that can be used in multiple threads. Documentation for the return values clarifies their level of thread safety.
Method Summary | |
---|---|
void |
checkSession()
Checks whether the session is alive. |
java.util.Map<java.lang.String,java.lang.String> |
extractMetadata(NewDataSetDTO newDataset,
java.io.File dataSetFile)
Tries to extract the data set property key-values (metadata) from the data. |
IDataSetDss |
getDataSet(java.lang.String code)
Get a proxy to the data set designated by the given data set code. |
java.lang.String |
getSessionToken()
Returns the session token. |
void |
logout()
Logs the current user out. |
IDataSetDss |
putDataSet(NewDataSetDTO newDataset,
java.io.File dataSetFile)
Upload a new data set to the DSS. |
java.util.List<ValidationError> |
validateDataSet(NewDataSetDTO newDataset,
java.io.File dataSetFile)
Validate a data set. |
Method Detail |
---|
void checkSession() throws InvalidSessionException
InvalidSessionException
- If the session is not alive.java.lang.String getSessionToken() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- Thrown if the user has not yet been authenticated.IDataSetDss getDataSet(java.lang.String code) throws java.lang.IllegalStateException, EnvironmentFailureException
java.lang.IllegalStateException
- Thrown if the user has not yet been authenticated.
EnvironmentFailureException
- Thrown in cases where it is not possible to connect to
the server.IDataSetDss putDataSet(NewDataSetDTO newDataset, java.io.File dataSetFile) throws java.lang.IllegalStateException, EnvironmentFailureException
newDataset
- The new data set that should be registereddataSetFile
- A file or folder containing the data
java.lang.IllegalStateException
- Thrown if the user has not yet been authenticated.
EnvironmentFailureException
- Thrown in cases where it is not possible to connect to
the server.java.util.List<ValidationError> validateDataSet(NewDataSetDTO newDataset, java.io.File dataSetFile) throws java.lang.IllegalStateException, EnvironmentFailureException
newDataset
- The new data set that should be registereddataSetFile
- A file or folder containing the data
java.lang.IllegalStateException
- Thrown if the user has not yet been authenticated.
EnvironmentFailureException
- Thrown in cases where it is not possible to connect to
the server.java.util.Map<java.lang.String,java.lang.String> extractMetadata(NewDataSetDTO newDataset, java.io.File dataSetFile) throws java.lang.IllegalStateException, EnvironmentFailureException
newDataset
- The new data set that should be registereddataSetFile
- A file or folder containing the data
java.lang.IllegalStateException
- Thrown if the user has not yet been authenticated.
EnvironmentFailureException
- Thrown in cases where it is not possible to connect to
the server.void logout()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |