Package | Description |
---|---|
org.icatproject.icat.client |
RESTFul ICAT Interface.
|
Modifier and Type | Method and Description |
---|---|
long |
Session.cloneEntity(String name,
long id,
Map<String,String> keys)
Clone an entity and return the id of the clone
|
List<Long> |
Session.create(String entities)
Deprecated.
Replace by
Session.write(String) |
void |
Session.delete(String entities)
Delete ICAT entities specified by a Json String.
|
InputStream |
Session.exportMetaData(Session.Attributes attributes)
Export all metadata from ICAT.
|
InputStream |
Session.exportMetaData(String query,
Session.Attributes attributes)
Export metadata from ICAT as specified in the query
|
String |
Session.get(String query,
long id)
Carry out an ICAT get.
|
String |
ICAT.getApiVersion()
Deprecated.
|
String |
ICAT.getProperties()
Return a json string of properties.
|
double |
Session.getRemainingMinutes()
Return the time remaining in the session in minutes
|
String |
Session.getUserName()
Return the user name corresponding to the session.
|
String |
ICAT.getVersion()
Return the version of the ICAT server
|
void |
Session.importMetaData(Path path,
Session.DuplicateAction duplicateAction,
Session.Attributes attributes)
Import metadata into ICAT for a file specified by a Path
|
boolean |
ICAT.isLoggedIn(String userName)
See whether or not someone is logged in.
|
String |
Session.list(String path) |
String |
ICAT.list(String sessionId,
String path) |
Session |
ICAT.login(String plugin,
Map<String,String> credentials)
Login to a RESTful ICAT instance and return a Session
|
void |
Session.logout()
Logout of the session after which the session cannot be re-used
|
void |
Session.luceneClear()
Clear the lucene populating list
|
void |
Session.luceneCommit()
Force a commit of the lucene database
|
List<String> |
Session.luceneGetPopulating()
Return a list of class names for which population is going on
|
void |
Session.lucenePopulate(String entityName,
long minid)
Clear and repopulate lucene documents for the specified entityName.
|
void |
Session.refresh()
Refresh the session by resetting the time remaining
|
String |
Session.search(String query)
Carry out an ICAT search.
|
String |
Session.searchDatafiles(String user,
String text,
Date lower,
Date upper,
List<ParameterForLucene> parameters,
int maxResults)
Return a set of data files satisfying the constraints
|
String |
Session.searchDatasets(String user,
String text,
Date lower,
Date upper,
List<ParameterForLucene> parameters,
int maxResults)
Return a set of datasets satisfying the constraints
|
String |
Session.searchInvestigations(String user,
String text,
Date lower,
Date upper,
List<ParameterForLucene> parameters,
List<String> samples,
String userFullName,
int maxResults)
Return a set of investigations satisfying the constraints
|
void |
Session.waitMillis(long ms)
Wait for the specified number of milliseconds and return.
|
void |
ICAT.waitMillis(String sessionId,
long ms) |
List<Long> |
Session.write(String entities)
Write (create or update) ICAT entities from a Json String.
|
Copyright © 2022 The ICAT Collaboration. All rights reserved.