Class QueryApiServer

  • All Implemented Interfaces:
    IRpcService, ch.systemsx.cisd.openbis.common.spring.IInvocationLoggerFactory<IQueryApiServer>, ch.systemsx.cisd.openbis.generic.shared.IServer, ch.systemsx.cisd.openbis.generic.shared.ISessionProvider, IQueryApiServer

    @Component("query-api-server-v1")
    public class QueryApiServer
    extends ch.systemsx.cisd.openbis.generic.server.AbstractServer<IQueryApiServer>
    implements IQueryApiServer
    • Nested Class Summary

      • Nested classes/interfaces inherited from class ch.systemsx.cisd.openbis.generic.server.AbstractServer

        ch.systemsx.cisd.openbis.generic.server.AbstractServer.AuthenticatedPersonBasedPrincipalProvider
    • Field Summary

      • Fields inherited from class ch.systemsx.cisd.openbis.generic.server.AbstractServer

        CISDHelpdeskEmail, configurer, displaySettingsProvider, executor, mailClientParameters, sessionManager
      • Fields inherited from class ch.systemsx.cisd.openbis.common.spring.AbstractServiceWithLogger

        authenticationLog, notificationLog, operationLog
      • Fields inherited from interface ch.systemsx.cisd.openbis.generic.shared.IServer

        VERSION
    • Constructor Summary

      Constructors 
      Constructor Description
      QueryApiServer()  
      QueryApiServer​(ch.systemsx.cisd.openbis.plugin.query.shared.IQueryServer queryServer, ch.systemsx.cisd.openbis.generic.shared.ICommonServer commonServer, ch.systemsx.cisd.openbis.generic.shared.IOpenBisSessionManager sessionManager, ch.systemsx.cisd.openbis.generic.server.dataaccess.IDAOFactory daoFactory, ch.systemsx.cisd.openbis.generic.server.business.IPropertiesBatchManager propertiesBatchManager)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      IQueryApiServer createLogger​(ch.systemsx.cisd.openbis.common.spring.IInvocationLoggerContext context)  
      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.
      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.
      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.
      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.
      int getMajorVersion()
      Returns the major version of the server side interface.
      int getMinorVersion()
      Returns the minor version of this server side interface.
      java.util.List<AggregationServiceDescription> listAggregationServices​(java.lang.String sessionToken)
      Returns metadata for all aggregation and ingestion services.
      java.util.List<QueryDescription> listQueries​(java.lang.String sessionToken)
      Lists all queries available for the user of the specified session.
      java.util.List<ReportDescription> listTableReportDescriptions​(java.lang.String sessionToken)
      Returns meta data for all reporting plugins which deliver a table.
      java.lang.String tryToAuthenticateAtQueryServer​(java.lang.String userID, java.lang.String userPassword)
      Tries to authenticate specified user with specified password.
      • Methods inherited from class ch.systemsx.cisd.openbis.generic.server.AbstractServer

        changeUserHomeSpace, checkSession, countActivePersons, createPerson, deactivatePersons, executeASync, expireSession, fillHomeSpace, getAuthSession, getBaseIndexURL, getDAOFactory, getDataSetTypeSlaveServerPlugin, getDefaultDisplaySettings, getPropertiesBatchManager, getSampleTypeSlaveServerPlugin, getServerInformation, getSession, getSessionManager, getSystemUser, getVersion, injectPerson, isArchivingConfigured, isProjectLevelAuthorizationEnabled, isProjectLevelAuthorizationUser, isProjectSamplesEnabled, listGridCustomColumns, logout, registerAtSessionManager, registerSamples, saveDisplaySettings, sendEmail, setBaseIndexURL, setCISDHelpdeskEmail, setDataSetTypeSlaveServerPlugin, setDisplaySettingsProvider, setDssFactory, setSampleTypeSlaveServerPlugin, setSessionUser, setSessionWorkspaceProvider, tryAuthenticate, tryAuthenticateAnonymously, tryAuthenticateAs, tryGetDisabledText, tryGetSession, tryToAuthenticate, tryToAuthenticateAsSystem, updateDisplaySettings
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface ch.systemsx.cisd.openbis.plugin.query.shared.api.v1.IQueryApiServer

        logout
    • Constructor Detail

      • QueryApiServer

        public QueryApiServer()
      • QueryApiServer

        public QueryApiServer​(ch.systemsx.cisd.openbis.plugin.query.shared.IQueryServer queryServer,
                              ch.systemsx.cisd.openbis.generic.shared.ICommonServer commonServer,
                              ch.systemsx.cisd.openbis.generic.shared.IOpenBisSessionManager sessionManager,
                              ch.systemsx.cisd.openbis.generic.server.dataaccess.IDAOFactory daoFactory,
                              ch.systemsx.cisd.openbis.generic.server.business.IPropertiesBatchManager propertiesBatchManager)
    • Method Detail

      • createLogger

        public IQueryApiServer createLogger​(ch.systemsx.cisd.openbis.common.spring.IInvocationLoggerContext context)
        Specified by:
        createLogger in interface ch.systemsx.cisd.openbis.common.spring.IInvocationLoggerFactory<IQueryApiServer>
      • tryToAuthenticateAtQueryServer

        public java.lang.String tryToAuthenticateAtQueryServer​(java.lang.String userID,
                                                               java.lang.String userPassword)
        Description copied from interface: IQueryApiServer
        Tries to authenticate specified user with specified password. Returns session token if succeeded otherwise null is returned.
        Specified by:
        tryToAuthenticateAtQueryServer in interface IQueryApiServer
      • executeQuery

        public QueryTableModel executeQuery​(java.lang.String sessionToken,
                                            long queryID,
                                            java.util.Map<java.lang.String,​java.lang.String> parameterBindings)
        Description copied from interface: IQueryApiServer
        Executes specified query using specified parameter bindings.
        Specified by:
        executeQuery in interface IQueryApiServer
      • createReportFromDataSets

        public QueryTableModel createReportFromDataSets​(java.lang.String sessionToken,
                                                        java.lang.String serviceKey,
                                                        java.util.List<java.lang.String> dataSetCodes)
        Description copied from interface: IQueryApiServer
        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 IQueryApiServer.listTableReportDescriptions(String).
        Specified by:
        createReportFromDataSets in interface IQueryApiServer
        serviceKey - Key of the data store service.
      • createReportFromAggregationService

        public QueryTableModel createReportFromAggregationService​(java.lang.String sessionToken,
                                                                  java.lang.String dataStoreCode,
                                                                  java.lang.String serviceKey,
                                                                  java.util.Map<java.lang.String,​java.lang.Object> parameters)
        Description copied from interface: IQueryApiServer
        Executes the specified aggregation or ingestion service for the specified parameters and creates a report. Available service descriptions can be obtained by IQueryApiServer.listAggregationServices(String). The service resolved to by the serviceKey must be a service of type REPORT.
        Specified by:
        createReportFromAggregationService in interface IQueryApiServer
        Parameters:
        sessionToken - A valid session token.
        dataStoreCode - Code of the data store.
        serviceKey - Key of the service.
        parameters - Parameters to the service.
      • getMajorVersion

        public int getMajorVersion()
        Description copied from interface: IRpcService
        Returns the major version of the server side interface. Different major versions are incompatible with one another.
        Specified by:
        getMajorVersion in interface IRpcService
      • getMinorVersion

        public int getMinorVersion()
        Description copied from interface: IRpcService
        Returns the minor version of this server side interface. Different minor versions, within the same major version, are compatible with one another.
        Specified by:
        getMinorVersion in interface IRpcService