Docs / API

API overview

com.s8.meta.api module S8-meta-API

All application code talks to S8 through com.s8.meta.api. It is an API-only module: interfaces, annotations, and request types. Implementations arrive via ServiceLoader.

Current names Live sources use S8SyncFlow, S8.WEB_SERVER_FACTORY, and com.s8.meta.api.front. Older comments may still say S8AsyncFlow or S8.FACTORY. Prefer the signatures on these pages.

Packages

com.s8.meta.api: Façade S8 holding the SPI factories.
com.s8.meta.api.server: Web server factory, server, boot method, parameters.
com.s8.meta.api.flow: The orchestration flow, user, exceptions.
com.s8.meta.api.front: Remote UI graph: session, objects, vertices, inbound/outbound.
com.s8.meta.api.flow.table: Flash key/value tables of RowS8Object.
com.s8.meta.api.flow.space: Object-graph spaces.
com.s8.meta.api.flow.repository: Git-like object repositories.
com.s8.meta.api.flow.mail: Outbound mail through the flow.
com.s8.meta.api.annotations: @S8ObjectType, @S8Field, @S8Method, @S8RowType.
serial / bytes: Binary protocol, prototypes, typed inflows/outflows.
com.s8.meta.api.script: Dev-ops scripts against a live flow.

Typical call shape

shape.txt

// boot
S8.WEB_SERVER_FACTORY.createWebServer(config, BootClass, params ->
    params.addBootMethod("/", flow -> { /* live S8SyncFlow */ }));

// inside boot / inbound handler
flow.front();
flow.tables();
flow.spaces();
flow.repositories();
flow.refresh();

See Your first app for a walkthrough.