Index
All Classes and Interfaces|All Packages
A
- add(Runner) - Method in interface com.github.sttk.sabi.AsyncGroup
-
Adds a
Runner
to this group for asynchronous execution. - AsyncGroup - Interface in com.github.sttk.sabi
-
An interface for asynchronously executing multiple
Runner
instances and waiting for their completion. - AsyncGroup.RunnerFailed - Record Class in com.github.sttk.sabi
-
Represents the reason for a new
Exc
exception object when an exception occurred during the execution of aRunner
and the exception class was not theExc
. - AsyncGroup.RunnerInterrupted - Record Class in com.github.sttk.sabi
-
Represents the reason for an
Exc
exception object when the creation of a thread for asynchronous execution of aRunner
fails.
C
- castFromType() - Method in record class com.github.sttk.sabi.Sabi.FailToCastDataHub
-
Returns the value of the
castFromType
record component. - castToType() - Method in record class com.github.sttk.sabi.DataHub.FailToCastDataConn
-
Returns the value of the
castToType
record component. - close() - Method in interface com.github.sttk.sabi.DataConn
-
Closes the connection to the external data service, releasing any associated resources.
- close() - Method in class com.github.sttk.sabi.DataHub
-
Closes all
DataConn
instances managed by thisDataHub
, releasing their resources. - close() - Method in interface com.github.sttk.sabi.DataSrc
-
Closes the data source, releasing all resources and shutting down connections managed by this source.
- com.github.sttk.sabi - module com.github.sttk.sabi
-
Defines the APIs of Sabi framework.
- com.github.sttk.sabi - package com.github.sttk.sabi
-
Provides classes and interfaces of sabi framework.
- commit(AsyncGroup) - Method in interface com.github.sttk.sabi.DataConn
-
Commits the changes made within the current session to the external data service.
- createDataConn() - Method in interface com.github.sttk.sabi.DataSrc
-
Creates and returns a new
DataConn
instance, representing a single session connection to the external data service. - CreatedDataConnIsNull(String, String) - Constructor for record class com.github.sttk.sabi.DataHub.CreatedDataConnIsNull
-
Creates an instance of a
CreatedDataConnIsNull
record class.
D
- DataAcc - Interface in com.github.sttk.sabi
-
An interface designed for implementing data access operations through default methods in its sub-interfaces.
- DataConn - Interface in com.github.sttk.sabi
-
The interface that abstracts a connection per session to an external data service, such as a database, file system, or messaging service.
- dataConnType() - Method in record class com.github.sttk.sabi.DataHub.CreatedDataConnIsNull
-
Returns the value of the
dataConnType
record component. - dataConnType() - Method in record class com.github.sttk.sabi.DataHub.FailToCreateDataConn
-
Returns the value of the
dataConnType
record component. - dataConnType() - Method in record class com.github.sttk.sabi.DataHub.NoDataSrcToCreateDataConn
-
Returns the value of the
dataConnType
record component. - DataHub - Class in com.github.sttk.sabi
- DataHub() - Constructor for class com.github.sttk.sabi.DataHub
-
Constructs a new
DataHub
instance. - DataHub.CreatedDataConnIsNull - Record Class in com.github.sttk.sabi
-
Represents an error reason where the created
DataConn
instance was null. - DataHub.FailToCastDataConn - Record Class in com.github.sttk.sabi
-
Represents an error reason that occurred when failing to cast a
DataConn
to the requested type. - DataHub.FailToCommitDataConn - Record Class in com.github.sttk.sabi
-
Represents an error reason that occurred when failing to commit one or more
DataConn
instances. - DataHub.FailToCreateDataConn - Record Class in com.github.sttk.sabi
-
Represents an error reason that occurred when failing to create a
DataConn
instance. - DataHub.FailToPreCommitDataConn - Record Class in com.github.sttk.sabi
-
Represents an error reason that occurred when failing to pre-commit one or more
DataConn
instances. - DataHub.FailToSetupGlobalDataSrcs - Record Class in com.github.sttk.sabi
-
Represents an error reason that occurred when failing to set up global
DataSrc
instances. - DataHub.FailToSetupLocalDataSrcs - Record Class in com.github.sttk.sabi
-
Represents an error reason that occurred when failing to set up local
DataSrc
instances. - DataHub.NoDataSrcToCreateDataConn - Record Class in com.github.sttk.sabi
- DataHub.RuntimeExceptionOccurred - Record Class in com.github.sttk.sabi
-
Represents an unexpected
RuntimeException
that occurred during pre-commit or commit operations. - DataSrc - Interface in com.github.sttk.sabi
-
The interface that abstracts a data source responsible for managing connections to external data services, such as databases, file systems, or messaging services.
- disuses(String) - Method in class com.github.sttk.sabi.DataHub
-
Unregisters a local
DataSrc
with the given name from thisDataHub
instance.
E
- equals(Object) - Method in record class com.github.sttk.sabi.AsyncGroup.RunnerFailed
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sttk.sabi.AsyncGroup.RunnerInterrupted
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sttk.sabi.DataHub.CreatedDataConnIsNull
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sttk.sabi.DataHub.FailToCastDataConn
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sttk.sabi.DataHub.FailToCommitDataConn
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sttk.sabi.DataHub.FailToCreateDataConn
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sttk.sabi.DataHub.FailToPreCommitDataConn
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sttk.sabi.DataHub.FailToSetupGlobalDataSrcs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sttk.sabi.DataHub.FailToSetupLocalDataSrcs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sttk.sabi.DataHub.NoDataSrcToCreateDataConn
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sttk.sabi.DataHub.RuntimeExceptionOccurred
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.sttk.sabi.Sabi.FailToCastDataHub
-
Indicates whether some other object is "equal to" this one.
- errors() - Method in record class com.github.sttk.sabi.DataHub.FailToCommitDataConn
-
Returns the value of the
errors
record component. - errors() - Method in record class com.github.sttk.sabi.DataHub.FailToPreCommitDataConn
-
Returns the value of the
errors
record component. - errors() - Method in record class com.github.sttk.sabi.DataHub.FailToSetupGlobalDataSrcs
-
Returns the value of the
errors
record component. - errors() - Method in record class com.github.sttk.sabi.DataHub.FailToSetupLocalDataSrcs
-
Returns the value of the
errors
record component.
F
- FailToCastDataConn(String, String) - Constructor for record class com.github.sttk.sabi.DataHub.FailToCastDataConn
-
Creates an instance of a
FailToCastDataConn
record class. - FailToCastDataHub(String) - Constructor for record class com.github.sttk.sabi.Sabi.FailToCastDataHub
-
Creates an instance of a
FailToCastDataHub
record class. - FailToCommitDataConn(Map<String, Exc>) - Constructor for record class com.github.sttk.sabi.DataHub.FailToCommitDataConn
-
Creates an instance of a
FailToCommitDataConn
record class. - FailToCreateDataConn(String, String) - Constructor for record class com.github.sttk.sabi.DataHub.FailToCreateDataConn
-
Creates an instance of a
FailToCreateDataConn
record class. - FailToPreCommitDataConn(Map<String, Exc>) - Constructor for record class com.github.sttk.sabi.DataHub.FailToPreCommitDataConn
-
Creates an instance of a
FailToPreCommitDataConn
record class. - FailToSetupGlobalDataSrcs(Map<String, Exc>) - Constructor for record class com.github.sttk.sabi.DataHub.FailToSetupGlobalDataSrcs
-
Creates an instance of a
FailToSetupGlobalDataSrcs
record class. - FailToSetupLocalDataSrcs(Map<String, Exc>) - Constructor for record class com.github.sttk.sabi.DataHub.FailToSetupLocalDataSrcs
-
Creates an instance of a
FailToSetupLocalDataSrcs
record class. - forceBack(AsyncGroup) - Method in interface com.github.sttk.sabi.DataConn
-
Performs a force-back operation to revert the committed changes when this connection had been already committed but the other connection had failed.
G
- getDataConn(String, Class<C>) - Method in interface com.github.sttk.sabi.DataAcc
-
Retrieves a connection to a data store.
- getDataConn(String, Class<C>) - Method in class com.github.sttk.sabi.DataHub
-
Retrieves a
DataConn
instance from the managed data sources.
H
- hashCode() - Method in record class com.github.sttk.sabi.AsyncGroup.RunnerFailed
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sttk.sabi.AsyncGroup.RunnerInterrupted
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sttk.sabi.DataHub.CreatedDataConnIsNull
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sttk.sabi.DataHub.FailToCastDataConn
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sttk.sabi.DataHub.FailToCommitDataConn
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sttk.sabi.DataHub.FailToCreateDataConn
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sttk.sabi.DataHub.FailToPreCommitDataConn
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sttk.sabi.DataHub.FailToSetupGlobalDataSrcs
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sttk.sabi.DataHub.FailToSetupLocalDataSrcs
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sttk.sabi.DataHub.NoDataSrcToCreateDataConn
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sttk.sabi.DataHub.RuntimeExceptionOccurred
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.sttk.sabi.Sabi.FailToCastDataHub
-
Returns a hash code value for this object.
L
- Logic<D> - Interface in com.github.sttk.sabi
-
Represents the application's business logic, designed to separate data access concerns from the core logic.
N
- name() - Method in record class com.github.sttk.sabi.DataHub.CreatedDataConnIsNull
-
Returns the value of the
name
record component. - name() - Method in record class com.github.sttk.sabi.DataHub.FailToCastDataConn
-
Returns the value of the
name
record component. - name() - Method in record class com.github.sttk.sabi.DataHub.FailToCreateDataConn
-
Returns the value of the
name
record component. - name() - Method in record class com.github.sttk.sabi.DataHub.NoDataSrcToCreateDataConn
-
Returns the value of the
name
record component. - NoDataSrcToCreateDataConn(String, String) - Constructor for record class com.github.sttk.sabi.DataHub.NoDataSrcToCreateDataConn
-
Creates an instance of a
NoDataSrcToCreateDataConn
record class.
P
- postCommit(AsyncGroup) - Method in interface com.github.sttk.sabi.DataConn
-
Performs any necessary post-commit operations.
- preCommit(AsyncGroup) - Method in interface com.github.sttk.sabi.DataConn
-
Performs any necessary pre-commit operations.
R
- rollback(AsyncGroup) - Method in interface com.github.sttk.sabi.DataConn
-
Rolls back the changes made within the current session, discarding all operations performed since the last commit or rollback.
- run() - Method in interface com.github.sttk.sabi.Runner
-
Runs the procedure that this instance represents.
- run(Logic<D>, DataHub) - Static method in class com.github.sttk.sabi.Sabi
-
Executes the provided application
Logic
without transactional boundaries. - run(D) - Method in interface com.github.sttk.sabi.Logic
-
Executes the application's business logic.
- Runner - Interface in com.github.sttk.sabi
-
Runner
is the interface that runs any procedure. - RunnerFailed() - Constructor for record class com.github.sttk.sabi.AsyncGroup.RunnerFailed
-
Creates an instance of a
RunnerFailed
record class. - RunnerInterrupted() - Constructor for record class com.github.sttk.sabi.AsyncGroup.RunnerInterrupted
-
Creates an instance of a
RunnerInterrupted
record class. - RuntimeExceptionOccurred() - Constructor for record class com.github.sttk.sabi.DataHub.RuntimeExceptionOccurred
-
Creates an instance of a
RuntimeExceptionOccurred
record class.
S
- Sabi - Class in com.github.sttk.sabi
-
Sabi
is the class that provides the static methods related to the global functionalities of sabi framework. - Sabi.FailToCastDataHub - Record Class in com.github.sttk.sabi
-
Represents an error reason that occurred when failing to cast the
DataHub
instance itself to the expected data access interface type for aLogic
. - setup() - Static method in class com.github.sttk.sabi.Sabi
-
Sets up all globally registered
DataSrc
objects. - setup(AsyncGroup) - Method in interface com.github.sttk.sabi.DataSrc
-
Sets up the data source, performing any necessary initialization or configuration to establish connectivity to the external data service.
- shouldForceBack() - Method in interface com.github.sttk.sabi.DataConn
-
Indicates whether a force-back operation should be performed.
T
- toString() - Method in record class com.github.sttk.sabi.AsyncGroup.RunnerFailed
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sttk.sabi.AsyncGroup.RunnerInterrupted
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sttk.sabi.DataHub.CreatedDataConnIsNull
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sttk.sabi.DataHub.FailToCastDataConn
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sttk.sabi.DataHub.FailToCommitDataConn
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sttk.sabi.DataHub.FailToCreateDataConn
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sttk.sabi.DataHub.FailToPreCommitDataConn
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sttk.sabi.DataHub.FailToSetupGlobalDataSrcs
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sttk.sabi.DataHub.FailToSetupLocalDataSrcs
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sttk.sabi.DataHub.NoDataSrcToCreateDataConn
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sttk.sabi.DataHub.RuntimeExceptionOccurred
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.sttk.sabi.Sabi.FailToCastDataHub
-
Returns a string representation of this record class.
- txn(Logic<D>, DataHub) - Static method in class com.github.sttk.sabi.Sabi
-
Executes the provided application
Logic
within a transactional context.
U
- uses(String, DataSrc) - Method in class com.github.sttk.sabi.DataHub
-
Registers a local
DataSrc
with the specified name for use within thisDataHub
instance. - uses(String, DataSrc) - Static method in class com.github.sttk.sabi.Sabi
-
Registers a
DataSrc
object with a unique name for global use within the Sabi framework.
All Classes and Interfaces|All Packages