Package org.restsql.core

Contains core framework interfaces, an API for deployments that use restSQL as a library, rather than an HTTP service.

See: Description

Interface Summary

Interface	Description
ColumnMetaData	Encapsulates column (or field) metadata of an SQL Resource.
Factory.ConnectionFactory	Creates JDBC connection objects.
Factory.RequestDeserializerFactory	Creates RequestDeserializer objects.
Factory.RequestFactory	Creates Request objects.
Factory.ResponseSerializerFactory	Creates ResponseSerializer objects.
Factory.SqlResourceFactory	Creates SQLResource objects.
HttpRequestAttributes	Contains HTTP request attributes.
Request	Represents a single CRUD request on a specific SQL Resource.
RequestDeserializer	Processes requests represented in some string form, e.g.
RequestLogger	Logs request for troubleshooting applications.
ResponseSerializer	Converts read/write results to a string, e.g.
SequenceManager	Contains functions to manage sequences.
SqlBuilder	Builds SQL for an operation on a SQL Resource.
SqlResource	Represents an SQL Resource, a queryable and updatable database "view".
SqlResourceMetaData	Represents meta data for sql resource.
TableMetaData	Encapsulates table information for an SQL Resource.
Trigger	Provides a mechanism for executing non-trivial domain validation or business logic on all CRUD operations.

Class Summary

Class	Description
AbstractFactory	Base class for generic factories.
AbstractFactory.FactoryHelper	Helps lookup implementation configuration, load the class and construct an instance.
AbstractTrigger	Contains no-op implementation of Trigger interface.
BinaryObject	Wraps a byte array for input/output to a binary type column.
Config	Loads properties from user-supplied file, defines property keys and defaults, and configures logging for framework.
Config.ImmutableProperties	Wraps a java.util.Properties, exposing only the property getter.
Factory	Creates implementations and also is a facade for other framework factories.
RequestUtil	Contains utility methods to assist request processing.
RequestValue	Encapsulates name and value for collections of request identifiers and parameters.
ResponseValue	Represents a response column name, value and column number, which may be placed into a set ordered by column number.
SqlBuilder.SqlStruct	Helper struct for building SQL.
WriteResponse	Represents a restSQL write response containing the rows affected.

Enum Summary

Enum	Description
Request.Type	Represents request types, mapping to CRUD operations.
RequestValue.Operator	Represents all operations for parameters.
TableMetaData.TableRole	Represents all of the roles a table may plan in a SQL Resource.

Exception Summary

Exception	Description
Factory.SqlResourceFactoryException	Indicates an error in creating a SQL Resource object from a definition.
InvalidRequestException	Exception is thrown when a request does not meet expectations.
SqlResourceException	Represents a restSQL error, typically wrapping an SQLException and adding an SQL String.

Package org.restsql.core Description

Contains core framework interfaces, an API for deployments that use restSQL as a library, rather than an HTTP service.