ph.com.nightowlstudios.core

Class ApplicationVerticle

java.lang.Object

io.vertx.core.AbstractVerticle

ph.com.nightowlstudios.core.ApplicationVerticle

All Implemented Interfaces:

io.vertx.core.Verticle

public abstract class ApplicationVerticle
extends io.vertx.core.AbstractVerticle

Since:

7/14/20

Author:

Joseph Harvey Angeles - @yev

Field Summary

Fields inherited from class io.vertx.core.AbstractVerticle

context, vertx

Constructor Summary

Constructors

Constructor and Description
ApplicationVerticle()

Method Summary

Modifier and Type	Method and Description
protected List<io.vertx.ext.bridge.PermittedOptions>	addInboundSocketRules()
protected List<io.vertx.ext.bridge.PermittedOptions>	addOutboundSocketRules()
protected boolean	allowCORSCredentials()
protected Set<String>	allowedHeaders()
protected Set<io.vertx.core.http.HttpMethod>	allowedMethods()
protected String	apiPrefix()
protected String	appName()
protected String	bannerText()
protected void	beforeRouterCreate(io.vertx.ext.web.Router router) Called immediately after Router creation.
protected io.vertx.core.Handler<io.vertx.ext.web.RoutingContext>	createRouteFailureHandler()
protected io.vertx.core.Handler<io.vertx.ext.web.RoutingContext>	createRouteLogHandler()
protected Set<String>	exposedHeaders()
protected abstract <R extends Resource> Class<R>[]	getResourceClasses()
protected void	onStart(io.vertx.core.http.HttpServer httpServer) Called when the HttpServer has been started.
protected void	onStartFail(Throwable error) Called when the HttpServer failed to start
protected <T extends Service> void	registerService(Class<T>... services)
protected <T extends Service> void	registerService(Class<T> service, io.vertx.core.DeploymentOptions options)
abstract void	setup() This is the very first method to be called when launching the main verticle.
protected void	setupRoutes(io.vertx.ext.web.Router apiRouter) Called before mounting API subrouter.
void	start(io.vertx.core.Promise<Void> startPromise)
protected String	version()
protected String	webSocketPrefix()

Methods inherited from class io.vertx.core.AbstractVerticle

config, deploymentID, getVertx, init, processArgs, start, stop, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationVerticle

public ApplicationVerticle()

Method Detail

start

public void start(io.vertx.core.Promise<Void> startPromise)

Specified by:

start in interface io.vertx.core.Verticle

Overrides:

start in class io.vertx.core.AbstractVerticle

setup

public abstract void setup()

This is the very first method to be called when launching the main verticle. This is where Service verticles should be registered using any of the registerService(Class[]) An Http server verticle is also automatically internally registered to Http requests.

See Also:

Service

registerService

protected <T extends Service> void registerService(Class<T>... services)

registerService

protected <T extends Service> void registerService(Class<T> service,
                                                   io.vertx.core.DeploymentOptions options)

beforeRouterCreate

protected void beforeRouterCreate(io.vertx.ext.web.Router router)

Called immediately after Router creation.

Parameters:

router - the root router

setupRoutes

protected void setupRoutes(io.vertx.ext.web.Router apiRouter)

Called before mounting API subrouter.

Parameters:

apiRouter - api subrouter

onStart

protected void onStart(io.vertx.core.http.HttpServer httpServer)

Called when the HttpServer has been started.

Parameters:

httpServer - the started server

onStartFail

protected void onStartFail(Throwable error)

Called when the HttpServer failed to start

Parameters:

error - cause of the failure

appName

protected final String appName()

version

protected final String version()

allowCORSCredentials

protected boolean allowCORSCredentials()

allowedMethods

protected Set<io.vertx.core.http.HttpMethod> allowedMethods()

allowedHeaders

protected Set<String> allowedHeaders()

exposedHeaders

protected Set<String> exposedHeaders()

apiPrefix

protected String apiPrefix()

webSocketPrefix

protected String webSocketPrefix()

bannerText

protected String bannerText()

createRouteLogHandler

protected io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> createRouteLogHandler()

createRouteFailureHandler

protected io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> createRouteFailureHandler()

getResourceClasses

protected abstract <R extends Resource> Class<R>[] getResourceClasses()

addInboundSocketRules

protected List<io.vertx.ext.bridge.PermittedOptions> addInboundSocketRules()

addOutboundSocketRules

protected List<io.vertx.ext.bridge.PermittedOptions> addOutboundSocketRules()