Uses of Class
com.kingsrook.qqq.backend.core.model.session.QSession
Packages that use QSession
Package
Description
This package contains (hopefully generally) api-version-agnostic classes
that implement the actual QQQ Middleware.
-
Uses of QSession in com.kingsrook.qqq.backend.core.actions.ai
Methods in com.kingsrook.qqq.backend.core.actions.ai with parameters of type QSessionModifier and TypeMethodDescriptionAiToolKernel.buildUserDigest(QSession session) A digest of the user for a (per-user) prompt section: name, timezone, the tables the user can read through the assistant (with their insert / edit / delete permissions) - and descriptions of the permission-restricted tables, apps, processes and widgets this user may use (which the shared app digest leaves out).AiToolKernel.describeAccess(QSession session, String tableName, Serializable primaryKey) What the assistant may do with a table (and optionally one record) for a user - for the record Developer screen.AiToolKernel.execute(QSession session, AiToolCall call) Run one tool call as the given (user's) session. -
Uses of QSession in com.kingsrook.qqq.backend.core.actions.automation.polling
Constructor parameters in com.kingsrook.qqq.backend.core.actions.automation.polling with type arguments of type QSessionModifierConstructorDescriptionPollingAutomationPerTableRunner(QInstance instance, String providerName, Supplier<QSession> sessionSupplier, PollingAutomationPerTableRunner.TableActionsInterface tableActions) -
Uses of QSession in com.kingsrook.qqq.backend.core.actions.collaboration
Methods in com.kingsrook.qqq.backend.core.actions.collaboration that return types with arguments of type QSessionModifier and TypeMethodDescriptionUserSessionProviderInterface.sessionForUser(String userId) Build a session for another user without changing the current session. -
Uses of QSession in com.kingsrook.qqq.backend.core.actions.permissions
Methods in com.kingsrook.qqq.backend.core.actions.permissions with parameters of type QSessionModifier and TypeMethodDescriptionstatic booleanPermissionsHelper.hasTableFeaturePermission(QInstance instance, QSession session, QTableMetaData table, String suffix) Whether the given session may use a table feature permission (registered in TableFeaturePermissionsMetaData) on the given table. -
Uses of QSession in com.kingsrook.qqq.backend.core.actions.queues
Method parameters in com.kingsrook.qqq.backend.core.actions.queues with type arguments of type QSessionModifier and TypeMethodDescriptionvoidSQSQueuePoller.setSessionSupplier(Supplier<QSession> sessionSupplier) Setter for sessionSupplier -
Uses of QSession in com.kingsrook.qqq.backend.core.actions.tables.helpers
Methods in com.kingsrook.qqq.backend.core.actions.tables.helpers with parameters of type QSessionModifier and TypeMethodDescriptionstatic booleanValidateRecordSecurityLockHelper.allowedToReadRecord(QTableMetaData table, QRecord record, QSession qSession, QBackendTransaction transaction) return boolean if given session can read given recordstatic List<QErrorMessage> ValidateRecordSecurityLockHelper.validateRecordSecurityValue(QTableMetaData table, RecordSecurityLock recordSecurityLock, Serializable recordSecurityValue, QFieldType fieldType, ValidateRecordSecurityLockHelper.Action action, Map<Serializable, QRecord> madeUpPrimaryKeys, QSession qSession) Method parameters in com.kingsrook.qqq.backend.core.actions.tables.helpers with type arguments of type QSession -
Uses of QSession in com.kingsrook.qqq.backend.core.actions.tables.query
Methods in com.kingsrook.qqq.backend.core.actions.tables.query that return QSessionModifier and TypeMethodDescriptionCriteriaExpansionContext.session()Returns the value of thesessionrecord component.Constructors in com.kingsrook.qqq.backend.core.actions.tables.query with parameters of type QSessionModifierConstructorDescriptionCriteriaExpansionContext(QInstance instance, QSession session, QBackendTransaction transaction) Creates an instance of aCriteriaExpansionContextrecord class. -
Uses of QSession in com.kingsrook.qqq.backend.core.actions.values
Constructors in com.kingsrook.qqq.backend.core.actions.values with parameters of type QSession -
Uses of QSession in com.kingsrook.qqq.backend.core.context
Methods in com.kingsrook.qqq.backend.core.context that return QSessionModifier and TypeMethodDescriptionstatic QSessionQContext.getQSession()CapturedContext.qSession()Returns the value of theqSessionrecord component.Methods in com.kingsrook.qqq.backend.core.context with parameters of type QSessionModifier and TypeMethodDescriptionstatic voidMost common method to set or init the context - e.g., set the current thread with a QInstance and QSession.static voidQContext.init(QInstance qInstance, QSession qSession, QBackendTransaction transaction, AbstractActionInput actionInput) Full flavor init method - also take a transaction and action input (to seed the stack).static voidQContext.setQSession(QSession qSession) Constructors in com.kingsrook.qqq.backend.core.context with parameters of type QSessionModifierConstructorDescriptionCapturedContext(QInstance qInstance, QSession qSession) Simpler constructorCapturedContext(QInstance qInstance, QSession qSession, QBackendTransaction qBackendTransaction, Stack<AbstractActionInput> actionStack) Constructor without an authorized-action-scope depth (e.g., for code that builds a context by hand) - such a context is never inside an authorized action scope.CapturedContext(QInstance qInstance, QSession qSession, QBackendTransaction qBackendTransaction, Stack<AbstractActionInput> actionStack, int authorizedActionScopeDepth) Creates an instance of aCapturedContextrecord class. -
Uses of QSession in com.kingsrook.qqq.backend.core.jobs
Methods in com.kingsrook.qqq.backend.core.jobs that return QSessionMethods in com.kingsrook.qqq.backend.core.jobs with parameters of type QSessionModifier and TypeMethodDescriptionstatic voidDurableJobsSecurity.applyToSession(QSession session) Replace any jobs keys on the session with ones derived from its user and permissions.static Map<String, List<Serializable>> JobSessions.captureScope(QSession session) What a launch captures from the session: its security key values (minus the jobs keys, which are derived) as a JSON-able map.static voidDurableJobsSecurity.ensureSessionKeys(QSession session) Apply the keys only when the session has none yet.static StringThe id the jobs tables record as a job's owner. -
Uses of QSession in com.kingsrook.qqq.backend.core.model.actions.audits
Methods in com.kingsrook.qqq.backend.core.model.actions.audits that return QSessionModifier and TypeMethodDescriptionDMLAuditHandlerInput.getSession()Getter for sessionProcessedAuditHandlerInput.getSession()Getter for sessionMethods in com.kingsrook.qqq.backend.core.model.actions.audits with parameters of type QSessionModifier and TypeMethodDescriptionvoidDMLAuditHandlerInput.setSession(QSession session) Setter for sessionvoidProcessedAuditHandlerInput.setSession(QSession session) Setter for sessionDMLAuditHandlerInput.withSession(QSession session) Fluent setter for sessionProcessedAuditHandlerInput.withSession(QSession session) Fluent setter for session -
Uses of QSession in com.kingsrook.qqq.backend.core.model.metadata.preferences
Methods in com.kingsrook.qqq.backend.core.model.metadata.preferences that return QSessionModifier and TypeMethodDescriptionUserPreferenceRequestContext.getSession()Get the original session, including its client channel.Constructors in com.kingsrook.qqq.backend.core.model.metadata.preferences with parameters of type QSessionModifierConstructorDescriptionUserPreferenceRequestContext(UserPreferenceSectionMetaData section, QSession session) Bind the provider to the authenticated session; identity is never request data. -
Uses of QSession in com.kingsrook.qqq.backend.core.model.metadata.scheduleing
Method parameters in com.kingsrook.qqq.backend.core.model.metadata.scheduleing with type arguments of type QSessionModifier and TypeMethodDescriptionabstract QSchedulerInterfaceQSchedulerMetaData.initSchedulerInstance(QInstance qInstance, Supplier<QSession> systemSessionSupplier) -
Uses of QSession in com.kingsrook.qqq.backend.core.model.metadata.scheduleing.quartz
Method parameters in com.kingsrook.qqq.backend.core.model.metadata.scheduleing.quartz with type arguments of type QSessionModifier and TypeMethodDescriptionQuartzSchedulerMetaData.initSchedulerInstance(QInstance qInstance, Supplier<QSession> systemSessionSupplier) -
Uses of QSession in com.kingsrook.qqq.backend.core.model.metadata.scheduleing.simple
Method parameters in com.kingsrook.qqq.backend.core.model.metadata.scheduleing.simple with type arguments of type QSessionModifier and TypeMethodDescriptionSimpleSchedulerMetaData.initSchedulerInstance(QInstance qInstance, Supplier<QSession> systemSessionSupplier) -
Uses of QSession in com.kingsrook.qqq.backend.core.model.session
Subclasses of QSession in com.kingsrook.qqq.backend.core.model.sessionModifier and TypeClassDescriptionclassSpecial session, indicating that an action being executed is being done not on behalf of a (human or otherwise) user - but instead, is the application/ system itself.Methods in com.kingsrook.qqq.backend.core.model.session that return QSessionModifier and TypeMethodDescriptionQSession.clone()QSession.withBackendVariants(Map<String, Serializable> backendVariants) Fluent setter for backendVariantsQSession.withClientChannel(String clientChannel) Fluent setter for clientChannelQSession.withCredentialScope(QCredentialScope credentialScope) Fluent setter for credentialScope - set by the authentication module's customizer for scoped credentials; it can only narrow access.QSession.withPermission(String permission) QSession.withPermissions(String... permissionNames) QSession.withPermissions(Collection<String> permissionNames) QSession.withSecurityKeyValue(String keyName, Serializable value) Fluent setter for securityKeyValues - add 1 value for 1 key.QSession.withSecurityKeyValues(Map<String, List<Serializable>> securityKeyValues) Fluent setter for securityKeyValues - replaces the map.Fluent setter for userQSession.withValueForFrontend(String key, Serializable value) Fluent setter for a single valuesForFrontendQSession.withValuesForFrontend(Map<String, Serializable> valuesForFrontend) Fluent setter for valuesForFrontend -
Uses of QSession in com.kingsrook.qqq.backend.core.modules.authentication
Methods in com.kingsrook.qqq.backend.core.modules.authentication that return QSessionModifier and TypeMethodDescriptiondefault QSessionQAuthenticationModuleInterface.createAutomatedSessionForUser(QInstance qInstance, Serializable userId) default QSessionQAuthenticationModuleInterface.createSession(QInstance qInstance, QAuthenticationMetaData authenticationMetaData, Map<String, String> context) Create a session for the given (possibly scoped) authentication provider.QAuthenticationModuleInterface.createSession(QInstance qInstance, Map<String, String> context) Methods in com.kingsrook.qqq.backend.core.modules.authentication that return types with arguments of type QSessionModifier and TypeMethodDescriptionLoad a session by UUID.QSessionStoreProviderInterface.loadAndTouch(String sessionUuid) Load a session and touch it to reset its TTL in a single operation.QSessionStoreHelper.loadAndTouchSession(String sessionUuid) Load a session and touch it to reset its TTL in a single operation.QSessionStoreHelper.loadSession(String sessionUuid) Load a session from the session store (if available).Methods in com.kingsrook.qqq.backend.core.modules.authentication with parameters of type QSessionModifier and TypeMethodDescriptiondefault voidQAuthenticationModuleCustomizerInterface.addSecurityKeyValueToSession(QSession session, String keyName, Serializable value) default voidQAuthenticationModuleCustomizerInterface.customizeAutomatedSessionForUser(QInstance qInstance, QSession automatedSessionForUser, Serializable userId) default voidQAuthenticationModuleCustomizerInterface.customizeSession(QInstance qInstance, QSession qSession, Map<String, Object> context) default voidQAuthenticationModuleCustomizerInterface.finalCustomizeSession(QInstance qInstance, QSession qSession) booleanQAuthenticationModuleInterface.isSessionValid(QInstance instance, QSession session) voidStore a session with the given TTL.static voidQSessionStoreHelper.storeSession(String sessionUuid, QSession session, Duration ttl) Store a session in the session store (if available). -
Uses of QSession in com.kingsrook.qqq.backend.core.modules.authentication.implementations
Methods in com.kingsrook.qqq.backend.core.modules.authentication.implementations that return QSessionModifier and TypeMethodDescriptionAuth0AuthenticationModule.createAutomatedSessionForUser(QInstance qInstance, Serializable userId) e.g., if a scheduled job needs to run as a user (say, a report)...MockAuthenticationModule.createAutomatedSessionForUser(QInstance qInstance, Serializable userId) Establish automation grants through the owner's configured session customizer.OAuth2AuthenticationModule.createAutomatedSessionForUser(QInstance qInstance, Serializable userId) Auth0AuthenticationModule.createSession(QInstance qInstance, Map<String, String> context) FullyAnonymousAuthenticationModule.createSession(QInstance qInstance, Map<String, String> context) Create or restore a session.MockAuthenticationModule.createSession(QInstance qInstance, Map<String, String> context) OAuth2AuthenticationModule.createSession(QInstance qInstance, Map<String, String> context) TableBasedAuthenticationModule.createSession(QInstance qInstance, Map<String, String> context) Methods in com.kingsrook.qqq.backend.core.modules.authentication.implementations with parameters of type QSessionModifier and TypeMethodDescriptionbooleanAuth0AuthenticationModule.isSessionValid(QInstance instance, QSession session) booleanFullyAnonymousAuthenticationModule.isSessionValid(QInstance instance, QSession session) booleanMockAuthenticationModule.isSessionValid(QInstance instance, QSession session) booleanOAuth2AuthenticationModule.isSessionValid(QInstance instance, QSession session) booleanTableBasedAuthenticationModule.isSessionValid(QInstance instance, QSession session) static voidFullyAnonymousAuthenticationModule.persistSession(QSession session) Persist session data to StateProvider. -
Uses of QSession in com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend
Fields in com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend declared as QSession -
Uses of QSession in com.kingsrook.qqq.backend.core.scheduler
Method parameters in com.kingsrook.qqq.backend.core.scheduler with type arguments of type QSessionModifier and TypeMethodDescriptionstatic QScheduleManagerQScheduleManager.initInstance(QInstance qInstance, Supplier<QSession> systemUserSessionSupplier) Singleton initiator - e.g., must be called to initially initialize the singleton before anyone else calls getInstance (they'll get an error if they call that first).static voidSchedulerUtils.runProcess(QInstance qInstance, Supplier<QSession> sessionSupplier, QProcessMetaData process, Map<String, Serializable> backendVariantData, Map<String, Serializable> processInputValues) -
Uses of QSession in com.kingsrook.qqq.backend.core.scheduler.quartz
Methods in com.kingsrook.qqq.backend.core.scheduler.quartz that return types with arguments of type QSessionModifier and TypeMethodDescriptionQuartzScheduler.getSessionSupplier()Getter for sessionSupplierMethod parameters in com.kingsrook.qqq.backend.core.scheduler.quartz with type arguments of type QSessionModifier and TypeMethodDescriptionstatic QuartzSchedulerQuartzScheduler.initInstance(QInstance qInstance, String schedulerName, Properties quartzProperties, Supplier<QSession> sessionSupplier) Singleton initiator - e.g., must be called to initially initialize the singleton before anyone else calls getInstance (they'll get an error if they call that first). -
Uses of QSession in com.kingsrook.qqq.backend.core.scheduler.simple
Fields in com.kingsrook.qqq.backend.core.scheduler.simple with type parameters of type QSessionModifier and TypeFieldDescriptionSimpleScheduler.sessionSupplierStandardScheduledExecutor.sessionSupplierMethods in com.kingsrook.qqq.backend.core.scheduler.simple that return types with arguments of type QSessionModifier and TypeMethodDescriptionSimpleScheduler.getSessionSupplier()Getter for sessionSupplierMethod parameters in com.kingsrook.qqq.backend.core.scheduler.simple with type arguments of type QSessionModifier and TypeMethodDescriptionvoidSimpleScheduler.setSessionSupplier(Supplier<QSession> sessionSupplier) Setter for sessionSuppliervoidStandardScheduledExecutor.setSessionSupplier(Supplier<QSession> sessionSupplier) Setter for sessionSupplier -
Uses of QSession in com.kingsrook.qqq.backend.module.api.actions
Fields in com.kingsrook.qqq.backend.module.api.actions declared as QSession -
Uses of QSession in com.kingsrook.qqq.middleware.javalin
Methods in com.kingsrook.qqq.middleware.javalin that return QSessionModifier and TypeMethodDescriptionstatic QSessionQJavalinImplementation.setupSession(io.javalin.http.Context context, AbstractActionInput input) static QSessionQJavalinImplementation.setupSession(io.javalin.http.Context context, AbstractActionInput input, QAuthenticationMetaData authMetaData) Setup session using the specified authentication metadata.Methods in com.kingsrook.qqq.middleware.javalin that return types with arguments of type QSessionModifier and TypeMethodDescriptionQApplicationLauncherConfig.getSystemUserSessionSupplier()Getter for systemUserSessionSupplierMethod parameters in com.kingsrook.qqq.middleware.javalin with type arguments of type QSessionModifier and TypeMethodDescriptionvoidQApplicationLauncherConfig.setSystemUserSessionSupplier(Supplier<QSession> systemUserSessionSupplier) Setter for systemUserSessionSupplierQApplicationLauncherConfig.withSystemUserSessionSupplier(Supplier<QSession> systemUserSessionSupplier) Fluent setter for systemUserSessionSupplier - the session scheduled jobs run as. -
Uses of QSession in com.kingsrook.qqq.middleware.javalin.executors
Methods in com.kingsrook.qqq.middleware.javalin.executors that return QSessionModifier and TypeMethodDescriptionstatic QSessionExecutorSessionUtils.resolveInProcessSession(String remoteAddr, String token) Accept a JVM-local token only from the socket's loopback peer.static QSessionExecutorSessionUtils.setupSession(io.javalin.http.Context context, QInstance qInstance) -
Uses of QSession in com.kingsrook.qqq.middleware.javalin.realtime
Methods in com.kingsrook.qqq.middleware.javalin.realtime with parameters of type QSession -
Uses of QSession in com.kingsrook.qqq.middleware.javalin.specs.invoke
Methods in com.kingsrook.qqq.middleware.javalin.specs.invoke that return types with arguments of type QSessionModifier and TypeMethodDescriptionResolve an unexpired token to a fresh request-local session copy.Methods in com.kingsrook.qqq.middleware.javalin.specs.invoke with parameters of type QSession