Module Contents

vertx-kuickstart-core

Module Contents

Module Contents

interface AllQuery<T :

>

Module Contents

abstract suspend fun all(connection: SqlClient):

<

T

>

fun <reified T :

>

impl

(

schema

:

,

table

:

)

:

<

T

>

class AllQueryImpl<T :

>

:

<

T

>

,

Module Contents

AllQueryImpl(schema:

,

table

:

,

type

:

<

T

>

,

deserializer

:

)

suspend fun all(connection: SqlClient):

<

T

>

class AuthorizationException :

ResponseCodeException

Module Contents

AuthorizationException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

class BadRequestException :

ResponseCodeException

Module Contents

BadRequestException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

class ConflictException :

ResponseCodeException

Module Contents

ConflictException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

interface ControllerSupplier

Module Contents

abstract fun getControllerInstance(controllerName:

)

:

class DatabaseAccess

Module Contents

DatabaseAccess(config: JsonObject, vertx: Vertx)

suspend fun <T :

>

getConnection

(

dbAction

:

suspend

(

SqlClient

)

->

T

?

)

:

T

suspend fun <T :

>

getTransaction

(

dbAction

:

suspend

(

SqlClient

)

->

T

?

)

:

T

interface DeleteQuery

Module Contents

abstract suspend fun delete(id:

,

connection

:

SqlClient

)

:

fun impl(schema:

,

table

:

)

:

class DeleteQueryImpl :

Module Contents

DeleteQueryImpl(schema:

,

table

:

)

suspend fun delete(id:

,

connection

:

SqlClient

)

:

interface Deserializer

Module Contents

abstract fun <T :

>

<

T

>

.

instantiate

(

json

:

JsonObject

?

)

:

T

?

.

instantiate

(

json

:

JsonObject

?

)

:

?

abstract fun <T :

>

<

T

>

.

instantiate

(

arr

:

JsonArray

?

)

:

T

?

.

instantiate

(

arr

:

JsonArray

?

)

:

?

class DeserializerImpl :

Module Contents

DeserializerImpl()

>

<

T

>

.

instantiate

(

json

:

JsonObject

?

)

:

T

?

.

instantiate

(

json

:

JsonObject

?

)

:

?

>

<

T

>

.

instantiate

(

arr

:

JsonArray

?

)

:

T

?

.

instantiate

(

arr

:

JsonArray

?

)

:

?

.

instantiate

(

json

:

JsonObject

?

,

genericsMap

:

<

,

>

)

:

?

data class Field<T>

Module Contents

Field(value: T?, present:

)

interface FindQuery<T :

>

Module Contents

abstract suspend fun find(id:

,

connection

:

SqlClient

)

:

T

fun <reified T :

>

impl

(

schema

:

,

table

:

)

:

<

T

>

class FindQueryImpl<T :

>

:

<

T

>

,

Module Contents

FindQueryImpl(schema:

,

table

:

,

type

:

<

T

>

,

deserializer

:

)

suspend fun find(id:

,

connection

:

SqlClient

)

:

T

class ForbiddenException :

ResponseCodeException

Module Contents

ForbiddenException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

class FullParameter

Module Contents

<

*

>

<

*

>

class FullType<T>

Module Contents

enum class HTTPStatusCode

Module Contents

GATEWAY_TIMEOUT

PAYMENT_REQUIRED

PERMANENT_REDIRECT

TOO_MANY_REQUESTS

interface InsertQuery<T :

,

R

:

>

Module Contents

,

reified

R

:

>

impl

(

schema

:

,

table

:

)

:

<

T

,

R

>

abstract suspend fun insert(toInsert: T, connection: SqlClient): R

class InsertQueryImpl<T :

,

R

:

>

:

<

T

,

R

>

,

,

Module Contents

InsertQueryImpl(schema:

,

table

:

,

type

:

<

R

>

,

serializer

:

,

deserializer

:

)

suspend fun insert(toInsert: T, connection: SqlClient): R

io.vertx.core.json.JsonArray

Module Contents

operator fun JsonArray.minus(other: JsonArray): JsonArray

operator fun JsonArray.minus(item:

?

)

:

JsonArray

operator fun JsonArray.minus(index:

)

:

JsonArray

operator fun JsonArray.plus(other: JsonArray): JsonArray

operator fun JsonArray.plus(item:

?

)

:

JsonArray

io.vertx.core.json.JsonObject

Module Contents

operator fun JsonObject.minus(key:

)

:

JsonObject

operator fun JsonObject.minus(keys:

<

>

)

:

JsonObject

operator fun JsonObject.plus(other: JsonObject): JsonObject

operator fun JsonObject.plus(pair:

<

,

*

>

)

:

JsonObject

io.vertx.core.Vertx

Module Contents

fun Vertx.config(): JsonObject

class JwtAuthHelper :

SwaggerAuthHandler

Module Contents

JwtAuthHelper(config: JsonObject, vertx: Vertx)

fun authenticateUserRoles(requiredRoles:

,

userRoles

:

JsonArray

)

:

fun createAuthHandlers(roles:

)

:

val EXPIRATION_MILLIS:

fun generateToken(json: JsonObject):

fun isTokenExpired(created:

)

:

kotlin.reflect.KFunction

Module Contents

<

*

>

.

fullParameters

:

<

>

class ModelNotFoundException :

ResponseCodeException

Module Contents

ModelNotFoundException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

data class PositionalSql

Module Contents

PositionalSql(sql:

,

params

:

Tuple

)

val params: Tuple

data class PreparedPositionalSql

Module Contents

PreparedPositionalSql(sql:

,

paramNames

:

<

>

,

convertParams

:

(

params

:

<

,

?

>

)

->

Tuple

)

val convertParams: (params:

<

,

?

>

)

->

Tuple

val paramNames:

<

>

fun toPositional(params:

<

,

?

>

)

:

open class ResponseCodeException :

RuntimeException

Module Contents

ResponseCodeException(message:

=

,

details

:

JsonArray

=

,

statusCode

:

=

,

throwable

:

?

=

)

fun asJson(): JsonObject

val details: JsonArray

fun fromStatusCode(statusCode:

?

,

errorMessage

:

,

details

:

JsonArray

)

:

ResponseCodeException

val statusCode:

typealias Roles =

<

,

<

>

>

typealias RouteHandlers =

<

Handler

<

RoutingContext

>

>

interface Serializer

Module Contents

<

*

>

.

serialize

(

)

:

JsonArray

abstract fun <T :

>

T

.

serialize

(

)

:

JsonObject

<

*

,

*

>

.

serialize

(

)

:

JsonObject

class SerializerImpl :

Module Contents

SerializerImpl()

<

*

>

.

serialize

(

)

:

JsonArray

>

T

.

serialize

(

)

:

JsonObject

<

*

,

*

>

.

serialize

(

)

:

JsonObject

class ServiceException :

ResponseCodeException

Module Contents

ServiceException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

interface SwaggerAuthHandler

Module Contents

abstract fun createAuthHandlers(roles:

)

:

object SwaggerMerger

Module Contents

fun mergeAllInDirectory(path:

)

:

OpenAPI

?

data class SwaggerRoute

Module Contents

SwaggerRoute(verb: HttpMethod, path:

,

opId

:

,

op

:

Operation

,

authRoles

:

,

swaggerFile

:

OpenAPI

,

swaggerCache

:

ResolverCache

)

val op: Operation

val swaggerCache: ResolverCache

val swaggerFile: OpenAPI

val verb: HttpMethod

class SwaggerRouteBuilder

Module Contents

SwaggerRouteBuilder(verb: HttpMethod? = null, path:

?

=

,

opId

:

?

=

,

op

:

Operation

?

=

,

authRoles

:

?

=

,

file

:

OpenAPI

?

=

,

cache

:

ResolverCache

?

=

)

?

var cache: ResolverCache?

var file: OpenAPI?

var op: Operation?

?

?

var verb: HttpMethod?

class SwaggerRouter

Module Contents

SwaggerRouter(swaggerAuthHandler:

SwaggerAuthHandler

,

swaggerServiceHandler

:

SwaggerServiceHandler

,

traverser

:

SwaggerTraverser

)

fun build(swaggerAuthHandler:

SwaggerAuthHandler

,

controllerSupplier

:

ControllerSupplier

,

serializer

:

,

deserializer

:

)

:

fun route(router: Router, swaggerFile: OpenAPI):

class SwaggerServiceHandler :

,

Module Contents

SwaggerServiceHandler(controllerSupplier:

ControllerSupplier

,

serializer

:

,

deserializer

:

)

fun createFailureHandlers():

fun createServiceHandlers(op: Operation, opId:

)

:

class SwaggerTraverser

Module Contents

SwaggerTraverser()

fun traverseSwaggerFile(swaggerFile: OpenAPI, specifyRoute: (

)

->

)

:

@Target([AnnotationTarget.FUNCTION]) annotation class Timeout

Module Contents

Timeout(length:

=

)

class TimeoutException :

ResponseCodeException

Module Contents

TimeoutException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

class TooManyRequestsException :

ResponseCodeException

Module Contents

TooManyRequestsException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

open class TypeWrapper<T>

Module Contents

class UnavailableException :

ResponseCodeException

Module Contents

UnavailableException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

interface UpdateQuery<T :

,

R

:

>

Module Contents

,

reified

R

:

>

impl

(

schema

:

,

table

:

)

:

<

T

,

R

>

abstract suspend fun update(id:

,

toUpdate

:

T

,

connection

:

SqlClient

)

:

R

class UpdateQueryImpl<T :

,

R

:

>

:

<

T

,

R

>

,

,

Module Contents

UpdateQueryImpl(schema:

,

table

:

,

type

:

<

R

>

,

serializer

:

,

deserializer

:

)

suspend fun update(id:

,

toUpdate

:

T

,

connection

:

SqlClient

)

:

R

class VertxKuickstartException :

Module Contents

VertxKuickstartException(message:

)

VertxKuickstartException(message:

,

cause

:

)

package dev.fuelyour.vertxkuickstartcore.annotations

Module Contents

@Target([AnnotationTarget.FUNCTION]) annotation class Timeout

Module Contents

Timeout(length:

=

)

package dev.fuelyour.vertxkuickstartcore.config

Module Contents

io.vertx.core.Vertx

Module Contents

fun Vertx.config(): JsonObject

package dev.fuelyour.vertxkuickstartcore.exceptions

Module Contents

class AuthorizationException :

ResponseCodeException

Module Contents

AuthorizationException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

class BadRequestException :

ResponseCodeException

Module Contents

BadRequestException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

class ConflictException :

ResponseCodeException

Module Contents

ConflictException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

class ForbiddenException :

ResponseCodeException

Module Contents

ForbiddenException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

enum class HTTPStatusCode

Module Contents

GATEWAY_TIMEOUT

PAYMENT_REQUIRED

PERMANENT_REDIRECT

TOO_MANY_REQUESTS

class ModelNotFoundException :

ResponseCodeException

Module Contents

ModelNotFoundException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

open class ResponseCodeException :

RuntimeException

Module Contents

ResponseCodeException(message:

=

,

details

:

JsonArray

=

,

statusCode

:

=

,

throwable

:

?

=

)

fun asJson(): JsonObject

val details: JsonArray

fun fromStatusCode(statusCode:

?

,

errorMessage

:

,

details

:

JsonArray

)

:

ResponseCodeException

val statusCode:

class ServiceException :

ResponseCodeException

Module Contents

ServiceException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

class TimeoutException :

ResponseCodeException

Module Contents

TimeoutException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

class TooManyRequestsException :

ResponseCodeException

Module Contents

TooManyRequestsException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

class UnavailableException :

ResponseCodeException

Module Contents

UnavailableException(message:

=

,

details

:

JsonArray

=

,

throwable

:

?

=

)

class VertxKuickstartException :

Module Contents

VertxKuickstartException(message:

)

VertxKuickstartException(message:

,

cause

:

)

package dev.fuelyour.vertxkuickstartcore.migrations

Module Contents

fun migrate(dbConfig: JsonObject):

package dev.fuelyour.vertxkuickstartcore.repositories

Module Contents

interface AllQuery<T :

>

Module Contents

abstract suspend fun all(connection: SqlClient):

<

T

>

fun <reified T :

>

impl

(

schema

:

,

table

:

)

:

<

T

>

class AllQueryImpl<T :

>

:

<

T

>

,

Module Contents

AllQueryImpl(schema:

,

table

:

,

type

:

<

T

>

,

deserializer

:

)

suspend fun all(connection: SqlClient):

<

T

>

interface DeleteQuery

Module Contents

abstract suspend fun delete(id:

,

connection

:

SqlClient

)

:

fun impl(schema:

,

table

:

)

:

class DeleteQueryImpl :

Module Contents

DeleteQueryImpl(schema:

,

table

:

)

suspend fun delete(id:

,

connection

:

SqlClient

)

:

interface FindQuery<T :

>

Module Contents

abstract suspend fun find(id:

,

connection

:

SqlClient

)

:

T

fun <reified T :

>

impl

(

schema

:

,

table

:

)

:

<

T

>

class FindQueryImpl<T :

>

:

<

T

>

,

Module Contents

FindQueryImpl(schema:

,

table

:

,

type

:

<

T

>

,

deserializer

:

)

suspend fun find(id:

,

connection

:

SqlClient

)

:

T

interface InsertQuery<T :

,

R

:

>

Module Contents

,

reified

R

:

>

impl

(

schema

:

,

table

:

)

:

<

T

,

R

>

abstract suspend fun insert(toInsert: T, connection: SqlClient): R

class InsertQueryImpl<T :

,

R

:

>

:

<

T

,

R

>

,

,

Module Contents

InsertQueryImpl(schema:

,

table

:

,

type

:

<

R

>

,

serializer

:

,

deserializer

:

)

suspend fun insert(toInsert: T, connection: SqlClient): R

interface UpdateQuery<T :

,

R

:

>

Module Contents

,

reified

R

:

>

impl

(

schema

:

,

table

:

)

:

<

T

,

R

>

abstract suspend fun update(id:

,

toUpdate

:

T

,

connection

:

SqlClient

)

:

R

class UpdateQueryImpl<T :

,

R

:

>

:

<

T

,

R

>

,

,

Module Contents

UpdateQueryImpl(schema:

,

table

:

,

type

:

<

R

>

,

serializer

:

,

deserializer

:

)

suspend fun update(id:

,

toUpdate

:

T

,

connection

:

SqlClient

)

:

R

package dev.fuelyour.vertxkuickstartcore.tools

Module Contents

>

T

.

applyPatch

(

patch

:

)

:

T

interface ControllerSupplier

Module Contents

abstract fun getControllerInstance(controllerName:

)

:

class DatabaseAccess

Module Contents

DatabaseAccess(config: JsonObject, vertx: Vertx)

suspend fun <T :

>

getConnection

(

dbAction

:

suspend

(

SqlClient

)

->

T

?

)

:

T

suspend fun <T :

>

getTransaction

(

dbAction

:

suspend

(

SqlClient

)

->

T

?

)

:

T

interface Deserializer

Module Contents

abstract fun <T :

>

<

T

>

.

instantiate

(

json

:

JsonObject

?

)

:

T

?

.

instantiate

(

json

:

JsonObject

?

)

:

?

abstract fun <T :

>

<

T

>

.

instantiate

(

arr

:

JsonArray

?

)

:

T

?

.

instantiate

(

arr

:

JsonArray

?

)

:

?

class DeserializerImpl :

Module Contents

DeserializerImpl()

>

<

T

>

.

instantiate

(

json

:

JsonObject

?

)

:

T

?

.

instantiate

(

json

:

JsonObject

?

)

:

?

>

<

T

>

.

instantiate

(

arr

:

JsonArray

?

)

:

T

?

.

instantiate

(

arr

:

JsonArray

?

)

:

?

.

instantiate

(

json

:

JsonObject

?

,

genericsMap

:

<

,

>

)

:

?

data class Field<T>

Module Contents

Field(value: T?, present:

)

class FullParameter

Module Contents

<

*

>

<

*

>

class FullType<T>

Module Contents

io.vertx.core.json.JsonArray

Module Contents

operator fun JsonArray.minus(other: JsonArray): JsonArray

operator fun JsonArray.minus(item:

?

)

:

JsonArray

operator fun JsonArray.minus(index:

)

:

JsonArray

operator fun JsonArray.plus(other: JsonArray): JsonArray

operator fun JsonArray.plus(item:

?

)

:

JsonArray

io.vertx.core.json.JsonObject

Module Contents

operator fun JsonObject.minus(key:

)

:

JsonObject

operator fun JsonObject.minus(keys:

<

>

)

:

JsonObject

operator fun JsonObject.plus(other: JsonObject): JsonObject

operator fun JsonObject.plus(pair:

<

,

*

>

)

:

JsonObject

class JwtAuthHelper :

SwaggerAuthHandler

Module Contents

JwtAuthHelper(config: JsonObject, vertx: Vertx)

fun authenticateUserRoles(requiredRoles:

,

userRoles

:

JsonArray

)

:

fun createAuthHandlers(roles:

)

:

val EXPIRATION_MILLIS:

fun generateToken(json: JsonObject):

fun isTokenExpired(created:

)

:

kotlin.reflect.KFunction

Module Contents

<

*

>

.

fullParameters

:

<

>

data class PositionalSql

Module Contents

PositionalSql(sql:

,

params

:

Tuple

)

val params: Tuple

data class PreparedPositionalSql

Module Contents

PreparedPositionalSql(sql:

,

paramNames

:

<

>

,

convertParams

:

(

params

:

<

,

?

>

)

->

Tuple

)

val convertParams: (params:

<

,

?

>

)

->

Tuple

val paramNames:

<

>

fun toPositional(params:

<

,

?

>

)

:

fun preparePositional(sql:

,

paramNames

:

<

>

?

=

)

:

PreparedPositionalSql

typealias Roles =

<

,

<

>

>

typealias RouteHandlers =

<

Handler

<

RoutingContext

>

>

interface Serializer

Module Contents

<

*

>

.

serialize

(

)

:

JsonArray

abstract fun <T :

>

T

.

serialize

(

)

:

JsonObject

<

*

,

*

>

.

serialize

(

)

:

JsonObject

class SerializerImpl :

Module Contents

SerializerImpl()

<

*

>

.

serialize

(

)

:

JsonArray

>

T

.

serialize

(

)

:

JsonObject

<

*

,

*

>

.

serialize

(

)

:

JsonObject

interface SwaggerAuthHandler

Module Contents

abstract fun createAuthHandlers(roles:

)

:

object SwaggerMerger

Module Contents

fun mergeAllInDirectory(path:

)

:

OpenAPI

?

data class SwaggerRoute

Module Contents

SwaggerRoute(verb: HttpMethod, path:

,

opId

:

,

op

:

Operation

,

authRoles

:

,

swaggerFile

:

OpenAPI

,

swaggerCache

:

ResolverCache

)

val op: Operation

val swaggerCache: ResolverCache

val swaggerFile: OpenAPI

val verb: HttpMethod

class SwaggerRouteBuilder

Module Contents

SwaggerRouteBuilder(verb: HttpMethod? = null, path:

?

=

,

opId

:

?

=

,

op

:

Operation

?

=

,

authRoles

:

?

=

,

file

:

OpenAPI

?

=

,

cache

:

ResolverCache

?

=

)

?

var cache: ResolverCache?

var file: OpenAPI?

var op: Operation?

?

?

var verb: HttpMethod?

class SwaggerRouter

Module Contents

SwaggerRouter(swaggerAuthHandler:

SwaggerAuthHandler

,

swaggerServiceHandler

:

SwaggerServiceHandler

,

traverser

:

SwaggerTraverser

)

fun build(swaggerAuthHandler:

SwaggerAuthHandler

,

controllerSupplier

:

ControllerSupplier

,

serializer

:

,

deserializer

:

)

:

fun route(router: Router, swaggerFile: OpenAPI):

class SwaggerServiceHandler :

,

Module Contents

SwaggerServiceHandler(controllerSupplier:

ControllerSupplier

,

serializer

:

,

deserializer

:

)

fun createFailureHandlers():

fun createServiceHandlers(op: Operation, opId:

)

:

class SwaggerTraverser

Module Contents

SwaggerTraverser()

fun traverseSwaggerFile(swaggerFile: OpenAPI, specifyRoute: (

)

->

)

:

fun toPositional(sql:

,

params

:

<

,

?

>

)

:

fun <reified T> type():

<

T

>

fun <T> type(typeWrapperClass:

<

out

<

T

>

>

)

:

<

T

>

open class TypeWrapper<T>

Module Contents