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`	`rootPath`
`private final String`	`authenticatePath`
`private final String`	`logoutPath`
`private final String`	`healthcheckPath`
`private final String`	`readinesscheckPath`
`private final String`	`livenesscheckPath`
`private final String`	`organization`
`private final TockUser`	`user`
`private final String`	`userLogin`
`public final static WebVerticle.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`WebVerticle()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`KLogger`	`getLogger()`
`final Router`	`getRouter()`
`String`	`getBasePath()`
`String`	`getRootPath()`
`String`	`getAuthenticatePath()`
`String`	`getLogoutPath()`
`String`	`getHealthcheckPath()`
`String`	`getReadinesscheckPath()`
`String`	`getLivenesscheckPath()`
`final String`	`getOrganization(RoutingContext $self)`
`final TockUser`	`getUser(RoutingContext $self)`
`final String`	`getUserLogin(RoutingContext $self)`
`abstract Unit`	`configure()`
`Function1<RoutingContext, Unit>`	`healthcheck()`
`Function1<RoutingContext, Unit>`	`defaultHealthcheck()`	Provide basic health information: mainly through HTTP status code
`Function1<RoutingContext, Unit>`	`readinesscheck()`	Provide basic readiness information: indicates whether the container is ready to respond to requests
`Function1<RoutingContext, Unit>`	`livenesscheck()`	Provide basic liveness information: indicates whether the verticle is running
`Function1<RoutingContext, Unit>`	`detailedHealthcheck()`	Provide enhanced information: HTTP response has JSON body with health status of resources
`Unit`	`start(Promise<Void> promise)`
`Unit`	`stop(Promise<Void> stopFuture)`
`final Unit`	`addAuth(TockAuthProvider authProvider, Set<String> pathsToProtect)`
`TockUserRole`	`defaultRole()`	The default role of a service.
`Set<TockUserRole>`	`defaultRoles()`	The default roles of a service.
`final Unit`	`blocking(HttpMethod method, String path, TockUserRole role, String basePath, Function1<RoutingContext, Unit> handler)`
`final Unit`	`blocking(HttpMethod method, String path, Set<TockUserRole> roles, 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, Set<TockUserRole> roles, RequestLogger logger, String basePath, Function2<RoutingContext, I, O> handler)`
`final <O extends Any> Unit`	`blockingJsonGet(String path, TockUserRole role, String basePath, Function1<RoutingContext, O> handler)`
`final <O extends Any> Unit`	`blockingJsonGet(String path, Set<TockUserRole> roles, String basePath, Function1<RoutingContext, O> handler)`
`final <I extends Any, O extends Any> Unit`	`blockingJsonPost(String path, Set<TockUserRole> roles, RequestLogger logger, String basePath, Function2<RoutingContext, I, O> handler)`
`final <I extends Any, O extends Any> Unit`	`blockingJsonPost(String path, TockUserRole role, RequestLogger logger, String basePath, Function2<RoutingContext, I, O> handler)`
`final <I extends Any, O extends Any> Unit`	`blockingJsonPut(String path, Set<TockUserRole> roles, RequestLogger logger, String basePath, Function2<RoutingContext, I, O> handler)`
`final Unit`	`blockingDeleteEmptyResponse(String path, Set<TockUserRole> roles, RequestLogger logger, String basePath, Function1<RoutingContext, Unit> handler)`
`final Unit`	`blockingDelete(String path, TockUserRole role, RequestLogger logger, String basePath, Function1<RoutingContext, Unit> handler)`
`final Unit`	`blockingDelete(String path, Set<TockUserRole> roles, RequestLogger logger, String basePath, Function1<RoutingContext, Unit> success, Function1<RoutingContext, Unit> handler)`
`final Unit`	`blockingJsonDelete(String path, Set<TockUserRole> roles, RequestLogger logger, String basePath, Function1<RoutingContext, Boolean> handler)`
`final CorsHandler`	`corsHandler(String origin, Boolean allowCredentials, Set<HttpMethod> allowedMethods, Set<String> allowedHeaders)`
`final CorsHandler`	`corsHandler(List<String> origins, 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`	`successEmpty(RoutingContext $self)`
`final Unit`	`success(RoutingContext $self)`
`final Unit`	`endJson(RoutingContext $self, Boolean success)`
`final Unit`	`endJson(RoutingContext $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.

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

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

Method Detail

getLogger
```
 KLogger getLogger()
```

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

getBasePath
```
 String getBasePath()
```

getRootPath
```
 String getRootPath()
```

getAuthenticatePath
```
 String getAuthenticatePath()
```

getLogoutPath
```
 String getLogoutPath()
```

getHealthcheckPath
```
 String getHealthcheckPath()
```

getReadinesscheckPath
```
 String getReadinesscheckPath()
```

getLivenesscheckPath
```
 String getLivenesscheckPath()
```

getOrganization

 final String getOrganization(RoutingContext $self)

getUser

 final TockUser getUser(RoutingContext $self)

getUserLogin

 final String getUserLogin(RoutingContext $self)

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

healthcheck

 Function1<RoutingContext, Unit> healthcheck()

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

readinesscheck
```
 Function1<RoutingContext, Unit> readinesscheck()
```
Provide basic readiness information: indicates whether the container is ready to respond to requests

livenesscheck
```
 Function1<RoutingContext, Unit> livenesscheck()
```
Provide basic liveness information: indicates whether the verticle is running

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(Promise<Void> stopFuture)
```

addAuth

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

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

defaultRoles
```
 Set<TockUserRole> defaultRoles()
```
The default roles of a service.

blocking

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

blocking

 final Unit blocking(HttpMethod method, String path, Set<TockUserRole> roles, 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, Set<TockUserRole> roles, RequestLogger logger, String basePath, Function2<RoutingContext, I, O> handler)

blockingJsonGet

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

blockingJsonGet

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

blockingJsonPost

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

blockingJsonPost

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

blockingJsonPut

 final <I extends Any, O extends Any> Unit blockingJsonPut(String path, Set<TockUserRole> roles, RequestLogger logger, String basePath, Function2<RoutingContext, I, O> handler)

blockingDeleteEmptyResponse

 final Unit blockingDeleteEmptyResponse(String path, Set<TockUserRole> roles, RequestLogger logger, String basePath, Function1<RoutingContext, Unit> handler)

blockingDelete

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

blockingDelete

 final Unit blockingDelete(String path, Set<TockUserRole> roles, RequestLogger logger, String basePath, Function1<RoutingContext, Unit> success, Function1<RoutingContext, Unit> handler)

blockingJsonDelete

 final Unit blockingJsonDelete(String path, Set<TockUserRole> roles, RequestLogger logger, String basePath, Function1<RoutingContext, Boolean> handler)

corsHandler

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

corsHandler

 final CorsHandler corsHandler(List<String> origins, 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)

successEmpty

 final Unit successEmpty(RoutingContext $self)

success

 final Unit success(RoutingContext $self)

endJson

 final Unit endJson(RoutingContext $self, Boolean success)

endJson

 final Unit endJson(RoutingContext $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

Class WebVerticle

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class io.vertx.core.AbstractVerticle

Methods inherited from class java.lang.Object

Constructor Detail

WebVerticle

Method Detail

getLogger

getRouter

getBasePath

getRootPath

getAuthenticatePath

getLogoutPath

getHealthcheckPath

getReadinesscheckPath

getLivenesscheckPath

getOrganization

getUser

getUserLogin

configure

healthcheck

defaultHealthcheck

readinesscheck

livenesscheck

detailedHealthcheck

start

stop

addAuth

defaultRole

defaultRoles

blocking

blocking

isAuthorized

blockingWithBodyJson

blockingJsonGet

blockingJsonGet

blockingJsonPost

blockingJsonPost

blockingJsonPut

blockingDeleteEmptyResponse

blockingDelete

blockingDelete

blockingJsonDelete

corsHandler

corsHandler

readJson

readJson

readBytes

readString

successEmpty

success

endJson

endJson

path

pathToLocale

pathId

firstQueryParam

queryId

defaultErrorHandler