ph.com.nightowlstudios.resource

Class Resource

java.lang.Object

ph.com.nightowlstudios.resource.Resource

public abstract class Resource
extends Object

Since:

9/12/20

Author:

Joseph Harvey Angeles - @yev

Constructor Summary

Constructors

Constructor and Description
Resource(io.vertx.ext.web.Router router)

Method Summary

Modifier and Type	Method and Description
protected io.vertx.ext.web.Route	delete(String path)
protected io.vertx.ext.web.Route	delete(String path, UserRole role)
protected void	endContext(io.vertx.ext.web.RoutingContext ctx, io.netty.handler.codec.http.HttpResponseStatus status)
protected void	endContext(io.vertx.ext.web.RoutingContext ctx, io.netty.handler.codec.http.HttpResponseStatus status, String message)
protected void	endContext(io.vertx.ext.web.RoutingContext ctx, io.vertx.core.json.JsonArray body)
protected void	endContext(io.vertx.ext.web.RoutingContext ctx, io.vertx.core.json.JsonObject body)
protected <T extends DTO> void	endContext(io.vertx.ext.web.RoutingContext ctx, List<T> list)
protected void	endContext(io.vertx.ext.web.RoutingContext ctx, Object body)
protected void	failureHandler(io.vertx.ext.web.RoutingContext ctx, Throwable cause)
protected io.vertx.ext.web.Route	get(String path)
protected io.vertx.ext.web.Route	get(String path, UserRole role)
protected <T> T	getAuthClaim(io.vertx.ext.web.RoutingContext ctx, String key)
protected <T> T	getAuthClaim(io.vertx.ext.web.RoutingContext ctx, String key, T def)
protected String	getPathParam(io.vertx.ext.web.RoutingContext ctx, String param)
protected String	getPathParam(io.vertx.ext.web.RoutingContext ctx, String param, String def)
protected String	getRequestParam(io.vertx.ext.web.RoutingContext ctx, String param)
protected String	getRequestParam(io.vertx.ext.web.RoutingContext ctx, String param, String def)
protected org.slf4j.Logger	logger()
protected <T> io.vertx.core.Future<T>	on(io.vertx.ext.web.RoutingContext ctx, io.vertx.core.Future<T> action)
protected <T> void	on(io.vertx.ext.web.RoutingContext ctx, io.vertx.core.Future<T> action, io.vertx.core.Handler<T> onSuccess)
protected <T,U> io.vertx.core.Future<List<T>>	onEach(List<T> list, Function<T,io.vertx.core.Future<U>> execute) Applies a Future execute function on each element of list.
protected io.vertx.ext.web.Route	patch(String path)
protected io.vertx.ext.web.Route	patch(String path, UserRole role)
protected io.vertx.ext.web.Route	post(String path)
protected io.vertx.ext.web.Route	post(String path, UserRole role)
protected io.vertx.ext.web.Route	protectedRoute(io.vertx.core.http.HttpMethod method, String path)
protected io.vertx.ext.web.Route	protectedRoute(io.vertx.core.http.HttpMethod method, String path, UserRole role)
protected io.vertx.ext.web.Route	put(String path)
protected io.vertx.ext.web.Route	put(String path, UserRole role)
protected io.vertx.ext.web.Route	route(io.vertx.core.http.HttpMethod method, String path)
protected io.vertx.ext.web.Router	router()
protected abstract void	routes() Define routes and their route handlers.
protected void	setUp() Executed before routes declaration.

Methods inherited from class java.lang.Object

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

Constructor Detail

Resource

public Resource(io.vertx.ext.web.Router router)

Method Detail

setUp

protected void setUp()

Executed before routes declaration. Setup services and any resource needed by route handlers inside this hook.

routes

protected abstract void routes()

Define routes and their route handlers.

logger

protected org.slf4j.Logger logger()

router

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

getPathParam

protected String getPathParam(io.vertx.ext.web.RoutingContext ctx,
                              String param)

getPathParam

protected String getPathParam(io.vertx.ext.web.RoutingContext ctx,
                              String param,
                              String def)

getRequestParam

protected String getRequestParam(io.vertx.ext.web.RoutingContext ctx,
                                 String param)

getRequestParam

protected String getRequestParam(io.vertx.ext.web.RoutingContext ctx,
                                 String param,
                                 String def)

getAuthClaim

protected <T> T getAuthClaim(io.vertx.ext.web.RoutingContext ctx,
                             String key)

getAuthClaim

protected <T> T getAuthClaim(io.vertx.ext.web.RoutingContext ctx,
                             String key,
                             T def)

route

protected io.vertx.ext.web.Route route(io.vertx.core.http.HttpMethod method,
                                       String path)

protectedRoute

protected io.vertx.ext.web.Route protectedRoute(io.vertx.core.http.HttpMethod method,
                                                String path)

protectedRoute

protected io.vertx.ext.web.Route protectedRoute(io.vertx.core.http.HttpMethod method,
                                                String path,
                                                UserRole role)

get

protected io.vertx.ext.web.Route get(String path)

get

protected io.vertx.ext.web.Route get(String path,
                                     UserRole role)

put

protected io.vertx.ext.web.Route put(String path)

put

protected io.vertx.ext.web.Route put(String path,
                                     UserRole role)

patch

protected io.vertx.ext.web.Route patch(String path)

patch

protected io.vertx.ext.web.Route patch(String path,
                                       UserRole role)

post

protected io.vertx.ext.web.Route post(String path)

post

protected io.vertx.ext.web.Route post(String path,
                                      UserRole role)

delete

protected io.vertx.ext.web.Route delete(String path)

delete

protected io.vertx.ext.web.Route delete(String path,
                                        UserRole role)

endContext

protected void endContext(io.vertx.ext.web.RoutingContext ctx,
                          io.netty.handler.codec.http.HttpResponseStatus status,
                          String message)

endContext

protected void endContext(io.vertx.ext.web.RoutingContext ctx,
                          io.netty.handler.codec.http.HttpResponseStatus status)

endContext

protected void endContext(io.vertx.ext.web.RoutingContext ctx,
                          Object body)

endContext

protected void endContext(io.vertx.ext.web.RoutingContext ctx,
                          io.vertx.core.json.JsonObject body)

endContext

protected void endContext(io.vertx.ext.web.RoutingContext ctx,
                          io.vertx.core.json.JsonArray body)

endContext

protected <T extends DTO> void endContext(io.vertx.ext.web.RoutingContext ctx,
                                          List<T> list)

on

protected <T> void on(io.vertx.ext.web.RoutingContext ctx,
                      io.vertx.core.Future<T> action,
                      io.vertx.core.Handler<T> onSuccess)

on

protected <T> io.vertx.core.Future<T> on(io.vertx.ext.web.RoutingContext ctx,
                                         io.vertx.core.Future<T> action)

failureHandler

protected void failureHandler(io.vertx.ext.web.RoutingContext ctx,
                              Throwable cause)

onEach

protected <T,U> io.vertx.core.Future<List<T>> onEach(List<T> list,
                                                     Function<T,io.vertx.core.Future<U>> execute)

Applies a Future execute function on each element of list. The Future completes until all of the functions are executed.

Type Parameters:

T - the type of elements that list holds

U - the resulting type after execute has been applied

Parameters:

list - the list to apply an execute function from.

execute - the function to apply on each element

Returns:

the same list for fluent use.