Package ch.systemsx.cisd.openbis.plugin.query.shared.api.v1

Interface IQueryApiServer

  • All Superinterfaces:
    IRpcService
    public interface IQueryApiServer
extends IRpcService
    Public API interface to query server (version 1.4).

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String JSON_SERVICE_URL  
      static java.lang.String QUERY_PLUGIN_SERVER_URL
      Service part of the URL to access this service remotely.
      static java.lang.String SERVICE_NAME
      Name of this service for which it is registered at the RPC name server.

    • 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

      • QUERY_PLUGIN_SERVER_URL

        static final java.lang.String QUERY_PLUGIN_SERVER_URL
        Service part of the URL to access this service remotely.
        See Also:
        Constant Field Values

    • Method Detail

      • tryToAuthenticateAtQueryServer

        @Transactional
java.lang.String tryToAuthenticateAtQueryServer​(java.lang.String userID,
                                                java.lang.String userPassword)
        Tries to authenticate specified user with specified password. Returns session token if succeeded otherwise null is returned.

      • logout

        @Transactional(readOnly=true)
void logout​(java.lang.String sessionToken)
        Logout the session with the specified session token.

      • listQueries

        @Transactional(readOnly=true)
java.util.List<QueryDescription> listQueries​(java.lang.String sessionToken)
        Lists all queries available for the user of the specified session.

      • executeQuery

        @Transactional(readOnly=true)
QueryTableModel executeQuery​(java.lang.String sessionToken,
                             long queryID,
                             java.util.Map<java.lang.String,​java.lang.String> parameterBindings)
        Executes specified query using specified parameter bindings.

      • listTableReportDescriptions

        @Transactional(readOnly=true)
java.util.List<ReportDescription> listTableReportDescriptions​(java.lang.String sessionToken)
        Returns meta data for all reporting plugins which deliver a table.
        Since:
        1.2

      • createReportFromDataSets

        @Transactional(readOnly=true)
QueryTableModel createReportFromDataSets​(java.lang.String sessionToken,
                                         java.lang.String dataStoreCode,
                                         java.lang.String serviceKey,
                                         java.util.List<java.lang.String> dataSetCodes)
        Creates for the specified data sets a report. Available reports can be obtained by listTableReportDescriptions(String).
        Parameters:
        dataStoreCode - Code of the data store.
        serviceKey - Key of the data store service.
        Since:
        1.2

      • createReportFromDataSets

        @Transactional(readOnly=true)
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. It groups the data sets by a data store and creates a report for each group of objects on appropriate data store server. Results from the data stores are combined and returned as a result of this method. Available report keys can be obtained by listTableReportDescriptions(String).
        Parameters:
        serviceKey - Key of the data store service.
        Since:
        1.6

      • listAggregationServices

        @Transactional(readOnly=true)
java.util.List<AggregationServiceDescription> listAggregationServices​(java.lang.String sessionToken)
        Returns metadata for all aggregation and ingestion services.
        Since:
        1.3

      • createReportFromAggregationService

        @Transactional(readOnly=true)
QueryTableModel createReportFromAggregationService​(java.lang.String sessionToken,
                                                   java.lang.String dataStoreCode,
                                                   java.lang.String serviceKey,
                                                   java.util.Map<java.lang.String,​java.lang.Object> parameters)
        Executes the specified aggregation or ingestion service for the specified parameters and creates a report. Available service descriptions can be obtained by listAggregationServices(String). The service resolved to by the serviceKey must be a service of type REPORT.
        Parameters:
        sessionToken - A valid session token.
        dataStoreCode - Code of the data store.
        serviceKey - Key of the service.
        parameters - Parameters to the service.
        Since:
        1.3