- generateSessionId(Request) - Method in interface ratpack.session.SessionIdGenerator
-
- get(Closure<?>) - Method in interface ratpack.groovy.handling.GroovyByMethodHandler
-
Defines the action to to take if the request has a HTTP method of GET.
- get(Handler) - Method in interface ratpack.groovy.handling.GroovyChain
-
Adds a handler that delegates to the given handler
if the request
HTTPMethod
is GET
and the path
is at the
current root.
- get(String, Handler) - Method in interface ratpack.groovy.handling.GroovyChain
-
Adds a handler that delegates to the given handler
if the relative path
matches the given path
and the request
HTTPMethod
is GET
.
- get(String, Closure<?>) - Method in interface ratpack.groovy.handling.GroovyChain
-
Adds a Handler
to this GroovyChain
that delegates to the given Closure
as a Handler
if the
relative path
matches the given path
and the request
HTTPMethod
is GET
.
- get(Closure<?>) - Method in interface ratpack.groovy.handling.GroovyChain
-
Adds a Handler
to this GroovyChain
that delegates to the given Closure
as a Handler
if the request
HTTPMethod
is GET
and the path
is at the current root.
- get() - Method in class ratpack.groovy.sql.SqlProvider
-
- get(String, Class<T>) - Method in interface ratpack.groovy.templating.TemplateModel
-
- get() - Method in interface ratpack.groovy.test.TestHttpClient
-
- get(String) - Method in interface ratpack.groovy.test.TestHttpClient
-
- get(Runnable) - Method in interface ratpack.handling.ByMethodHandler
-
Defines the action to to take if the request has a HTTP method of GET.
- get(String, Handler) - Method in interface ratpack.handling.Chain
-
Adds a handler that delegates to the given handler
if the relative path
matches the given path
and the request
HTTPMethod
is GET
.
- get(Handler) - Method in interface ratpack.handling.Chain
-
Adds a handler that delegates to the given handler
if the request
HTTPMethod
is GET
and the path
is at the
current root.
- get() - Static method in class ratpack.handling.Handlers
-
A handler that delegates to the next handler if the request is GET, otherwise raises a 405 client error.
- get(String) - Method in interface ratpack.http.Headers
-
Returns the header value with the specified header name.
- get(Class<O>) - Method in interface ratpack.registry.Registry
-
Provides an object of the specified type, or throws an exception if no object of that type is available.
- get(String) - Method in interface ratpack.session.store.SessionStore
-
Retrieve the session storage for the given id, creating it on demand if necessary.
- get(Object) - Method in interface ratpack.util.MultiValueMap
-
Get the first value for the key, or null
if there are no values for the key.
- getAddress() - Method in interface ratpack.launch.LaunchConfig
-
The address of the interface that the application should bind to.
- getAddress(Context) - Method in interface ratpack.server.PublicAddress
-
The advertised public address.
- getAddress() - Method in interface ratpack.test.ApplicationUnderTest
-
The address of the application under test, which is guaranteed to be accepting requests.
- getAddress() - Method in class ratpack.test.embed.EmbeddedApplicationSupport
-
The address of the application under test, which is guaranteed to be accepting requests.
- getAddress() - Method in class ratpack.test.ServerBackedApplicationUnderTest
-
- getAll(String) - Method in interface ratpack.http.Headers
-
Returns all of the header values with the specified header name.
- getAll(Class<O>) - Method in interface ratpack.registry.Registry
-
Returns all of the objects whose declared type is assignment compatible with the given type.
- getAll(K) - Method in interface ratpack.util.MultiValueMap
-
All of the values for the given key.
- getAll() - Method in interface ratpack.util.MultiValueMap
-
Returns a new view of the map where each map value is a list of all the values for the given key (i.e.
- getAllPathTokens() - Method in interface ratpack.handling.MinimalContext
-
- getAllTokens() - Method in interface ratpack.path.PathBinding
-
- getApplicationUnderTest() - Method in interface ratpack.groovy.test.TestHttpClient
-
- getBackground() - Method in interface ratpack.handling.MinimalContext
-
An object to be used when executing blocking IO, or long operations.
- getBackground() - Method in interface ratpack.launch.LaunchConfig
-
The “background”, for performing blocking operations.
- getBaseDir() - Method in interface ratpack.launch.LaunchConfig
-
- getBindAddress() - Method in interface ratpack.handling.MinimalContext
-
The address that this request was received on.
- getBindHost() - Method in interface ratpack.server.RatpackServer
-
The actual host/ip that the application is bound to.
- getBindPort() - Method in interface ratpack.server.RatpackServer
-
The actual port that the application is bound to.
- getBody() - Method in interface ratpack.http.Request
-
The body of the request.
- getBodyBytes() - Method in interface ratpack.test.handling.Invocation
-
- getBodyText() - Method in interface ratpack.test.handling.Invocation
-
- getBoundTo() - Method in interface ratpack.path.PathBinding
-
The path of the request path that was bound to.
- getBuffer() - Method in interface ratpack.http.TypedData
-
The raw data as a (unmodifiable) buffer.
- getBufferAllocator() - Method in interface ratpack.launch.LaunchConfig
-
The allocator for buffers needed by the application.
- getByContent() - Method in interface ratpack.handling.Context
-
A buildable handler useful for performing content negotiation.
- getByMethod() - Method in interface ratpack.handling.Context
-
A buildable handler for conditional processing based on the HTTP request method.
- getBytes() - Method in interface ratpack.http.TypedData
-
The raw data as bytes.
- getCacheSize() - Method in interface ratpack.groovy.templating.TemplatingConfig
-
- getCacheSize() - Method in class ratpack.groovy.templating.TemplatingModule
-
- getCacheSize() - Method in class ratpack.handlebars.HandlebarsModule
-
- getChannel() - Method in interface ratpack.handling.direct.DirectChannelAccess
-
The channel.
- getCharset() - Method in interface ratpack.http.MediaType
-
The value of the "charset" parameter, or the HTTP default of "ISO-8859-1"
.
- getClientError() - Method in interface ratpack.test.handling.Invocation
-
- getClosedAt() - Method in interface ratpack.handling.RequestOutcome
-
The time at when this request was dealt with from the application's point of view.
- getCode() - Method in interface ratpack.http.Status
-
The status code.
- getConnection() - Method in interface ratpack.websocket.WebSocketMessage
-
- getContentType(String) - Method in interface ratpack.file.MimeTypes
-
Calculate the mime type for the given file.
- getContentType() - Method in interface ratpack.groovy.markup.Markup
-
The content type of the markup.
- getContentType() - Method in class ratpack.handlebars.Template
-
- getContentType() - Method in interface ratpack.http.TypedData
-
The type of the data.
- getContentType() - Method in class ratpack.parse.NoOptParserSupport
-
The content type that this parser knows how to deserialize.
- getContentType() - Method in exception ratpack.parse.NoSuchParserException
-
The content type of the request.
- getContentType() - Method in interface ratpack.parse.Parser
-
The content type that this parser knows how to deserialize.
- getContentType() - Method in class ratpack.parse.ParserSupport
-
The content type that this parser knows how to deserialize.
- getContentType() - Method in class ratpack.thymeleaf.Template
-
- getContext() - Method in interface ratpack.groovy.handling.GroovyContext
-
Returns this.
- getContext() - Method in interface ratpack.handling.Context
-
Returns this.
- getContext() - Method in interface ratpack.handling.Foreground
-
Provides the current context on the current thread.
- getContext() - Method in interface ratpack.handling.MinimalContext
-
Returns this.
- getCookieDomain() - Method in interface ratpack.session.SessionManager
-
- getCookieDomain() - Method in class ratpack.session.SessionModule
-
- getCookieExpiresMins() - Method in class ratpack.session.SessionModule
-
- getCookieExpiryMins() - Method in interface ratpack.session.SessionManager
-
- getCookiePath() - Method in interface ratpack.session.SessionManager
-
- getCookiePath() - Method in class ratpack.session.SessionModule
-
- getCookies() - Method in interface ratpack.http.Request
-
The cookies that were sent with the request.
- getCookies() - Method in interface ratpack.http.Response
-
The cookies that are to be part of the response.
- getDate(String) - Method in interface ratpack.http.Headers
-
Returns the header value as a date with the specified header name.
- getDefaultPrefixedProperties() - Static method in class ratpack.launch.LaunchConfigFactory
-
Extracts the properties prefixed with
"ratpack." from the system properties, without the prefix.
- getDefinition() - Method in interface ratpack.groovy.markup.Markup
-
The closure that defines the markup.
- getDirectChannelAccess() - Method in interface ratpack.handling.Context
-
Provides direct access to the backing Netty channel.
- getDomain() - Method in interface ratpack.session.SessionCookieConfig
-
- getEncoding() - Method in interface ratpack.groovy.markup.Markup
-
The character encoding of the markup.
- getException() - Method in interface ratpack.test.handling.Invocation
-
- getExecutor() - Method in interface ratpack.handling.Foreground
-
The executor that manages foreground work.
- getExistingId() - Method in interface ratpack.session.Session
-
If there is an existing session, returns the ID in use.
- getExpiresMins() - Method in interface ratpack.session.SessionCookieConfig
-
- getFailure() - Method in class ratpack.util.Result
-
The failure exception.
- getFile() - Method in interface ratpack.file.FileSystemBinding
-
The actual point on the filesystem that this binding is bound to.
- getFileName() - Method in interface ratpack.form.UploadedFile
-
The name given for the file.
- getForeground() - Method in interface ratpack.handling.MinimalContext
-
The application foreground.
- getForeground() - Method in interface ratpack.launch.LaunchConfig
-
The application foreground.
- getHandlerFactory() - Method in interface ratpack.launch.LaunchConfig
-
The handler factory that can create the root handler for the application.
- getHeaders() - Method in interface ratpack.http.Request
-
The request headers.
- getHeaders() - Method in interface ratpack.http.Response
-
The response headers.
- getHeaders() - Method in interface ratpack.http.SentResponse
-
The headers that were sent in the response.
- getHeaders() - Method in interface ratpack.test.handling.Invocation
-
- getHost() - Method in interface ratpack.server.BindAddress
-
The host name.
- getId() - Method in interface ratpack.groovy.templating.Template
-
- getId() - Method in interface ratpack.session.Session
-
Returns the session ID, initiating a session if necessary.
- getIdGenerator() - Method in interface ratpack.session.SessionManager
-
- getIndexFiles() - Method in interface ratpack.launch.LaunchConfig
-
The names of files that can be served if a request is made to serve a directory.
- getInputStream() - Method in interface ratpack.http.TypedData
-
An input stream of the data.
- getLaunchConfig() - Method in interface ratpack.guice.ModuleRegistry
-
The launch config for the application the module registry is for.
- getLaunchConfig() - Method in interface ratpack.handling.Chain
-
The launch config of the application that this chain is being created for.
- getLaunchConfig() - Method in interface ratpack.server.RatpackServer
-
The (read only) configuration that was used to launch this server.
- getMaxContentLength() - Method in interface ratpack.launch.LaunchConfig
-
The max content length to use for the HttpObjectAggregator.
- getMessage() - Method in interface ratpack.http.Status
-
The message of the status.
- getMethod() - Method in interface ratpack.http.Request
-
The method of the request.
- getModel() - Method in interface ratpack.groovy.templating.Template
-
- getModel() - Method in interface ratpack.groovy.templating.TemplateScript
-
The backing model for this template.
- getModel() - Method in class ratpack.handlebars.Template
-
- getModel() - Method in class ratpack.thymeleaf.Template
-
- getModules() - Method in class ratpack.groovy.test.embed.ClosureBackedEmbeddedApplication
-
A mutable list of modules to use in this application.
- getName() - Method in class ratpack.codahale.metrics.NamedHealthCheck
-
The name to register the health check as.
- getName() - Method in interface ratpack.handlebars.NamedHelper
-
- getName() - Method in class ratpack.handlebars.Template
-
- getName() - Method in interface ratpack.http.HttpMethod
-
The name of the method, always in upper case.
- getName() - Method in class ratpack.thymeleaf.Template
-
- getNames() - Method in interface ratpack.http.Headers
-
All header names.
- getObject() - Method in interface ratpack.jackson.JsonRender
-
The underlying object to be rendered.
- getObjectReader() - Method in interface ratpack.jackson.JsonParse
-
- getObjectWriter() - Method in interface ratpack.jackson.JsonRender
-
The object writer to use to render the object as JSON.
- getOpenResult() - Method in interface ratpack.websocket.WebSocketClose
-
- getOpenResult() - Method in interface ratpack.websocket.WebSocketMessage
-
- getOther(String, String) - Method in interface ratpack.launch.LaunchConfig
-
Provides access to any "other" properties that were specified.
- getOtherPrefixedWith(String) - Method in interface ratpack.launch.LaunchConfig
-
Provides access to all "other" properties whose name starts with a given prefix.
- getParams() - Method in interface ratpack.http.MediaType
-
The parameters of the mime type.
- getParse() - Method in exception ratpack.parse.NoSuchParserException
-
The parse object.
- getParsedType() - Method in class ratpack.parse.NoOptParserSupport
-
The type that this parser can deserialize to.
- getParsedType() - Method in interface ratpack.parse.Parser
-
The type that this parser can deserialize to.
- getParsedType() - Method in class ratpack.parse.ParserSupport
-
The type that this parser can deserialize to.
- getParseType() - Method in class ratpack.parse.NoOptParserSupport
-
The type of the
Parse
object for this parser.
- getParseType() - Method in interface ratpack.parse.Parser
-
The type of the
Parse
object for this parser.
- getParseType() - Method in class ratpack.parse.ParserSupport
-
The type of the
Parse
object for this parser.
- getPastBinding() - Method in interface ratpack.path.PathBinding
-
The section of the path that is "past" where the binding bound to.
- getPath() - Method in interface ratpack.http.Request
-
The URI without the query string and leading forward slash.
- getPath() - Method in class ratpack.remote.RemoteControlModule
-
- getPath() - Method in interface ratpack.session.SessionCookieConfig
-
- getPathTokens() - Method in interface ratpack.handling.MinimalContext
-
- getPort() - Method in interface ratpack.launch.LaunchConfig
-
The port that the application should listen to requests on.
- getPort() - Method in interface ratpack.server.BindAddress
-
The port number.
- getPublicAddress() - Method in interface ratpack.launch.LaunchConfig
-
The public address of the site used for redirects.
- getQuery() - Method in interface ratpack.http.Request
-
The query string component of the request URI, without the "?".
- getQueryParams() - Method in interface ratpack.http.Request
-
TBD.
- getRegistry() - Method in interface ratpack.handling.Chain
-
The registry that backs this.
- getRequest() - Method in interface ratpack.groovy.test.TestHttpClient
-
- getRequest() - Method in interface ratpack.handling.MinimalContext
-
The HTTP request.
- getRequest() - Method in interface ratpack.handling.RequestOutcome
-
The request.
- getResponse() - Method in interface ratpack.groovy.test.TestHttpClient
-
- getResponse() - Method in interface ratpack.handling.Context
-
The HTTP response.
- getResponse() - Method in interface ratpack.handling.RequestOutcome
-
The response.
- getScheme() - Method in interface ratpack.server.RatpackServer
-
The URL scheme the server uses.
- getSentFile() - Method in interface ratpack.test.handling.Invocation
-
- getServer() - Method in interface ratpack.test.embed.EmbeddedApplication
-
The server for the application.
- getServer() - Method in class ratpack.test.embed.EmbeddedApplicationSupport
-
The server.
- getSSLContext() - Method in interface ratpack.launch.LaunchConfig
-
The SSL context to use if the application will serve content over HTTPS.
- getStatus() - Method in interface ratpack.http.Response
-
The status that will be part of the response when sent.
- getStatus() - Method in interface ratpack.http.SentResponse
-
The status line of the response.
- getStatus() - Method in interface ratpack.test.handling.Invocation
-
- getTemplatesCacheSize() - Method in class ratpack.thymeleaf.ThymeleafModule
-
- getTemplatesMode() - Method in class ratpack.thymeleaf.ThymeleafModule
-
- getTemplatesPath() - Method in interface ratpack.groovy.templating.TemplatingConfig
-
- getTemplatesPath() - Method in class ratpack.groovy.templating.TemplatingModule
-
- getTemplatesPath() - Method in class ratpack.handlebars.HandlebarsModule
-
- getTemplatesPrefix() - Method in class ratpack.thymeleaf.ThymeleafModule
-
- getTemplatesSuffix() - Method in class ratpack.handlebars.HandlebarsModule
-
- getTemplatesSuffix() - Method in class ratpack.thymeleaf.ThymeleafModule
-
- getText() - Method in interface ratpack.groovy.test.TestHttpClient
-
- getText(String) - Method in interface ratpack.groovy.test.TestHttpClient
-
- getText() - Method in interface ratpack.http.TypedData
-
The data as text.
- getText() - Method in interface ratpack.websocket.WebSocketMessage
-
- getThreads() - Method in interface ratpack.launch.LaunchConfig
-
The number of threads for handling application requests.
- getTokens() - Method in interface ratpack.path.PathBinding
-
Any tokens that the binding has extracted from the path.
- getType() - Method in interface ratpack.groovy.templating.Template
-
- getType() - Method in interface ratpack.http.MediaType
-
The type without parameters.
- getType() - Method in class ratpack.parse.NoOptParse
-
The type of object to parse to.
- getType() - Method in interface ratpack.parse.Parse
-
The type of object to parse to.
- getType() - Method in class ratpack.parse.ParseSupport
-
The type of object to parse to.
- getType() - Method in interface ratpack.render.Renderer
-
The type of object that this renderer can render.
- getType() - Method in class ratpack.render.RendererSupport
-
The type of object that this renderer can render (the type for T
).
- getUri() - Method in interface ratpack.http.Request
-
The complete URI of the request (path + query string).
- getValue() - Method in class ratpack.util.Result
-
The result value.
- getVersion() - Static method in class ratpack.util.RatpackVersion
-
The version of Ratpack.
- Groovy - Class in ratpack.groovy
-
Static methods for specialized Groovy integration.
- Groovy.Ratpack - Interface in ratpack.groovy
-
The definition of a Groovy Ratpack application.
- GroovyByContentHandler - Interface in ratpack.groovy.handling
-
- GroovyByMethodHandler - Interface in ratpack.groovy.handling
-
A Groovy specific subclass of
ByMethodHandler
that makes using closures more convenient.
- GroovyChain - Interface in ratpack.groovy.handling
-
A Groovy oriented handler chain builder DSL.
- GroovyContext - Interface in ratpack.groovy.handling
-
Subclass of
Context
that adds Groovy friendly variants of methods.
- groovyHandler(Closure<?>) - Static method in class ratpack.groovy.Groovy
-
Creates a handler instance from a closure.
- GroovyHandler - Class in ratpack.groovy.handling
-
- GroovyHandler() - Constructor for class ratpack.groovy.handling.GroovyHandler
-
- GroovyModuleRegistry - Interface in ratpack.groovy.guice
-
- GroovyRatpackMain - Class in ratpack.groovy.launch
-
The standard “main” entry point for Groovy script based apps.
- GroovyRatpackMain() - Constructor for class ratpack.groovy.launch.GroovyRatpackMain
-
- GroovyRendererSupport<T> - Class in ratpack.groovy.render
-
- GroovyRendererSupport() - Constructor for class ratpack.groovy.render.GroovyRendererSupport
-
Constructor.
- groovyTemplate(String) - Static method in class ratpack.groovy.Groovy
-
Creates a
renderable
Groovy based template, using no model and the default content type.
- groovyTemplate(String, String) - Static method in class ratpack.groovy.Groovy
-
Creates a
renderable
Groovy based template, using no model.
- groovyTemplate(Map<String, ?>, String) - Static method in class ratpack.groovy.Groovy
-
Creates a
renderable
Groovy based template, using the default content type.
- groovyTemplate(Map<String, ?>, String, String) - Static method in class ratpack.groovy.Groovy
-
- GroovyUnitTest - Class in ratpack.groovy.test
-
- GroovyUnitTest() - Constructor for class ratpack.groovy.test.GroovyUnitTest
-
- Guice - Class in ratpack.guice
-
Static utility methods for creating Google Guice based Ratpack infrastructure.
- GuiceBackedHandlerFactory - Interface in ratpack.guice
-