client-scanner/io.github.octaviusframework.client.scanner

Package-level declarations

Types

data class RegisteredType(val kClass: KClass<*>, val name: String)

A class the scan registered, and the name it was registered under: the type name for an enum or composite, the discriminator for a dynamic_dto class.

ScanReport

data class ScanReport(val enums: List<RegisteredType>, val composites: List<RegisteredType>, val dynamicTypes: List<RegisteredType>, val unresolved: List<RegisteredType> = emptyList())

What a scan found and registered. Worth logging or checking at startup: a mistyped package registers nothing and raises nothing.

Functions

registerAnnotatedTypes

fun OctaviusClient.registerAnnotatedTypes(vararg packages: String): ScanReport

Finds the classes in packages and their subpackages annotated with PgEnumType, PgCompositeType or DynamicallyMappable, and registers each with this client, as typeManager.registerEnum, registerAutoComposite and dynamicTypes.register would.

fun OctaviusClient.registerAnnotatedTypes(packages: List<String>, classLoader: ClassLoader? = null): ScanReport

As the vararg overload, looking for the classes in classLoader: for an application whose classes are not on the loader that loaded this one, such as an OSGi container or a plugin host. null uses the default.