A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

accept(io.vertx.ext.web.handler.StaticHandler) - Method in StaticHandlerOptions

addPackageToScan(java.lang.String) - Method in SessionFactoryProvider

addParameter(java.lang.String, java.lang.String) - Method in FormData

addParameter(java.lang.String, java.io.File) - Method in MultiPartForm

Add a file attachment.

addParameter(java.lang.String, java.lang.String) - Method in UrlEncodedForm

Parameters:

name - The name of the form field.

append(ch.qos.logback.classic.spi.ILoggingEvent) - Method in DatabaseLogger

Application - Class in diego

The new descriptor for applications.

Application() - Constructor in Application

APPLICATION_FAIL - Field in Event

APPLICATION_START - Field in Event

Users can use this static field when using the addEventListener(String, EventListener)

APPLICATION_STATUS_CHANGE - Field in Event

ApplicationDependencyContainerService - Class in diego.aop

Authors:

Kevin Sheppard Date: July 08, 2023

ApplicationDependencyContainerService() - Constructor in ApplicationDependencyContainerService

B

badRequest() - Method in HttpServerResponse

badRequest() - Method in HttpServerResponseImpl

before(diego.web.Handler) - Method in Router

Creates an interceptor that intercepts all routes following this one.

before(diego.web.Handler) - Method in RouterImpl

beforeRegex(java.lang.String, diego.web.Handler) - Method in Router

Creates an interceptor using regex as a path pattern.

beforeRegex(java.lang.String, diego.web.Handler) - Method in RouterImpl

beginTransaction() - Method in SessionManager

Start a transaction.

bind(java.lang.Object) - Method in SqlQuery

Set the parameters of the query from the properties of the Bean.

bind(java.lang.Object) - Method in SqlQueryImpl

bodyHandler() - Method in FrameworkModule

bootstrap() - Method in Diego

Initializes all of the core components of the framework, including the dependency container.

buildBaseConfiguration() - Method in FreemarkerConfigurationProvider

C

clear() - Method in Components

Empty the dependency container.

clientRequest() - Method in HttpClient

Returns:

A new HTTP GET request to the server root.

CLILauncher - Class in diego.tooling

Authors:

Kevin Sheppard Date: Mar 01, 2023

close() - Method in DatabaseImpl

close() - Method in SessionManager

Close the session completely.

collection(Class<T>, Class<K>) - Method in DAO

Create an EntityCollection for a particular type.

collection(Class<T>, Class<K>) - Method in Service

CollectionQuery - Interface in diego.db.collections

A utility class for managing JPQL queries on collections.

CollectionQueryImpl - Class in diego.db.collections

Authors:

Kevin Sheppard Date: July 07, 2023

CollectionQueryImpl(Query<T>) - Constructor in CollectionQueryImpl

commit() - Method in SessionManager

Commit any existing transactions.

Components - Class in diego

A dependency manager for all of the framework components.

Components() - Constructor in Components

ConfigurationModule - Class in diego.utils.test

A Module that injects the Settings object.

configure(diego.web.Router) - Method in Application

configure() - Method in ConfigurationModule

configure() - Method in DatabaseModule

configure() - Method in FrameworkModule

configure() - Method in FreemarkerModule

configure(diego.web.Router) - Method in WebConfig

configureRouter(diego.Application) - Method in Diego

ContentTypes - Class in diego.web

A class to store frequently used values for Content-Type and Accept headers.

convertToSnakeCase(org.hibernate.boot.model.naming.Identifier) - Method in SnakeCaseNamingStrategy

Cookie - Interface in diego.web

Authors:

Kevin Sheppard Date: Jan 10, 2022

CookieImpl - Class in diego.web.impl

HTTP cookie implementation.

CookieImpl(io.vertx.core.http.Cookie) - Constructor in CookieImpl

cookieStore - Field in HttpClientRequest

copyProperties(java.lang.Object) - Method in DTO

copyProperties(io.vertx.core.MultiMap, java.lang.Object) - Method in FormRequestParser

copyProperties(java.lang.Object, java.lang.Object) - Method in PropertyMapper

Copies the values of one object to another, ignoring nulls.

create(java.lang.String) - Method in ConfigurationModule

create(java.lang.String, java.lang.String) - Method in Cookie

Create a cookie with a default max age of one month.

create(Class<T>) - Method in Form

create(diego.init.Settings) - Method in FrameworkModule

Creates in instance of this class with all of its heavy dependencies already initialized.

create(java.lang.String) - Method in HttpClient

Parameters:

baseUrl - A URL such as https://google.com

create(org.apache.http.HttpResponse) - Method in HttpClientResponse

create(io.vertx.core.http.HttpServerRequest) - Method in RequestModel

create(java.lang.String, diego.init.Settings.Env) - Method in StaticHandlerOptions

createBasicForm(Map<String, String>) - Method in FormData

created() - Method in HttpServerResponse

created() - Method in HttpServerResponseImpl

createInstance(Class<T>) - Method in Components

Use the injector to create an instance of Type T.

createMultipartForm(Map<String, Object>) - Method in FormData

createQuery(java.lang.String, Map<String,Object>) - Method in DAO

Parameters:

sql - A native SQL query.

createQuery(java.lang.String) - Method in EntityCollection

Parameters:

jpql - A JPQL query

createQuery(java.lang.String) - Method in EntityCollectionImpl

createQuery(java.lang.String, java.lang.Object) - Method in Service

createRequest(java.lang.String) - Method in HttpClient

Parameters:

path - The path on the server e.g.

createRoute(io.vertx.ext.web.Route) - Method in RouteImpl

D

DAO - Interface in diego.db

A very neat abstraction for the common database operations I've been using for the past ~8 years or so.

Database - Interface in diego.db

A class you can use to work with the database directly instead of creating a service.

DatabaseImpl - Class in diego.db

Authors:

Kevin Sheppard Date: Feb 5, 2022

DatabaseImpl(diego.db.SessionManager) - Constructor in DatabaseImpl

DatabaseLogger - Class in diego.logging

An appender for storing logs in the application database.

DatabaseLogger() - Constructor in DatabaseLogger

DatabaseModule - Class in diego.db

Stores all of the logic required to set up the database for dependency injection.

DatabaseModule(org.hibernate.SessionFactory) - Constructor in DatabaseModule

delegate - Property in HttpRequestHandler

delegate - Property in RouteImpl

delete(K) - Method in EntityCollection

Delete an entity

delete(K) - Method in EntityCollectionImpl

DELETE - Field in HttpMethod

delete(java.lang.String, diego.web.Handler) - Method in Router

Create a DELETE route and set a handler.

delete(java.lang.String, diego.web.Handler) - Method in RouterImpl

DependencyContainerService - Interface in diego.aop

Some components call Components.createInstance() directly which makes testing tricky sometimes.

dependencyContainerService - Field in Form

dependencyContainerService - Field in Service

dependencyContainerService - Property in UsesDependencyService

Diego - Class in diego

Bootstraps the application and initializes the injector.

Diego() - Constructor in Diego

dir - Property in StaticHandlerOptions

The directory to serve (relative to CWD)

DTO - Interface in diego.db

DURATION_ONE_DAY - Field in Cookie

DURATION_ONE_HOUR - Field in Cookie

DURATION_ONE_MONTH - Field in Cookie

DURATION_ONE_YEAR - Field in Cookie

E

EntityCollection - Interface in diego.db.collections

Interface for managing a collection of entities.

EntityCollectionImpl - Class in diego.db.collections

This class is very simplified, but the first pass was a major pain in the a**!

EntityCollectionImpl() - Constructor in EntityCollectionImpl

Env - Class in diego.utils

Utility class to read the env system property.

Env() - Constructor in Env

error() - Method in HttpServerResponse

error() - Method in HttpServerResponseImpl

Event - Interface in diego.app

exec(java.util.List) - Method in JsonMethod

executeScript(java.lang.String) - Method in SqlScriptRunner

Execute an SQL script file.

executeUpdate() - Method in SqlQuery

Execute an update query (insert, update, delete).

executeUpdate() - Method in SqlQueryImpl

extractId(java.lang.Object) - Method in DatabaseImpl

Leaving this here as I might want to use it to enhance the PropertyMapper later on.

F

FastRuntimeException - Class in diego.utils

A trick I learned from the Play Framework to short-circuit application execution in a performant way.

FastRuntimeException(java.lang.String) - Constructor in FastRuntimeException

FileSystemClassLoader - Class in diego.tooling

A ClassLoader that loads classes from the file system.

FileSystemClassLoader(java.lang.ClassLoader, java.lang.String) - Constructor in FileSystemClassLoader

fillInStackTrace() - Method in FastRuntimeException

find(K) - Method in EntityCollection

Find an entity by its ID.

find(K) - Method in EntityCollectionImpl

findList() - Method in CollectionQuery

Returns:

A list of entities from the database

findList() - Method in CollectionQueryImpl

findOne() - Method in CollectionQuery

Returns:

A single entity from the database.

findOne() - Method in CollectionQueryImpl

findPropertyDescriptor(List<PropertyDescriptor>, java.lang.String) - Method in PropertyMapper

findRow(Class<T>) - Method in SqlQuery

Execute a query and map it to a Java Bean.

findRow(Class<T>) - Method in SqlQueryImpl

findRows(Class<T>) - Method in SqlQuery

Execute a query and return a list of Beans of type T

findRows(Class<T>) - Method in SqlQueryImpl

findScalar(Class<T>) - Method in SqlQuery

Execute a query that returns a single scalar value, such as a VARCHAR column or the result of a count()

findScalar(Class<T>) - Method in SqlQueryImpl

findScalarList(Class<T>) - Method in SqlQuery

Execute a query that returns a List of scalar values, such as a list of VARCHAR rows

findScalarList(Class<T>) - Method in SqlQueryImpl

findValueList(Class<T>) - Method in SqlQueryImpl

Form - Class in diego.validation

The data validation feature of the framework.

Form(Class<T>, jakarta.validation.Validator) - Constructor in Form

FORM_URLENCODED - Field in ContentTypes

FormData - Class in diego.utils.httpclient

Class for storing form parameters.

FormData() - Constructor in FormData

forMethodName(java.lang.String) - Method in NamedMethodMatcher

FormRequestParser - Class in diego.validation

Request parser for form requests.

FormRequestParser() - Constructor in FormRequestParser

FormValidationException - Class in diego.validation

An exception thrown when form validation fails.

FormValidationException(LinkedHashMap<String, List<String>>) - Constructor in FormValidationException

forTypes(Class<T>, Class<K>) - Method in EntityCollectionImpl

FrameworkModule - Class in diego

The Guice Module that holds all of the core components of the framework.

FreemarkerConfigurationProvider - Class in diego.templates

Authors:

Kevin Sheppard Date: Jul 05, 2023

FreemarkerConfigurationProvider() - Constructor in FreemarkerConfigurationProvider

FreemarkerModule - Class in diego.templates

Authors:

Kevin Sheppard Date: July 05, 2023

FreemarkerModule() - Constructor in FreemarkerModule

FreemarkerTemplateEngine - Class in diego.templates

A Freemarker template renderer.

FreemarkerTemplateEngine(freemarker.template.Configuration) - Constructor in FreemarkerTemplateEngine

G

get() - Method in FreemarkerConfigurationProvider

get(Class<T>) - Method in Helpers

Retrieves an instance of T from the dependency container.

GET - Field in HttpMethod

get(java.lang.String) - Method in HttpServerRequest

Shortcut for HttpServerRequest#getState().get(String)

get(java.lang.String) - Method in HttpServerRequestImpl

get(java.lang.String, diego.web.Handler) - Method in Router

Create a GET route and set a handler.

get(java.lang.String, diego.web.Handler) - Method in RouterImpl

get() - Method in SessionFactoryProvider

getAt(java.lang.String) - Method in HttpServerRequest

Facilitates the use of Groovy's subscript operator ([]).

getAt(java.lang.String) - Method in HttpServerRequestImpl

getBean(Class<T>) - Method in ApplicationDependencyContainerService

getBean(Class<T>) - Method in DependencyContainerService

getBody() - Method in HttpClientRequest

getBody() - Method in HttpClientResponse

getBody() - Method in HttpServerRequest

Returns:

The request body.

getBody() - Method in HttpServerRequestImpl

getConstraintViolations() - Method in FormValidationException

getContentType() - Method in HttpServerRequest

Returns:

The value of the Content-Type header.

getContentType() - Method in HttpServerRequestImpl

getCookies() - Method in HttpServerRequest

RFC States that there can be multiple cookies with the same name, but seeing that this is a practice we try to discourage internally, this pattern will go a long way in enforcing that.

getCookies() - Method in HttpServerRequestImpl

getData() - Method in HttpServerRequest.Body

Returns:

The request body as a usable Map (only for JSON requests).

getData() - Method in Settings

Returns:

The root configuration object.

getDateFormat() - Method in Settings

getDelegate() - Method in RouterImpl

getDelegate() - Method in StaticHandlerOptions

getDetail() - Method in Event

getDomain() - Method in Cookie

getDomain() - Method in CookieImpl

getElapsedTime() - Method in Timer

getEncType() - Method in FormData

getEncType() - Method in MultiPartForm

getEncType() - Method in UrlEncodedForm

getEntity() - Method in FormData

getEntity() - Method in MultiPartForm

getEntity() - Method in UrlEncodedForm

getEnv() - Method in Settings

getFileUploads() - Method in HttpServerRequest

Returns:

The files sent with this request.

getFileUploads() - Method in HttpServerRequestImpl

getFormParams() - Method in HttpServerRequest.Body

Returns:

The parameters from the submitted form.

getHeaders() - Method in HttpServerRequest

getHeaders() - Method in HttpServerRequestImpl

getHost() - Method in HttpServerRequest

getHost() - Method in HttpServerRequestImpl

getHttp() - Method in Settings

getInstance() - Method in Settings

Non-thread safe singleton method.

getMaxAge() - Method in Cookie

getMaxAge() - Method in CookieImpl

getMethod() - Method in HttpServerRequest

Returns:

The HTTP method used for this request.

getMethod() - Method in HttpServerRequestImpl

getModules() - Method in Settings

getName() - Method in Cookie

getName() - Method in CookieImpl

getParams() - Method in RequestModel

getParams() - Method in RequestModelImplementation

getPath() - Method in Cookie

getPath() - Method in CookieImpl

getPath() - Method in HttpServerRequest

Returns:

The path portion of the URI e.g.

getPath() - Method in HttpServerRequestImpl

getPath() - Method in RequestModel

getPath() - Method in RequestModelImplementation

getPathParam(java.lang.String) - Method in HttpServerRequest

Parameters:

name - The name of the parameter.

getPathParam(java.lang.String) - Method in HttpServerRequestImpl

getPathParams() - Method in HttpServerRequest

Returns:

A Map of path parameters.

getPathParams() - Method in HttpServerRequestImpl

getPropertyDescriptors(java.lang.Object) - Method in PropertyMapper

Parameters:

instance - A Bean.

getQueryParams() - Method in HttpServerRequest

Returns:

The query parameters in the URL.

getQueryParams() - Method in HttpServerRequestImpl

getRouter() - Method in Diego

getRouter() - Method in FrameworkModule

getServer() - Method in FrameworkModule

Returns:

An HttpServer configured according to application settings.

getSession() - Method in Database

Get the current Session from the SessionManager.

getSession() - Method in SessionManager

Returns:

A new Session or the existing session if one is open.

getSession() - Method in SessionStore

getState() - Method in HttpServerRequest

getState() - Method in HttpServerRequestImpl

getStatusCode() - Method in HttpClientResponse

getStatusMessage() - Method in HttpClientResponse

getTotalTime() - Method in Timer

getUri() - Method in HttpServerRequest

getUri() - Method in HttpServerRequestImpl

getValue() - Method in Cookie

getValue() - Method in CookieImpl

getVertx() - Method in FrameworkModule

group(Set<ConstraintViolation>) - Method in Form

groups() - Method in MimeType

groups() - Method in Required

H

handle(diego.web.HttpServerRequest, diego.web.HttpServerResponse) - Method in Handler

handle(io.vertx.ext.web.RoutingContext) - Method in IndexRouteHandler

Handler - Interface in diego.web

Functional interface to allow for lambda notation when creating routes.

handler(diego.web.Handler) - Method in Route

Add a handler.

handler(diego.web.Handler) - Method in RouteImpl

handleUploads(diego.web.HttpServerRequest, java.lang.Object) - Method in FormRequestParser

Helpers - Class in diego.utils

Utility class for managing the dependency container during testing.

Helpers() - Constructor in Helpers

HTML - Field in ContentTypes

HTTP_BAD_REQUEST - Field in HttpServerResponse

HTTP_CREATED - Field in HttpServerResponse

HTTP_ERROR - Field in HttpServerResponse

HTTP_NOT_FOUND - Field in HttpServerResponse

HTTP_OK - Field in HttpServerResponse

HTTP_REDIRECT_SEE_OTHER - Field in HttpServerResponse

HTTP_UNAUTHORIZED - Field in HttpServerResponse

HttpClient - Class in diego.utils.httpclient

A simple HTTP client for performing server to server communication.

HttpClient() - Constructor in HttpClient

HttpClientRequest - Class in diego.utils.httpclient

A class to store configuration details for an HTTP request.

HttpClientRequest(java.lang.String, java.lang.String, diego.utils.httpclient.HttpMethod) - Constructor in HttpClientRequest

HttpClientResponse - Class in diego.utils.httpclient

A response from the HttpClient.

HttpClientResponse() - Constructor in HttpClientResponse

HttpMethod - Enum in diego.utils.httpclient

Standardized entries for HTTP Methods.

HttpRequestHandler - Class in diego.web

This class was created so that we can write encapsulating logic around the handling of each request that comes to the server.

HttpRequestHandler(diego.web.Router) - Constructor in HttpRequestHandler

HttpServerRequest - Interface in diego.web

Authors:

Kevin Sheppard Date: Nov 02, 2021

HttpServerRequest.Body - Interface in diego.web

Serves to encapsulate all logic relating to the request body.

HttpServerRequestImpl - Class in diego.web.impl

Authors:

Kevin Sheppard Date: Nov 02, 2021

HttpServerRequestImpl(com.fasterxml.jackson.databind.ObjectMapper) - Constructor in HttpServerRequestImpl

HttpServerResponse - Interface in diego.web

Interface created to guide the development of the HttpResponse object.

HttpServerResponseImpl - Class in diego.web.impl

Authors:

Kevin Sheppard Date: Nov 02, 2021

HttpServerResponseImpl(com.fasterxml.jackson.databind.ObjectMapper, diego.templates.TemplateEngine) - Constructor in HttpServerResponseImpl

HttpServerResponseMethodMatcher - Class in diego.db

A matcher that encapsulates the logic for determining which methods in the HttpServerResponse should trigger Session termination.

HttpServerResponseMethodMatcher() - Constructor in HttpServerResponseMethodMatcher

I

IndexRouteHandler - Class in diego.tooling

A development only route that lists all of the application's routes.

IndexRouteHandler(diego.web.Router) - Constructor in IndexRouteHandler

initialize(diego.init.Settings, diego.templates.JsonMethod) - Method in FreemarkerConfigurationProvider

initialize(diego.validation.constraints.MimeType) - Method in MimeTypeValidator

initializeContext(java.lang.String) - Method in Helpers

Initialize the dependency container but specify a configuration file to use.

initializeFramework() - Method in Components

initializeWith(com.google.inject.Module) - Method in Components

Create an injector using specific modules.

inject(Class<T>) - Method in UsesDependencyService

insert(T) - Method in EntityCollection

Insert an entity.

insert(T) - Method in EntityCollectionImpl

invoke(org.aopalliance.intercept.MethodInvocation) - Method in SessionManagerInterceptor

invoke(org.aopalliance.intercept.MethodInvocation) - Method in TransactionalMethodInterceptor

is(java.lang.String) - Method in Env

Compare the env system property to a given string.

is(java.lang.String) - Method in Settings.Env

Parameters:

env - The value to compare, e.g. staging.

isDev() - Method in Env

Returns:

True if it matches dev

isDev() - Method in Settings.Env

Returns:

True if it matches dev

isInitialized() - Method in Components

Returns:

True if the Injector has been initialized.

isMultipart(diego.web.HttpServerRequest) - Method in FormRequestParser

isProd() - Method in Env

Returns:

True if it matches prod

isProd() - Method in Settings.Env

Returns:

True if it matches prod

isValid(io.vertx.ext.web.FileUpload, jakarta.validation.ConstraintValidatorContext) - Method in MimeTypeValidator

isValid(java.lang.Object, jakarta.validation.ConstraintValidatorContext) - Method in RequiredValidator

J

JSON - Field in ContentTypes

JsonMethod - Class in diego.templates

Authors:

Kevin Sheppard Date: Jul 05, 2023

JsonMethod(com.fasterxml.jackson.databind.ObjectMapper) - Constructor in JsonMethod

JsonRequestParser - Class in diego.validation

Takes a request with a JSON body and returns a domain object.

JsonRequestParser(com.fasterxml.jackson.databind.ObjectMapper) - Constructor in JsonRequestParser

K

L

load(java.lang.String) - Method in Settings

Same as Settings.load, but allows the user to specify a configuration file.

loadClass(java.lang.String) - Method in FileSystemClassLoader

loadSettings(java.lang.String) - Method in Helpers

Initialize Settings.

M

main(java.lang.String) - Method in CLILauncher

Parameters:

args - args[0]: The main class name

mapToBean(Class<T>, Map<String, Object>) - Method in SqlQueryImpl

Creates an instance of T filled with the data from a database query.

matches(java.lang.reflect.Method) - Method in HttpServerResponseMethodMatcher

matches(java.lang.reflect.Method) - Method in NamedMethodMatcher

MAX_VALUE - Field in HttpMethod

message() - Method in MimeType

message() - Method in Required

methodName - Field in HttpMethod

methodName - Property in NamedMethodMatcher

MimeType - Annotation Type in diego.validation.constraints

Ensures that FileUploads are of a particular MIME type.

mimeTypePatterns - Property in MimeTypeValidator

MimeTypeValidator - Class in diego.validation.constraints

Authors:

Kevin Sheppard Date: May 19, 2023

MimeTypeValidator() - Constructor in MimeTypeValidator

MIN_VALUE - Field in HttpMethod

MULTIPART_FORM_DATA - Field in ContentTypes

MultiPartForm - Class in diego.utils.httpclient

Create a Multipart form used for uploading files.

MultiPartForm() - Constructor in MultiPartForm

N

NamedMethodMatcher - Class in diego.aop

Created because Guice doesn't have one.

next() - Method in HttpServerRequest

Pass the request on to the next matching route.

next() - Method in HttpServerRequestImpl

notFound() - Method in HttpServerResponse

notFound() - Method in HttpServerResponseImpl

O

objectMapper() - Method in FrameworkModule

OCTET_STREAM - Field in ContentTypes

ok() - Method in HttpServerResponse

ok() - Method in HttpServerResponseImpl

onStart() - Method in Application

onStart() - Method in WebConfig

P

param(java.lang.String, java.lang.Object) - Method in SqlQueryImpl

params(java.lang.Object) - Method in CollectionQuery

params(java.lang.Object) - Method in CollectionQueryImpl

params(java.lang.Object) - Method in SqlQuery

Set the parameters of this query using positional arguments

params(Map<String, Object>) - Method in SqlQueryImpl

parse(diego.web.HttpServerRequest) - Method in Form

parseDurationExpression(java.lang.String) - Method in StaticHandlerOptions

Parses a duration expression and returns a long value representing the duration in seconds.

parseRequest(diego.web.HttpServerRequest, Class<T>) - Method in FormRequestParser

parseRequest(diego.web.HttpServerRequest, Class<T>) - Method in JsonRequestParser

parseRequest(diego.web.HttpServerRequest, Class<T>) - Method in RequestParser

PATCH - Field in HttpMethod

patch(java.lang.String, diego.web.Handler) - Method in Router

Create a PATCH route and set a handler.

patch(java.lang.String, diego.web.Handler) - Method in RouterImpl

path(java.lang.String, io.vertx.core.Handler<RoutingContext>) - Method in Router

Mount a Vert.x Web handler to the routing stack at a specified path.

path(java.lang.String, Class<? extends Consumer<Router>>) - Method in RouterImpl

path(java.lang.String) - Method in Settings

Parameters:

path - The root of a configuration tree.

pathRegex(java.lang.String, diego.web.StaticHandlerOptions) - Method in Router

Use a RegEx pattern to specify a path at which to mount the static files handler.

pathRegex(java.lang.String, diego.web.StaticHandlerOptions) - Method in RouterImpl

payload() - Method in MimeType

payload() - Method in Required

POST - Field in HttpMethod

post(java.lang.String, diego.web.Handler) - Method in Router

Create a POST route and set a handler.

post(java.lang.String, diego.web.Handler) - Method in RouterImpl

printStackTrace() - Method in FastRuntimeException

PropertyMapper - Class in diego.utils

Authors:

Kevin Sheppard Date: February 7, 2022 3:59AM

PropertyMapper() - Constructor in PropertyMapper

PUT - Field in HttpMethod

put(java.lang.String, java.lang.Object) - Method in HttpServerRequest

Add an arbitrary item to the request state.

put(java.lang.String, java.lang.Object) - Method in HttpServerRequestImpl

put(java.lang.String, diego.web.Handler) - Method in Router

Create a PUT route and set a handler.

put(java.lang.String, diego.web.Handler) - Method in RouterImpl

putAt(java.lang.String, java.lang.Object) - Method in HttpServerRequest

Facilitates the use of Groovy's subscript operator ([]).

putAt(java.lang.String, java.lang.Object) - Method in HttpServerRequestImpl

Q

R

ReactiveOutputStream - Class in diego.tooling

Prints to the standard output and executes code once it detects that a build has completed.

ReactiveOutputStream(java.lang.Runnable) - Constructor in ReactiveOutputStream

redirect(java.lang.String) - Method in HttpServerResponse

Perform a 303 redirect to another URL.

redirect(java.lang.String) - Method in HttpServerResponseImpl

remove(java.lang.String) - Method in HttpServerRequest

Remove an item from the request's state.

remove(java.lang.String) - Method in HttpServerRequestImpl

removeCookie(java.lang.String) - Method in HttpServerResponse

removeCookie(java.lang.String) - Method in HttpServerResponseImpl

render(java.lang.String, Map<String, Object>) - Method in FreemarkerTemplateEngine

render(java.lang.String, Map<String,Object>) - Method in HttpServerResponse

render(java.lang.String, Map<String, Object>) - Method in HttpServerResponseImpl

render(java.lang.String, Map<String,Object>) - Method in TemplateEngine

Parameters:

templateName - templateName The name of the template e.g. index.ftl

RequestModel - Interface in diego.templates

A lightweight version of the HttpServerRequest meant to be used in templates.

RequestModelImplementation - Class in diego.templates

An implementation of the Request template variable.

RequestModelImplementation() - Constructor in RequestModelImplementation

RequestParser - Interface in diego.validation

Parses requests and returns a domain object.

Required - Annotation Type in diego.validation.constraints

Authors:

Kevin Sheppard Date: May 19, 2023

RequiredValidator - Class in diego.validation.constraints

Authors:

Kevin Sheppard Date: May 19, 2023

RequiredValidator() - Constructor in RequiredValidator

reroute(java.lang.String) - Method in HttpServerResponse

Restarts the router with the new path, preserving all headers, cookies, state and parameters.

reroute(java.lang.String) - Method in HttpServerResponseImpl

Route - Interface in diego.web

Authors:

Kevin Sheppard Date: Nov 02, 2021

RouteImpl - Class in diego.web.impl

Authors:

Kevin Sheppard Date: Nov 02, 2021

Router - Interface in diego.web

Interface created to guide the development of the Router.

RouterImpl - Class in diego.web.impl

An implementation of the Router interface that leverages the Vertx Router.

RouterImpl(io.vertx.ext.web.Router) - Constructor in RouterImpl

run() - Method in CLILauncher

run(Class<Application>) - Method in Diego

Bootstraps the core framework components and starts the application server.

S

send(diego.utils.httpclient.HttpClientRequest) - Method in HttpClient

Send the request to the server.

send() - Method in HttpServerResponse

Send a response back to the client.

send() - Method in HttpServerResponseImpl

sendFile(java.lang.String, java.lang.String) - Method in HttpServerResponse

Send a file back to the client.

sendFile(java.lang.String, java.lang.String) - Method in HttpServerResponseImpl

sendJson(java.lang.Object) - Method in HttpServerResponse

Send a JSON response to the client.

sendJson(java.lang.Object) - Method in HttpServerResponseImpl

serve(java.lang.String) - Method in Application

Serve a directory using smart defaults depending on the application environment.

Service - Class in diego.db

Authors:

Kevin Sheppard Date: July 07, 2023

Service() - Constructor in Service

SessionFactoryProvider - Class in diego.db

A provider for a Hibernate SessionFactory.

SessionFactoryProvider(java.lang.String, java.lang.String, java.lang.String, Class<?>) - Constructor in SessionFactoryProvider

A constructor used mainly for testing.

SessionManager - Class in diego.db

Created so that we can have more granular control over when the database session closes.

SessionManager(org.hibernate.SessionFactory) - Constructor in SessionManager

sessionManager - Property in SessionStore

SessionManagerInterceptor - Class in diego.db

Closes the active Session after every response has been sent.

SessionManagerInterceptor(diego.db.SessionManager) - Constructor in SessionManagerInterceptor

SessionStore - Trait in diego.db

A Trait that houses common functionality for all classes that work with a SessionManager.

setBody(java.lang.String, java.lang.String) - Method in HttpClientRequest

Set a String as the request body and specify its content type using a String.

setCachingEnabled(java.lang.Boolean) - Method in StaticHandlerOptions

setContentType(java.lang.String) - Method in HttpServerResponse

Set the Content-Type header of the response.

setContentType(java.lang.String) - Method in HttpServerResponseImpl

setCookie(java.lang.String, java.lang.String) - Method in HttpClientRequest

Set a request cookie.

setCookie(diego.web.Cookie) - Method in HttpServerResponse

Create a cookie.

setCookie(diego.web.Cookie) - Method in HttpServerResponseImpl

setDomain(java.lang.String) - Method in Cookie

Parameters:

domain - The domain for this cookie

setDomain(java.lang.String) - Method in CookieImpl

setEnableDirectoryListing(java.lang.Boolean) - Method in StaticHandlerOptions

setFirstRow(int) - Method in CollectionQuery

Pagination method to set the first record to return

setFirstRow(int) - Method in CollectionQueryImpl

setFirstRow(int) - Method in SqlQuery

setFirstRow(int) - Method in SqlQueryImpl

setHeader(java.lang.String, java.lang.String) - Method in HttpClientRequest

Add a header to the request.

setHeader(java.lang.String, java.lang.String) - Method in HttpServerResponse

setHeader(java.lang.String, java.lang.String) - Method in HttpServerResponseImpl

setMaxAge(long) - Method in Cookie

Sets how long the cookie should persist.

setMaxAge(long) - Method in CookieImpl

setMaxAge(java.lang.String) - Method in StaticHandlerOptions

Set the Max-Age header value using a duration expression in the form

setMaxCacheSize(int) - Method in StaticHandlerOptions

setMaxRows(int) - Method in CollectionQuery

Pagination method to set the limit the amount of rows to return

setMaxRows(int) - Method in CollectionQueryImpl

setMaxRows(int) - Method in SqlQuery

setMaxRows(int) - Method in SqlQueryImpl

setMethod(diego.utils.httpclient.HttpMethod) - Method in HttpClientRequest

Set the HTTP method for the request.

setParam(java.lang.String, java.lang.String) - Method in HttpClientRequest

Set a URL parameter.

setParams(io.vertx.core.MultiMap) - Method in RequestModelImplementation

setPath(java.lang.String) - Method in Cookie

Parameters:

path - The server path this cookie applies to.

setPath(java.lang.String) - Method in CookieImpl

setPath(java.lang.String) - Method in HttpClientRequest

Set the path for the request.

setSessionManager(diego.db.SessionManager) - Method in SessionStore

setStatusCode(int) - Method in HttpServerResponse

Set the status code of the response.

setStatusCode(int) - Method in HttpServerResponseImpl

setStatusMessage(java.lang.String) - Method in HttpServerResponse

setStatusMessage(java.lang.String) - Method in HttpServerResponseImpl

Settings - Class in diego.init

Typed representation of application settings stored in *.conf files.

Settings.Env - Class in diego.init

Utility class for reading the "app.env" config property.

SnakeCaseNamingStrategy - Class in diego.db

A naming strategy to convert camelCase columns and tables to snake_case.

sql - Property in DatabaseLogger

SqlQuery - Interface in diego.db

An abstraction for 99% of the database operations I've done over the years.

SqlQueryImpl - Class in diego.db

SqlQueryImpl(org.hibernate.Session, java.lang.String) - Constructor in SqlQueryImpl

SqlScriptRunner - Class in diego.utils.test

Authors:

Kevin Sheppard Date: Aug 16, 2022

SqlScriptRunner(java.lang.String, java.lang.String, java.lang.String) - Constructor in SqlScriptRunner

start(java.lang.Runnable) - Method in Diego

Extracted this out so that Diego.run and CLILauncher.main can perform different bootstrapping processes.

startClock() - Method in Timer

Mark the current time.

StaticHandlerOptions - Class in diego.web

Author: Kevin Sheppard Date: April 01, 2023

StaticHandlerOptions() - Constructor in StaticHandlerOptions

stopClock() - Method in Timer

Mark the current time and print how much time has elapsed since starting the clock.

strToPattern(java.lang.String) - Method in MimeTypeValidator

Converts an Ant expression to a Regex pattern.

T

TemplateEngine - Interface in diego.templates

Authors:

Kevin Sheppard Date: Jul 05, 2023

TEXT_PLAIN - Field in ContentTypes

Timer - Class in diego.utils

Utility class for monitoring how long the application takes to start.

Timer() - Constructor in Timer

toCamelCase(java.lang.String) - Method in SqlQueryImpl

todo() - Method in HttpServerResponse

todo() - Method in HttpServerResponseImpl

toHttpUriRequest() - Method in HttpClientRequest

Converts this request into an Apache HttpUriRequest for use by the HttpClient.

toPhysicalCatalogName(org.hibernate.boot.model.naming.Identifier, org.hibernate.engine.jdbc.env.spi.JdbcEnvironment) - Method in SnakeCaseNamingStrategy

toPhysicalColumnName(org.hibernate.boot.model.naming.Identifier, org.hibernate.engine.jdbc.env.spi.JdbcEnvironment) - Method in SnakeCaseNamingStrategy

toPhysicalSchemaName(org.hibernate.boot.model.naming.Identifier, org.hibernate.engine.jdbc.env.spi.JdbcEnvironment) - Method in SnakeCaseNamingStrategy

toPhysicalSequenceName(org.hibernate.boot.model.naming.Identifier, org.hibernate.engine.jdbc.env.spi.JdbcEnvironment) - Method in SnakeCaseNamingStrategy

toPhysicalTableName(org.hibernate.boot.model.naming.Identifier, org.hibernate.engine.jdbc.env.spi.JdbcEnvironment) - Method in SnakeCaseNamingStrategy

toString() - Method in HttpServerRequest.Body

Returns:

The request's body as a String.

TransactionalMethodInterceptor - Class in diego.db

Intercepts all

Transactional:

methods and ensures that transactions are grouped and applied correctly.

TransactionalMethodInterceptor(diego.db.SessionManager) - Constructor in TransactionalMethodInterceptor

U

unauthorized() - Method in HttpServerResponse

unauthorized() - Method in HttpServerResponseImpl

unwrap() - Method in HttpServerRequest

If you find yourself using this method, document your use case and create a pull request.

unwrap() - Method in HttpServerRequestImpl

unwrap() - Method in HttpServerResponse

Use with caution as this method will be removed in future updates.

unwrap() - Method in HttpServerResponseImpl

update(K, diego.db.DTO) - Method in EntityCollection

Update a JPA entity using a data transfer object

update(K, diego.db.DTO) - Method in EntityCollectionImpl

UrlEncodedForm - Class in diego.utils.httpclient

Creates a URLEncodedFormEntity.

UrlEncodedForm() - Constructor in UrlEncodedForm

use(io.vertx.core.Handler<RoutingContext>) - Method in Router

Mount a Vert.x Web handler to the routing stack.

use(io.vertx.core.Handler<RoutingContext>) - Method in RouterImpl

UsesDependencyService - Trait in diego.aop

A trait that can be implemented by any class that wishes to use the dependency container.

V

validator() - Method in FrameworkModule

value() - Method in MimeType

W

WebConfig - Trait in diego.web

The new descriptor for applications.

withParameters(Map<String, Object>) - Method in MultiPartForm

Convenience method for adding parameters to the form from a Map.

withParameters(Map<String, String>) - Method in UrlEncodedForm

Convenience method for adding parameters to the form.

withRouteContext(io.vertx.ext.web.RoutingContext) - Method in HttpServerRequestImpl

withRouteContext(io.vertx.ext.web.RoutingContext) - Method in HttpServerResponseImpl

write(int) - Method in ReactiveOutputStream

X

Y

Z

_