Index (sabi 0.9.0 API)

A C D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages

A

add(Runner) - Method in interface com.github.sttk.sabi.AsyncGroup: Adds a background task to be executed asynchronously by this group.
AsyncGroup - Interface in com.github.sttk.sabi: Manages asynchronous background tasks executed during data source and data connection lifecycle events.
AsyncGroup.RunnerFailed - Record Class in com.github.sttk.sabi: Indicates that a registered Runner task failed during its execution.
AsyncGroup.RunnerInterrupted - Record Class in com.github.sttk.sabi: Indicates that a registered Runner task execution was interrupted.
AsyncGroup.RuntimeExceptionOccured - Record Class in com.github.sttk.sabi: Indicates that an unhandled runtime exception was thrown during the execution of a registered Runner task.

C

cause - Variable in class com.github.sttk.sabi.TxnFailureReport: The cause of the transaction failure associated with this connection.
close() - Method in interface com.github.sttk.sabi.DataConn: Closes and disposes of this data connection, releasing any held resources.
close() - Method in class com.github.sttk.sabi.DataHub: Closes all local data sources registered in this hub and releases their resources.
close() - Method in interface com.github.sttk.sabi.DataSrc: Closes this data source and disposes of any allocated resources or connection pools.
com.github.sttk.sabi - module com.github.sttk.sabi: Defines the module APIs of the Sabi framework.
com.github.sttk.sabi - package com.github.sttk.sabi: Provides core interfaces and classes for the sabi framework.
commit(AsyncGroup) - Method in interface com.github.sttk.sabi.DataConn: Commits changes made through this connection.
CommitFailure - Enum constant in enum class com.github.sttk.sabi.TxnFailureCauseState: Indicates that the transaction failed during the commit phase of a connection.
createDataConn() - Method in interface com.github.sttk.sabi.DataSrc: Creates a new DataConn instance associated with this data source.
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: Provides access to named DataConn data connection instances.
DataConn - Interface in com.github.sttk.sabi: Represents a data connection participating in transaction lifecycles managed by a DataHub.
DataConn.FailToCommitDataConn - Record Class in com.github.sttk.sabi: Represents an error when one or more data connections fail during the commit phase.
DataConn.FailToPostCommitDataConn - Record Class in com.github.sttk.sabi: Represents an error when one or more data connections fail during the post-commit phase.
DataConn.FailToPreCommitDataConn - Record Class in com.github.sttk.sabi: Represents an error when one or more data connections fail during the pre-commit phase.
dataConnName - Variable in class com.github.sttk.sabi.TxnFailureReport: The logical name of the data connection.
dataConnType - Variable in class com.github.sttk.sabi.TxnFailureReport: The class name or type of the data connection.
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: Manages local data sources and data connections, and executes business logic in transactional or non-transactional scopes.
DataHub() - Constructor for class com.github.sttk.sabi.DataHub: Constructs a new, default DataHub instance.
DataHub(String...) - Constructor for class com.github.sttk.sabi.DataHub: Constructs a new DataHub instance configured to use specified global data sources.
DataHub(List) - Constructor for class com.github.sttk.sabi.DataHub: Constructs a new DataHub instance configured to use specified global data sources.
DataHub.CreatedDataConnIsNull - Record Class in com.github.sttk.sabi: Represents an error when a created data connection instance is null.
DataHub.FailToCastDataConn - Record Class in com.github.sttk.sabi: Represents an error when a connection cannot be cast to the target connection type.
DataHub.FailToCastDataHub - Record Class in com.github.sttk.sabi: Represents an error when casting this DataHub instance to the generic data context fails.
DataHub.FailToCreateDataConn - Record Class in com.github.sttk.sabi: Represents an error when creating a data connection fails.
DataHub.FailToSetupGlobalDataSrcs - Record Class in com.github.sttk.sabi: Represents an error when setting up global data sources fails.
DataHub.FailToSetupLocalDataSrcs - Record Class in com.github.sttk.sabi: Represents an error when setting up local data sources fails.
DataHub.NoDataSrcToCreateDataConn - Record Class in com.github.sttk.sabi: Represents an error when no data source with the specified name is found.
DataHub.RuntimeExceptionOccurred - Record Class in com.github.sttk.sabi: Represents an error when an unhandled runtime exception occurs during logic execution.
DataSrc - Interface in com.github.sttk.sabi: Represents a data source corresponding to an external data resource, serving as a factory for data connections or as a connection pool.
disuses(String) - Method in class com.github.sttk.sabi.DataHub: Unregisters a local DataSrc associated with the given name from this hub.

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.AsyncGroup.RuntimeExceptionOccured: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.github.sttk.sabi.DataConn.FailToCommitDataConn: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.github.sttk.sabi.DataConn.FailToPostCommitDataConn: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.github.sttk.sabi.DataConn.FailToPreCommitDataConn: 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.FailToCastDataHub: 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.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.
err - Variable in class com.github.sttk.sabi.ErrEntry: The error instance containing details of the failure cause.
err - Variable in class com.github.sttk.sabi.TxnFailureCause: The error instance associated with the transaction failure, or null if none.
err - Variable in class com.github.sttk.sabi.TxnFailureRollback: The error instance associated with a rollback failure, or null if none.
ErrEntry - Class in com.github.sttk.sabi: Represents an error entry containing details of a failure associated with a specific data source or data connection.
ErrEntry(int, String, Err) - Constructor for class com.github.sttk.sabi.ErrEntry: Constructs a new ErrEntry with the specified index, name, and error cause.
errors() - Method in record class com.github.sttk.sabi.DataConn.FailToCommitDataConn: Returns the value of the errors record component.
errors() - Method in record class com.github.sttk.sabi.DataConn.FailToPostCommitDataConn: Returns the value of the errors record component.
errors() - Method in record class com.github.sttk.sabi.DataConn.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, 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.DataHub.FailToCastDataHub: Creates an instance of a FailToCastDataHub record class.
FailToCommitDataConn(List) - Constructor for record class com.github.sttk.sabi.DataConn.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.
FailToPostCommitDataConn(List) - Constructor for record class com.github.sttk.sabi.DataConn.FailToPostCommitDataConn: Creates an instance of a FailToPostCommitDataConn record class.
FailToPreCommitDataConn(List) - Constructor for record class com.github.sttk.sabi.DataConn.FailToPreCommitDataConn: Creates an instance of a FailToPreCommitDataConn record class.
FailToSetupGlobalDataSrcs(List) - Constructor for record class com.github.sttk.sabi.DataHub.FailToSetupGlobalDataSrcs: Creates an instance of a FailToSetupGlobalDataSrcs record class.
FailToSetupLocalDataSrcs(List) - Constructor for record class com.github.sttk.sabi.DataHub.FailToSetupLocalDataSrcs: Creates an instance of a FailToSetupLocalDataSrcs record class.
fromDataConnType() - Method in record class com.github.sttk.sabi.DataHub.FailToCastDataConn: Returns the value of the fromDataConnType record component.
fromType() - Method in record class com.github.sttk.sabi.DataHub.FailToCastDataHub: Returns the value of the fromType record component.

G

getDataConn(String, Class) - Method in interface com.github.sttk.sabi.DataAcc: Retrieves a data connection associated with the specified data source name and casts it to the requested connection class type.
getDataConn(String, Class) - Method in class com.github.sttk.sabi.DataHub: Retrieves a data connection associated with the specified data source name and casts it to the requested connection class type.

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.AsyncGroup.RuntimeExceptionOccured: Returns a hash code value for this object.
hashCode() - Method in record class com.github.sttk.sabi.DataConn.FailToCommitDataConn: Returns a hash code value for this object.
hashCode() - Method in record class com.github.sttk.sabi.DataConn.FailToPostCommitDataConn: Returns a hash code value for this object.
hashCode() - Method in record class com.github.sttk.sabi.DataConn.FailToPreCommitDataConn: 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.FailToCastDataHub: 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.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.

I

index - Variable in class com.github.sttk.sabi.ErrEntry: The positional index of the data source or connection in the operation sequence.
InvestigateBecauseImpossible - Enum constant in enum class com.github.sttk.sabi.TxnFailureRecovery: Indicates an impossible state occurred that requires investigation.
isCauseOfFailure() - Method in class com.github.sttk.sabi.TxnFailureReport: Determines whether this connection was a direct cause of the transaction failure.
isCommitted() - Method in interface com.github.sttk.sabi.DataConn: Checks whether this connection has been successfully committed.

L

Logic<D> - Interface in com.github.sttk.sabi: Functional interface representing a unit of business logic executed within a DataHub scope.
LogicFailure - Enum constant in enum class com.github.sttk.sabi.TxnFailureCauseState: Indicates that the transaction failed due to an error during logic execution.

M

ManualRollbackRequired - Enum constant in enum class com.github.sttk.sabi.TxnFailureRecovery: Indicates that manual intervention is required to roll back changes.

N

name - Variable in class com.github.sttk.sabi.ErrEntry: The logical name of the data source or connection where the error occurred.
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.
NoActionRequired - Enum constant in enum class com.github.sttk.sabi.TxnFailureRecovery: Indicates that no recovery action is required.
NoDataSrcToCreateDataConn(String, String) - Constructor for record class com.github.sttk.sabi.DataHub.NoDataSrcToCreateDataConn: Creates an instance of a NoDataSrcToCreateDataConn record class.
NoneByCommitted - Enum constant in enum class com.github.sttk.sabi.TxnFailureCauseState: Indicates no failure occurred and the connection was committed successfully.
NoneByNotRolledBack - Enum constant in enum class com.github.sttk.sabi.TxnFailureRollbackState: Indicates that no rollback was performed on the connection.
NoneByRolledBack - Enum constant in enum class com.github.sttk.sabi.TxnFailureRollbackState: Indicates that the connection was successfully rolled back without error.
NoneByUncommitted - Enum constant in enum class com.github.sttk.sabi.TxnFailureCauseState: Indicates no failure occurred and the connection remained uncommitted.

O

onTxnFailure(AsyncGroup, List) - Method in interface com.github.sttk.sabi.DataConn: Notifies this connection of a transaction failure with detailed failure reports.

P

postCommit(AsyncGroup) - Method in interface com.github.sttk.sabi.DataConn: Performs post-commit operations after all connections in a transaction have successfully committed.
PostCommitFailure - Enum constant in enum class com.github.sttk.sabi.TxnFailureCauseState: Indicates that the transaction failed during the post-commit phase of a connection.
preCommit(AsyncGroup) - Method in interface com.github.sttk.sabi.DataConn: Prepares this connection for commit prior to the main commit phase.

R

recoveryForCommit() - Method in class com.github.sttk.sabi.TxnFailureReport: Determines the recommended recovery strategy if the intent is to re-attempt and complete the transaction commit.
recoveryForRollback() - Method in class com.github.sttk.sabi.TxnFailureReport: Determines the recommended recovery strategy if the intent is to cancel and roll back the transaction.
RerunLogicAndCommit - Enum constant in enum class com.github.sttk.sabi.TxnFailureRecovery: Indicates that the logic should be rerun and committed again without further changes.
ResolveCauseAndInconsistency - Enum constant in enum class com.github.sttk.sabi.TxnFailureRecovery: Indicates that both the root cause and any resulting data inconsistency must be resolved.
ResolveCauseThenRerunLogicAndCommit - Enum constant in enum class com.github.sttk.sabi.TxnFailureRecovery: Indicates that the root cause must be resolved before rerunning logic and committing.
ResolveCauseThenRerunPostCommit - Enum constant in enum class com.github.sttk.sabi.TxnFailureRecovery: Indicates that the root cause must be resolved before rerunning the post-commit phase.
rollback - Variable in class com.github.sttk.sabi.TxnFailureReport: The rollback outcome associated with this connection.
rollback(AsyncGroup) - Method in interface com.github.sttk.sabi.DataConn: Rolls back changes made through this connection.
RollbackFailure - Enum constant in enum class com.github.sttk.sabi.TxnFailureRollbackState: Indicates that an error occurred while attempting to roll back the connection.
run() - Method in interface com.github.sttk.sabi.Runner: Runs the asynchronous background task.
run(Logic) - Method in class com.github.sttk.sabi.DataHub: Executes business logic in a non-transactional scope.
run(D) - Method in interface com.github.sttk.sabi.Logic: Executes the business logic using the provided data access interface.
Runner - Interface in com.github.sttk.sabi: Functional interface representing an asynchronous task to be executed by an AsyncGroup.
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.
RuntimeExceptionOccured() - Constructor for record class com.github.sttk.sabi.AsyncGroup.RuntimeExceptionOccured: Creates an instance of a RuntimeExceptionOccured 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: Utility class for managing and setting up global DataSrc instances.
setup() - Static method in class com.github.sttk.sabi.Sabi: Sets up all registered global data sources in their registration order.
setup(AsyncGroup) - Method in interface com.github.sttk.sabi.DataSrc: Sets up this data source.
setup(String...) - Static method in class com.github.sttk.sabi.Sabi: Sets up registered global data sources matching the specified names in the given order.
setup(List) - Static method in class com.github.sttk.sabi.Sabi: Sets up registered global data sources matching the specified list of names in the given order.
state - Variable in class com.github.sttk.sabi.TxnFailureCause: The transaction failure cause state indicating the phase or status of the failure.
state - Variable in class com.github.sttk.sabi.TxnFailureRollback: The transaction failure rollback state indicating the outcome of the rollback.

T

toDataConnType() - Method in record class com.github.sttk.sabi.DataHub.FailToCastDataConn: Returns the value of the toDataConnType record component.
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.AsyncGroup.RuntimeExceptionOccured: Returns a string representation of this record class.
toString() - Method in record class com.github.sttk.sabi.DataConn.FailToCommitDataConn: Returns a string representation of this record class.
toString() - Method in record class com.github.sttk.sabi.DataConn.FailToPostCommitDataConn: Returns a string representation of this record class.
toString() - Method in record class com.github.sttk.sabi.DataConn.FailToPreCommitDataConn: 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.FailToCastDataHub: 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.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 class com.github.sttk.sabi.TxnFailureCause: Returns a string representation of this transaction failure cause.
toString() - Method in class com.github.sttk.sabi.TxnFailureReport: Returns a string representation of this transaction failure report.
toString() - Method in class com.github.sttk.sabi.TxnFailureRollback: Returns a string representation of this transaction failure rollback outcome.
txn(Logic) - Method in class com.github.sttk.sabi.DataHub: Executes business logic within a transactional boundary.
TxnFailureCause - Class in com.github.sttk.sabi: Represents the cause of a transaction failure, containing state information and the associated error.
TxnFailureCause(TxnFailureCauseState, Err) - Constructor for class com.github.sttk.sabi.TxnFailureCause: Constructs a new TxnFailureCause with the specified failure state and error.
TxnFailureCauseState - Enum Class in com.github.sttk.sabi: Defines the states representing causes of transaction failures or successful states.
TxnFailureRecovery - Enum Class in com.github.sttk.sabi: Defines recommended recovery actions to handle transaction failures.
TxnFailureReport - Class in com.github.sttk.sabi: Contains transaction failure diagnostic information and rollback status for a specific data connection.
TxnFailureReport(String, String, TxnFailureCause, TxnFailureRollback) - Constructor for class com.github.sttk.sabi.TxnFailureReport: Constructs a new TxnFailureReport with the specified connection details, cause, and rollback outcome.
TxnFailureRollback - Class in com.github.sttk.sabi: Represents the rollback outcome of a data connection during transaction failure processing.
TxnFailureRollback(TxnFailureRollbackState, Err) - Constructor for class com.github.sttk.sabi.TxnFailureRollback: Constructs a new TxnFailureRollback with the specified rollback state and error.
TxnFailureRollbackState - Enum Class in com.github.sttk.sabi: Defines the states representing outcomes of transaction rollback attempts.

U

uses(String, DataSrc) - Method in class com.github.sttk.sabi.DataHub: Registers a local DataSrc with a specific name in this hub.
uses(String, DataSrc) - Static method in class com.github.sttk.sabi.Sabi: Registers a global data source with the specified logical name.

V

valueOf(String) - Static method in enum class com.github.sttk.sabi.TxnFailureCauseState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.sttk.sabi.TxnFailureRecovery: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.sttk.sabi.TxnFailureRollbackState: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.github.sttk.sabi.TxnFailureCauseState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.sttk.sabi.TxnFailureRecovery: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.sttk.sabi.TxnFailureRollbackState: Returns an array containing the constants of this enum class, in the order they are declared.

A C D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages