Package com.mcpdbwizard.pub

package com.mcpdbwizard.pub

The runtime library that MCPDBWizard-generated code links against.

What this package is

MCPDBWizard reads an Oracle schema and emits Java: DAO factories, table managers, callable-statement wrappers, SQL statement classes and — optionally — a Model Context Protocol server. That emitted code is standalone except for this package, which supplies the pieces it would otherwise have to repeat in every generated class: binding parameters, reading rows, carrying PL/SQL collections across JDBC, logging, and reporting failure.

You do not normally construct these types yourself. Generated code does, and you call the generated code. The exceptions are the LogInterface implementations, which you may pass to a generated factory, and SparseVector, which you build to pass a sparse VECTOR to a 23ai column.

The compatibility contract

Signatures here are load-bearing for every program this generator has ever produced. A program generated years ago compiles against whatever version of this library is on its classpath today. Adding a method is safe; changing or removing one breaks code that no longer exists in any repository anyone can rebuild. That constraint explains a good deal of what follows — notably why several classes have near-duplicate siblings rather than a single method with a widened signature.

Finding your way around

Running SQL. QueryStatement for a SELECT, DmlStatement for INSERT/UPDATE/DELETE, and CallableStatementParameters for a PL/SQL call — the last being where the awkward part of this problem lives, since a PL/SQL routine can take and return records, collections and ref cursors that JDBC has no direct notion of. StatementParameters2 holds the bind logic those share.

Rows. ReadOnlyRowSet is what a query and an OUT ref cursor both produce; WriteableRowSet is what an insert or update consumes. They understand the Oracle types JDBC does not surface plainly, including native JSON, BOOLEAN and the several VECTOR formats.

PL/SQL collections. PlsqlArray is the interface every generated VARRAY and nested-table class implements. PlsqlIndexByTable and PlsqlIndexByTable2 carry index-by tables, which Oracle exposes differently again.

Failure. Everything throws CSException or a subclass of it, so a caller can catch one type and still distinguish causes. Two are worth knowing by name: CSDocumentChangedException means an optimistic-lock check found the row or document changed since you read it — re-read and reapply — and CSPoolExhaustedException means a DaoFactoryPool had nothing free, which is a capacity signal rather than a database error and is worth alerting on separately.

Logging. LogInterface with implementations for the console, a text file, java.util.logging (JulLog), SLF4J (Slf4jLog) and Log4j 2 (Log4j2Log). The generated factory picks one from its configuration; LogBackends lets a deployment override that choice at run time, because the right backend differs between a container, a stdio process and a desktop program while the generated code is the same.

MCP runtime. When a generated server is emitted, it uses McpAuditSink and friends for the audit trail, McpMetrics for Prometheus counters, and McpHttpPolicy for the transport rules the MCP specification requires. These are inert in a program that is not an MCP server.

Two hazards worth reading before you are bitten by them

ConsoleLog blocks. It asks the console to acknowledge a warning, so a program using it stops and waits rather than continuing. That is reasonable for an interactive tool and wrong for anything unattended: in a test or a server it does not fail, it hangs. Use JulLog or TextLog for unattended code.

An audit sink must never throw. McpAuditSink implementations record what already happened; letting one propagate a failure would turn a logging problem into a failed database call, which is the wrong trade in both directions. Implementations here absorb and count instead, which is why they report a drop count rather than raising.

See Also:

• LibraryInfo

Class	Description
CallableStatementParameters	A set of parameters for a Callable Statement statement call
ConsoleLog	This is a lightweight implementation of LogInterface that uses standard output for information messages and standard error for everything else.
CSAttemptToGetNullException	Thrown when a method which returns a native type such as int,long,double is called for a column whose value is null.
CSColumnException	Thrown by the rowValidate method when a non-null column is null or a number column's contents don't match the size of the corresponding database column.
CSDBException	Thrown when a SQLException is generated.
CSDBInvalidDatatypeCastException	Thrown when an attempt is made to retrieve a value in a form that it can not be converted to.
CSDBNullObjectException	Thrown when a null is found where an object is required
CSDocumentChangedException	Thrown when an etag-checked duality-view document update finds that the document has been changed or deleted by another session since it was read (optimistic locking failure).
CSException	An extension of Exception used by this package.
CSInvalidColumnIdException	Thrown when an attempt is made to retrieve a value from a column that does not exist.
CSInvalidDataTypeException	Thrown when an we encounter a value whose data type is unsupported
CSIOException	Thrown when we encounter an IOException
CSNoDataInRowSetException	Thrown when an attempt is made to retrieve a value from an empty readOnlyRowset.
CSNoNanosAllowedException	Thrown when a Timestamp contains nanoseconds but the Oracle table/record it will be used against is DATA and doesn't support nanonseconds.
CSNumberFormatException	Thrown when an attempt to turn a String into a number fails
CSPoolExhaustedException	Thrown when DaoFactoryPool could not supply a factory within DAO_POOL_MAX_WAIT_MS: every factory is checked out and the pool is at DAO_POOL_MAX_SIZE.
CSUnsupportedDatatypeException	Thrown when an attempt is made to retrieve a value from a column has an unsupported datatype
DaoFactoryPool<T extends PooledResourceUser>	A pool of warm DAO factories: grows on demand to DAO_POOL_MAX_SIZE, makes borrowers wait when saturated, and shrinks back to DAO_POOL_MIN_IDLE once traffic stops.
DaoFactoryPool.PoolTask<T,R>	A unit of work to run against a borrowed factory.
DaoFactoryPoolConfig	Sizing and lifetime settings for a DaoFactoryPool.
DmlStatement	A parameterized SQL statement that continues to exist even if the connection it uses is withdrawn.
EnvironmentSecret	Reads a secret from the environment, either directly or from a file the environment points at.
FanOutAuditSink	Sends every record to several sinks, so a deployment can keep a local trail and stream.
FileAuditSink	Keeps the audit trail on this machine for a bounded window, and deletes it when the window passes.
GenericLog	Partial implementation of LogInterface that composes error messages but leaves the actual logging to other classes.
IOUtils	A set of useful static methods for working with files.
JavaArrayObject	This interface is used in scenarios where non-Oracle array support is required
JulLog	An implementation of LogInterface that routes every message to java.util.logging (JUL), the logging framework built into the JDK.
KafkaAuditSink	Reference McpAuditSink that publishes audit records to a Kafka topic.
LibraryInfo	Static class for providing information about the MCPDBWizard Public Library.
Log4j2Log	An implementation of LogInterface that routes every message to Apache Log4j 2.
LogBackends	Lets the deployment override the logging backend the generator chose.
LogInterface	Interface for Logging used by MCPDBWizard software.
LongObjectLoader	This utility class is used to get LOB objects into and out of the database.
McpAuditEvent	One auditable MCP tool call: what ran, how it ended, and — depending on the configured level — what went in and came back.
McpAuditSink	Where a generated MCP server sends its audit records.
McpAuditSinks	Chooses and builds the McpAuditSink a generated server uses.
McpAuditSinks.Level	How much of a call is recorded.
McpBinary	How a RAW crosses the Model Context Protocol when it is an INDEX-BY table element, in one place.
McpCallRecord	One line per MCP tool call, for the operator: which tool ran, how it ended, and how long it took.
McpDateModule	McpDates as a Jackson module, so a date crosses the same way inside a RECORD as it does as a parameter of its own.
McpDates	How a DATE or TIMESTAMP crosses the Model Context Protocol, in one place.
McpHttpPolicy	How a generated MCP server exposes its Streamable HTTP transport: which network interface it binds, and which browser origins it will answer.
McpMetrics	Per-tool call metrics for a generated MCP server, in Prometheus exposition format.
McpMetricsExporter	Serves a McpMetrics registry at /metrics for Prometheus to scrape.
McpOAuthPolicy	OAuth 2.1 resource-server behaviour for a generated MCP server: validating access tokens, and telling clients where to get one.
McpOAuthPolicy.Decision	What the caller should do with a request.
McpProtocolLog	The text of one MCP notifications/message — a log line sent to the CLIENT over the protocol, not to the operator.
McpRateLimiter	A token bucket bounding how often a generated MCP server starts work.
Namer	Product branding strings, in one place.
OpenCursorCheck	Warns, once at start-up, when a config publishes more tools than the database session can hold open cursors for.
OracleResourceUser	An interface that can be inplemented by objects that tend to use up cursors and other oracle resources.
PlsqlArray	Represents a PL/SQL VARRAY or TABLE
PlsqlIndexByTable	Holds state variables for PL/SQL Index By Table parameters
PlsqlIndexByTable2	Holds state variables for PL/SQL Index By Table parameters
PooledResourceUser	What DaoFactoryPool needs from a poolable DAO factory.
QueryStatement	A SELECT statement with caching.
QueryTimeout	An optional cap on how long any one generated statement may run.
ReadOnlyRowSet	A class for representing a ResultSet or set of stored procedure parameters.
ResourceWatcher	A static class for keeping track of free memory.
S3AuditSink	Writes the audit trail to S3 as rolling JSONL objects.
SessionInfo	Names the session in Oracle's own views, by calling DBMS_APPLICATION_INFO.SET_MODULE once when a connection is opened.
Slf4jLog	An implementation of LogInterface that routes every message to SLF4J (the Simple Logging Facade for Java).
SparseVector	A sparse Oracle VECTOR value (23ai): a high-dimensional vector stored as its non-zero entries only.
SplunkAuditSink	Sends audit records to Splunk's HTTP Event Collector.
SpoolCipher	Encrypts one spooled audit record, so a write-ahead spool is not plaintext on disk.
SpoolingAuditSink	Writes every audit record to disk first, then delivers it to a delegate sink and deletes it only once the delegate confirms.
SqlUtils	A set of useful static methods for working with SQL.
StatementParameters2	A set of parameters for a PreparedStatement or CallableStatement
StatsInterface	An interface for tracking and accessing basic performance information.
SyslogAuditSink	Sends audit records to a syslog collector as RFC 5424 messages.
TextLog	A heavyweight implementation of LogInterface.
UiLog	This is an implementation of LogInterface that uses a javax.swing.JLabel field to display messages.
WriteableRowSet	Create a writableRowSet that is based on a ResultSet.