All Implemented Interfaces:

io.vertx.core.Verticle
```
public abstract class WebVerticle
extends AbstractVerticle
                    
```
Base class for web Tock io.vertx.core.Verticles. Provides utility methods.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`WebVerticle.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final KLogger`	`logger`
`private final Router`	`router`
`private final String`	`basePath`
`private final String`	`authenticatePath`
`private final String`	`logoutPath`
`private final String`	`healthcheckPath`
`private final String`	`organization`
`private final TockUser`	`user`
`private final String`	`userLogin`
`private final Vertx`	`vertx`
`private final Context`	`context`

Constructor Summary

Constructors
Constructor	Description
`WebVerticle()`

Method Summary

Modifier and Type	Method	Description
`abstract Unit`	`configure()`
`Function1<RoutingContext, Unit>`	`healthcheck()`
`Function1<RoutingContext, Unit>`	`defaultHealthcheck()`	Provide basic health information: mainly through HTTP status code
`Function1<RoutingContext, Unit>`	`detailedHealthcheck()`	Provide enhanced information: HTTP response has JSON body with health status of resources
`Unit`	`start(Promise<Void> promise)`
`Unit`	`stop(Future<Void> stopFuture)`
`final Unit`	`addAuth(TockAuthProvider authProvider, Set<String> pathsToProtect)`
`TockUserRole`	`defaultRole()`	The default role of a service.
`final Unit`	`blocking(HttpMethod method, String path, TockUserRole role, String basePath, Function1<RoutingContext, Unit> handler)`
`final Object`	`isAuthorized(RoutingContext $self, TockUserRole role, Function1<AsyncResult<Boolean>, Unit> resultHandler)`
`final <I extends Any, O extends Any> Unit`	`blockingWithBodyJson(HttpMethod method, String path, TockUserRole role, RequestLogger logger, Function2<RoutingContext, I, O> handler)`
`final <O extends Any> Unit`	`blockingJsonGet(String path, TockUserRole role, Function1<RoutingContext, O> handler)`
`final <I extends Any, O extends Any> Unit`	`blockingJsonPost(String path, TockUserRole role, RequestLogger logger, Function2<RoutingContext, I, O> handler)`
`final Unit`	`blockingDelete(String path, TockUserRole role, RequestLogger logger, Function1<RoutingContext, Unit> handler)`
`final CorsHandler`	`corsHandler(String origin, Boolean allowCredentials, Set<HttpMethod> allowedMethods, Set<String> allowedHeaders)`
`final <T extends Any> T`	`readJson(RoutingContext $self)`
`final <T extends Any> T`	`readJson(FileUpload upload)`
`final ByteArray`	`readBytes(FileUpload upload)`
`final String`	`readString(FileUpload upload)`
`final Unit`	`success(RoutingContext $self)`
`final Unit`	`endJson(RoutingContext $self, Boolean success)`
`final Unit`	`endJson(RoutingContext $self, Object result)`
`final Unit`	`endJson(HttpServerResponse $self, Object result)`
`final String`	`path(RoutingContext $self, String name)`
`final Locale`	`pathToLocale(RoutingContext $self, String name)`
`final <T extends Any> Id<T>`	`pathId(RoutingContext $self, String name)`
`final String`	`firstQueryParam(RoutingContext $self, String name)`
`final <T extends Any> Id<T>`	`queryId(RoutingContext $self, String name)`
`Handler<RoutingContext>`	`defaultErrorHandler(Integer statusCode)`	The error handler for match failures.
`KLogger`	`getLogger()`
`final Router`	`getRouter()`
`String`	`getBasePath()`
`String`	`getAuthenticatePath()`
`String`	`getLogoutPath()`
`String`	`getHealthcheckPath()`
`final String`	`getOrganization(RoutingContext $self)`
`final TockUser`	`getUser(RoutingContext $self)`
`final String`	`getUserLogin(RoutingContext $self)`

Methods inherited from class ai.tock.shared.vertx.WebVerticle
config, deploymentID, getVertx, init, processArgs, start, start, stop
Methods inherited from class io.vertx.core.AbstractVerticle
stop
Methods inherited from class io.vertx.core.Verticle
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- WebVerticle
```
WebVerticle()
```

Method Detail

configure
```
 abstract Unit configure()
```

healthcheck

 Function1<RoutingContext, Unit> healthcheck()

defaultHealthcheck
```
 Function1<RoutingContext, Unit> defaultHealthcheck()
```
Provide basic health information: mainly through HTTP status code

detailedHealthcheck
```
 Function1<RoutingContext, Unit> detailedHealthcheck()
```
Provide enhanced information: HTTP response has JSON body with health status of resources

start
```
 Unit start(Promise<Void> promise)
```

stop
```
 Unit stop(Future<Void> stopFuture)
```

addAuth

 final Unit addAuth(TockAuthProvider authProvider, Set<String> pathsToProtect)

defaultRole
```
 TockUserRole defaultRole()
```
The default role of a service.

blocking

 final Unit blocking(HttpMethod method, String path, TockUserRole role, String basePath, Function1<RoutingContext, Unit> handler)

isAuthorized

 final Object isAuthorized(RoutingContext $self, TockUserRole role, Function1<AsyncResult<Boolean>, Unit> resultHandler)

blockingWithBodyJson

 final <I extends Any, O extends Any> Unit blockingWithBodyJson(HttpMethod method, String path, TockUserRole role, RequestLogger logger, Function2<RoutingContext, I, O> handler)

blockingJsonGet

 final <O extends Any> Unit blockingJsonGet(String path, TockUserRole role, Function1<RoutingContext, O> handler)

blockingJsonPost

 final <I extends Any, O extends Any> Unit blockingJsonPost(String path, TockUserRole role, RequestLogger logger, Function2<RoutingContext, I, O> handler)

blockingDelete

 final Unit blockingDelete(String path, TockUserRole role, RequestLogger logger, Function1<RoutingContext, Unit> handler)

corsHandler

 final CorsHandler corsHandler(String origin, Boolean allowCredentials, Set<HttpMethod> allowedMethods, Set<String> allowedHeaders)

readJson

 final <T extends Any> T readJson(RoutingContext $self)

readJson

 final <T extends Any> T readJson(FileUpload upload)

readBytes

 final ByteArray readBytes(FileUpload upload)

readString

 final String readString(FileUpload upload)

success

 final Unit success(RoutingContext $self)

endJson

 final Unit endJson(RoutingContext $self, Boolean success)

endJson

 final Unit endJson(RoutingContext $self, Object result)

endJson

 final Unit endJson(HttpServerResponse $self, Object result)

path

 final String path(RoutingContext $self, String name)

pathToLocale

 final Locale pathToLocale(RoutingContext $self, String name)

pathId

 final <T extends Any> Id<T> pathId(RoutingContext $self, String name)

firstQueryParam

 final String firstQueryParam(RoutingContext $self, String name)

queryId

 final <T extends Any> Id<T> queryId(RoutingContext $self, String name)

defaultErrorHandler
```
 Handler<RoutingContext> defaultErrorHandler(Integer statusCode)
```
The error handler for match failures. See https://vertx.io/docs/vertx-web/java/#_route_match_failures

getLogger
```
 KLogger getLogger()
```

getRouter
```
 final Router getRouter()
```

getBasePath
```
 String getBasePath()
```

getAuthenticatePath
```
 String getAuthenticatePath()
```

getLogoutPath
```
 String getLogoutPath()
```

getHealthcheckPath
```
 String getHealthcheckPath()
```

getOrganization

 final String getOrganization(RoutingContext $self)

getUser

 final TockUser getUser(RoutingContext $self)

getUserLogin

 final String getUserLogin(RoutingContext $self)

Class WebVerticle

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ai.tock.shared.vertx.WebVerticle

Methods inherited from class io.vertx.core.AbstractVerticle

Methods inherited from class io.vertx.core.Verticle

Methods inherited from class java.lang.Object

Constructor Detail

WebVerticle

Method Detail

configure

healthcheck

defaultHealthcheck

detailedHealthcheck

start

stop

addAuth

defaultRole

blocking

isAuthorized

blockingWithBodyJson

blockingJsonGet

blockingJsonPost

blockingDelete

corsHandler

readJson

readJson

readBytes

readString

success

endJson

endJson

endJson

path

pathToLocale

pathId

firstQueryParam

queryId

defaultErrorHandler

getLogger

getRouter

getBasePath

getAuthenticatePath

getLogoutPath

getHealthcheckPath

getOrganization

getUser

getUserLogin