Skip navigation links

Ratpack API (1.5.0)

ratpack-core 
Package Description
ratpack.config
Provides the ability to access configuration data from a variety of sources, such as YAML, JSON, properties files, system properties, and environment variables.
ratpack.error
Types that deal with handling application errors.
ratpack.file
Types for dealing with the file system and serving files.
ratpack.form
Support for handling uploaded forms, including file uploads.
ratpack.handling
The handling of application requests.
ratpack.handling.direct
Low level direct access to the underlying Netty internals.
ratpack.health
Health checks report on the status of key components in the system and are generally used for monitoring and reporting.
ratpack.http
The HTTP protocol.
ratpack.http.client
The HTTP client.
ratpack.impose  
ratpack.jackson
Integration with the Jackson JSON marshalling library.
ratpack.logging
Utility classes for integration Ratpack with various logging frameworks.
ratpack.parse
Parsing in Ratpack refers to deserializing a request body into a Java object of some type.
ratpack.path
Types for managing the paths of requests inside the application.
ratpack.render
The renderer framework provides a pluggable mechanism for serializing objects to the response.
ratpack.server
Objects used to start a ratpack application.
ratpack.service
Services participate in the application start/stop lifecycle.
ratpack.sse
Support for Server Sent Events.
ratpack.ssl
Convenience utitilities for dealing with SSL.
ratpack.websocket
Support for Websockets.
ratpack-groovy 
Package Description
ratpack.groovy
Support for writing Ratpack applications in the Groovy programming language.
ratpack.groovy.handling
Groovy specific extensions to classes in the ratpack.handling package.
ratpack.groovy.render
Specialised Groovy support for rendering.
ratpack.groovy.script
Classes for handling Ratpack Groovy scripts.
ratpack.groovy.server
Groovy implementations of the Ratpack server building classes.
ratpack.groovy.sql
Support for providing Groovy's Sql interface.
ratpack.groovy.template
Support for templating based on embedded Groovy code in text.
ratpack-guice 
Package Description
ratpack.guice
Integration with Google Guice.
ratpack-session 
Package Description
ratpack.session
Objects for providing Session support.
ratpack.session.clientside
Support for Client Side Session.
ratpack-session-redis 
Package Description
ratpack.session.store
Provide a SessionStore implementation backed by Redis.
ratpack-test 
Package Description
ratpack.test  
ratpack.test.embed
Support for creating embedded applications at test time, for testing Ratpack features and extensions.
ratpack.test.exec  
ratpack.test.handling  
ratpack.test.http  
ratpack-groovy-test 
Package Description
ratpack.groovy.test  
ratpack.groovy.test.embed
Support for creating Groovy based embedded applications.
ratpack.groovy.test.handling  
ratpack-handlebars 
Package Description
ratpack.handlebars
Integration with Handlebars.java templating engine.
ratpack-remote 
Package Description
ratpack.remote
Integration with Groovy Remote Control.
ratpack-remote-test 
Package Description
ratpack.test.remote  
ratpack-dropwizard-metrics 
Package Description
ratpack.dropwizard.metrics
Integration with Dropwizard Metrics Library.
ratpack-h2 
Package Description
ratpack.h2
Provides integration with H2.
ratpack-thymeleaf 
Package Description
ratpack.thymeleaf
Integration with Thymeleaf templating engine.
ratpack-rx 
Package Description
ratpack.rx
Provides integration with the RxJava library.
ratpack-hikari 
Package Description
ratpack.hikari
Provides integration with HikariCP library.
ratpack-newrelic 
Package Description
ratpack.newrelic
Provides integration with New Relic.
ratpack-pac4j 
Package Description
ratpack.pac4j
Integration with pac4j for authentication/authorization.
ratpack-hystrix 
Package Description
ratpack.hystrix
Provides integration with the Hystrix library.
ratpack-spring-boot 
Package Description
ratpack.spring
Provides integration with Spring Boot.
ratpack.spring.config  
ratpack-retrofit2 
Package Description
ratpack.retrofit
Integration with Retrofit.
ratpack-jdbc-tx 
Package Description
ratpack.jdbctx  
ratpack-consul 
Package Description
ratpack.consul
Support for integrating Ratpack applications with Hashicorp's Consul service discovery and distributed configuration engine.
ratpack-base 
Package Description
ratpack.api
Annotations that are used to further specify API contracts.
ratpack.func
General functional (i.e. Single Abstract Method) types.
ratpack.util
General purpose types and utilities.
ratpack-exec 
Package Description
ratpack.exec
The execution management.
ratpack.exec.util  
ratpack.registry
Registries hold objects that can be retrieved via type, and are a key aspect of Ratpack applications.
ratpack.stream
Support for reactive streams.
ratpack.stream.bytebuf  
ratpack-rocker 
Package Description
ratpack.rocker
Support for Rocker templates.
Skip navigation links