ai.tock.shared.vertx

Class WebVerticle

ai.tock.shared.vertx.WebVerticle

public class WebVerticle

Base class for web Tock io.vertx.core.Verticles. Provides utility methods.

Field Detail

Companion

public static ai.tock.shared.vertx.WebVerticle.Companion Companion

Constructor Detail

WebVerticle

public WebVerticle()

Base class for web Tock io.vertx.core.Verticles. Provides utility methods.

Method Detail

getLogger

@NotNull
public mu.KLogger getLogger()

getRouter

@NotNull
public io.vertx.ext.web.Router getRouter()

getServer

@NotNull
protected io.vertx.core.http.HttpServer getServer()

getBasePath

@NotNull
public java.lang.String getBasePath()

getRootPath

@NotNull
protected java.lang.String getRootPath()

getAuthenticatePath

@NotNull
public java.lang.String getAuthenticatePath()

getLogoutPath

@NotNull
public java.lang.String getLogoutPath()

getHealthcheckPath

@Nullable
public java.lang.String getHealthcheckPath()

If not null, add a healthcheck for this verticle.

See Also:

healthcheck

protectedPaths

@NotNull
protected java.util.Set<java.lang.String> protectedPaths()

configure

public void configure()

healthcheck

@NotNull
public kotlin.jvm.functions.Function1<io.vertx.ext.web.RoutingContext,kotlin.Unit> healthcheck()

defaultHealthcheck

@NotNull
public kotlin.jvm.functions.Function1<io.vertx.ext.web.RoutingContext,kotlin.Unit> defaultHealthcheck()

Provide basic health information: mainly through HTTP status code

detailedHealthcheck

@NotNull
public kotlin.jvm.functions.Function1<io.vertx.ext.web.RoutingContext,kotlin.Unit> detailedHealthcheck()

Provide enhanced information: HTTP response has JSON body with health status of resources

start

public void start(@NotNull
                  io.vertx.core.Promise<java.lang.Void> promise)

stop

public void stop(@Nullable
                 io.vertx.core.Future<java.lang.Void> stopFuture)

addAuth

public void addAuth(@NotNull
                    TockAuthProvider authProvider,
                    @NotNull
                    java.util.Set<java.lang.String> pathsToProtect)

defaultAuthProvider

@NotNull
protected TockAuthProvider defaultAuthProvider()

The auth provider provided by default.

authProvider

@Nullable
protected TockAuthProvider authProvider()

By default there is no auth provider - ie nothing is protected.

defaultRole

@Nullable
public TockUserRole defaultRole()

The default role of a service.

getDefaultPort

protected int getDefaultPort()

The default port of the verticle

startServer

protected void startServer(@NotNull
                           io.vertx.core.Promise<java.lang.Void> promise)

startServer

protected void startServer(@NotNull
                           io.vertx.core.Promise<java.lang.Void> promise,
                           int port)

verticleIntProperty

protected int verticleIntProperty(@NotNull
                                  java.lang.String propertyName,
                                  int defaultValue)

verticleLongProperty

protected long verticleLongProperty(@NotNull
                                    java.lang.String propertyName,
                                    long defaultValue)

verticleBooleanProperty

protected boolean verticleBooleanProperty(@NotNull
                                          java.lang.String propertyName,
                                          boolean defaultValue)

verticleProperty

@NotNull
protected java.lang.String verticleProperty(@NotNull
                                                     java.lang.String propertyName,
                                                     @NotNull
                                                     java.lang.String defaultValue)

register

protected void register(@NotNull
                        io.vertx.core.http.HttpMethod method,
                        @NotNull
                        java.lang.String path,
                        @Nullable
                        TockUserRole role,
                        @NotNull
                        java.lang.String basePath,
                        @NotNull
                        kotlin.jvm.functions.Function1<? super io.vertx.ext.web.RoutingContext,kotlin.Unit> handler)

blocking

public void blocking(@NotNull
                     io.vertx.core.http.HttpMethod method,
                     @NotNull
                     java.lang.String path,
                     @Nullable
                     TockUserRole role,
                     @NotNull
                     java.lang.String basePath,
                     @NotNull
                     kotlin.jvm.functions.Function1<? super io.vertx.ext.web.RoutingContext,kotlin.Unit> handler)

isAuthorized

@NotNull
public java.lang.Object isAuthorized(@NotNull
                                              io.vertx.ext.web.RoutingContext $this$isAuthorized,
                                              @NotNull
                                              TockUserRole role,
                                              @NotNull
                                              kotlin.jvm.functions.Function1<? super io.vertx.core.AsyncResult<java.lang.Boolean>,kotlin.Unit> resultHandler)

blockingJsonGet

public <O> void blockingJsonGet(@NotNull
                                java.lang.String path,
                                @Nullable
                                TockUserRole role,
                                @NotNull
                                kotlin.jvm.functions.Function1<? super io.vertx.ext.web.RoutingContext,? extends O> handler)

blockingPost

protected void blockingPost(@NotNull
                            java.lang.String path,
                            @Nullable
                            TockUserRole role,
                            @NotNull
                            RequestLogger logger,
                            @NotNull
                            kotlin.jvm.functions.Function1<? super io.vertx.ext.web.RoutingContext,kotlin.Unit> handler)

blockingGet

protected void blockingGet(@NotNull
                           java.lang.String path,
                           @Nullable
                           TockUserRole role,
                           @NotNull
                           java.lang.String basePath,
                           @NotNull
                           kotlin.jvm.functions.Function1<? super io.vertx.ext.web.RoutingContext,java.lang.String> handler)

blockingUploadPost

protected <O> void blockingUploadPost(@NotNull
                                      java.lang.String path,
                                      @Nullable
                                      TockUserRole role,
                                      @NotNull
                                      RequestLogger logger,
                                      @NotNull
                                      kotlin.jvm.functions.Function2<? super io.vertx.ext.web.RoutingContext,? super java.lang.String,? extends O> handler)

blockingUploadBinaryPost

protected <O> void blockingUploadBinaryPost(@NotNull
                                            java.lang.String path,
                                            @Nullable
                                            TockUserRole role,
                                            @NotNull
                                            kotlin.jvm.functions.Function2<? super io.vertx.ext.web.RoutingContext,? super kotlin.Pair<java.lang.String,byte[]>,? extends O> handler)

blockingDelete

public void blockingDelete(@NotNull
                           java.lang.String path,
                           @Nullable
                           TockUserRole role,
                           @NotNull
                           RequestLogger logger,
                           @NotNull
                           kotlin.jvm.functions.Function1<? super io.vertx.ext.web.RoutingContext,kotlin.Unit> handler)

blockingJsonDelete

protected void blockingJsonDelete(@NotNull
                                  java.lang.String path,
                                  @Nullable
                                  TockUserRole role,
                                  @NotNull
                                  RequestLogger logger,
                                  @NotNull
                                  kotlin.jvm.functions.Function1<? super io.vertx.ext.web.RoutingContext,java.lang.Boolean> handler)

addDevCorsHandler

protected void addDevCorsHandler()

getDefaultCorsOrigin

@NotNull
protected java.lang.String getDefaultCorsOrigin()

Default cors origin (if tock_web_use_default_cors_handler property is set to true).

getDefaultCorsWithCredentials

protected boolean getDefaultCorsWithCredentials()

By default, allow credentials for cors origin (if tock_web_use_default_cors_handler property is set to true).

corsHandler

@NotNull
public io.vertx.ext.web.handler.CorsHandler corsHandler(@NotNull
                                                                 java.lang.String origin,
                                                                 boolean allowCredentials,
                                                                 @NotNull
                                                                 java.util.Set<? extends io.vertx.core.http.HttpMethod> allowedMethods,
                                                                 @NotNull
                                                                 java.util.Set<java.lang.String> allowedHeaders)

bodyHandler

@NotNull
protected io.vertx.ext.web.handler.BodyHandler bodyHandler()

readBytes

@NotNull
public kotlin.Array[] readBytes(@NotNull
                                         io.vertx.ext.web.FileUpload upload)

readString

@NotNull
public java.lang.String readString(@NotNull
                                            io.vertx.ext.web.FileUpload upload)

executeBlocking

protected void executeBlocking(@NotNull
                               io.vertx.ext.web.RoutingContext $this$executeBlocking,
                               @NotNull
                               kotlin.jvm.functions.Function1<? super io.vertx.ext.web.RoutingContext,kotlin.Unit> handler)

Execute blocking code using Vertx.executeBlocking.

See Also:

Vertx.executeBlocking

success

public void success(@NotNull
                    io.vertx.ext.web.RoutingContext $this$success)

endJson

public void endJson(@NotNull
                    io.vertx.ext.web.RoutingContext $this$endJson,
                    boolean success)

endJson

public void endJson(@NotNull
                    io.vertx.ext.web.RoutingContext $this$endJson,
                    @Nullable
                    java.lang.Object result)

path

@NotNull
public java.lang.String path(@NotNull
                                      io.vertx.ext.web.RoutingContext $this$path,
                                      @NotNull
                                      java.lang.String name)

pathToLocale

@NotNull
public java.util.Locale pathToLocale(@NotNull
                                              io.vertx.ext.web.RoutingContext $this$pathToLocale,
                                              @NotNull
                                              java.lang.String name)

pathId

@NotNull
public <T> org.litote.kmongo.Id<T> pathId(@NotNull
                                                   io.vertx.ext.web.RoutingContext $this$pathId,
                                                   @NotNull
                                                   java.lang.String name)

firstQueryParam

@Nullable
public java.lang.String firstQueryParam(@NotNull
                                                  io.vertx.ext.web.RoutingContext $this$firstQueryParam,
                                                  @NotNull
                                                  java.lang.String name)

queryId

@Nullable
public <T> org.litote.kmongo.Id<T> queryId(@NotNull
                                                     io.vertx.ext.web.RoutingContext $this$queryId,
                                                     @NotNull
                                                     java.lang.String name)

getOrganization

@NotNull
public java.lang.String getOrganization(@NotNull
                                                 io.vertx.ext.web.RoutingContext $this$organization)

getUser

@Nullable
public TockUser getUser(@NotNull
                                  io.vertx.ext.web.RoutingContext $this$user)

getUserLogin

@NotNull
public java.lang.String getUserLogin(@NotNull
                                              io.vertx.ext.web.RoutingContext $this$userLogin)

endJson

public void endJson(@NotNull
                    io.vertx.core.http.HttpServerResponse $this$endJson,
                    @Nullable
                    java.lang.Object result)

defaultErrorHandler

@NotNull
public io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> defaultErrorHandler(int statusCode)

The error handler for match failures. See https://vertx.io/docs/vertx-web/java/#_route_match_failures