Skip navigation links
A B C D E F G H I J L M N O P R S T U V W X Y 

G

gate(Publisher<T>, Action<? super Runnable>) - Static method in class ratpack.stream.Streams
Allows requests from the subscriber of the return publisher to be withheld from the given publisher until an externally defined moment.
gate(Action<? super Runnable>) - Method in interface ratpack.stream.TransformablePublisher
GATEWAY_TIMEOUT - Static variable in interface ratpack.http.Status
The 504 status code.
generate(Request) - Method in interface ratpack.handling.RequestId.Generator
Generate the ID for the request.
generateSessionId() - Method in interface ratpack.session.SessionIdGenerator
Generates a new identifier to be used as a session id.
get(String, Class<O>) - Method in interface ratpack.config.ConfigData
Binds a segment of the configuration data to the specified type.
get(Class<O>) - Method in interface ratpack.config.ConfigData
Binds the root of the configuration data to the specified type.
get(Factory<T>) - Static method in class ratpack.exec.Blocking
Performs a blocking operation on a separate thread, returning a promise for its value.
get(Block) - Method in interface ratpack.groovy.handling.GroovyByMethodSpec
Defines the action to to take if the request has a HTTP method of GET.
get(Class<? extends Handler>) - Method in interface ratpack.groovy.handling.GroovyByMethodSpec
Inserts the handler to chain if the request has a HTTP method of GET.
get(Handler) - Method in interface ratpack.groovy.handling.GroovyByMethodSpec
Inserts the handler to chain if the request has a HTTP method of GET.
get(Closure<?>) - Method in interface ratpack.groovy.handling.GroovyByMethodSpec
Inserts the handler to chain if the request has a HTTP method of GET.
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, Class<? extends Handler>) - Method in interface ratpack.groovy.handling.GroovyChain
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(Class<? extends Handler>) - Method in interface ratpack.groovy.handling.GroovyChain
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.template.TextTemplateModel
Retrieve the given model item, of the given type.
get(String, TypeToken<T>) - Method in interface ratpack.groovy.template.TextTemplateModel
Retrieve the given model item, of the given type.
get(Block) - Method in interface ratpack.handling.ByMethodSpec
Defines the action to to take if the request has a HTTP method of GET.
get(Class<? extends Handler>) - Method in interface ratpack.handling.ByMethodSpec
Inserts the handler to chain if the request has a HTTP method of GET.
get(Handler) - Method in interface ratpack.handling.ByMethodSpec
Inserts the handler to chain 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(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
 
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(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
 
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(URI, Action<? super RequestSpec>) - Method in interface ratpack.http.client.HttpClient
An asynchronous method to do a GET HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, but the method will be defaulted to a GET.
get(URI) - Method in interface ratpack.http.client.HttpClient
 
get() - Method in interface ratpack.http.client.RequestSpec
Specifies to use the GET request method.
get(CharSequence) - Method in interface ratpack.http.Headers
Returns the header value with the specified header name.
get(String) - Method in interface ratpack.http.Headers
Returns the header value with the specified header name.
GET - Static variable in interface ratpack.http.HttpMethod
The GET method.
get(Class<T>) - Method in class ratpack.impose.Impositions
Return an imposition of the given type, if one is currently imposed.
get(Factory<? extends Connection>) - Static method in interface ratpack.jdbctx.Transaction
Returns the current transaction if present, otherwise a newly created transaction.
get(Context) - Method in interface ratpack.pac4j.RatpackPac4j.ClientsProvider
 
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(TypeToken<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(Context) - Method in interface ratpack.server.PublicAddress
Deprecated.
since 1.2
get() - Method in interface ratpack.server.PublicAddress
Returns the public address.
get(Context, Action<? super HttpUrlBuilder>) - Method in interface ratpack.server.PublicAddress
Deprecated.
get(Action<? super HttpUrlBuilder>) - Method in interface ratpack.server.PublicAddress
Creates a URL by building a URL based on the public address.
get(Context, String) - Method in interface ratpack.server.PublicAddress
Deprecated.
get(String) - Method in interface ratpack.server.PublicAddress
Creates a URL by appending the given path to the public address
get(SessionKey<T>) - Method in interface ratpack.session.Session
A convenience shorthand for SessionData.get(SessionKey).
get(SessionKey<T>, SessionSerializer) - Method in interface ratpack.session.Session
get(String) - Method in interface ratpack.session.Session
A convenience shorthand for SessionData.get(String).
get(String, SessionSerializer) - Method in interface ratpack.session.Session
A convenience shorthand for SessionData.get(String, SessionSerializer).
get(Class<T>) - Method in interface ratpack.session.Session
A convenience shorthand for SessionData.get(Class).
get(Class<T>, SessionSerializer) - Method in interface ratpack.session.Session
A convenience shorthand for SessionData.get(Class, SessionSerializer).
get(SessionKey<T>) - Method in interface ratpack.session.SessionData
Fetch the object with the given key, using the default serializer.
get(SessionKey<T>, SessionSerializer) - Method in interface ratpack.session.SessionData
Read the object with the given key.
get(String) - Method in interface ratpack.session.SessionData
Read the object with the given name, using the default serializer.
get(String, SessionSerializer) - Method in interface ratpack.session.SessionData
Read the object with the given name.
get(Class<T>) - Method in interface ratpack.session.SessionData
Read the object with the given type, and no name, using the default serializer.
get(Class<T>, SessionSerializer) - Method in interface ratpack.session.SessionData
Read the object with the given type, and no name.
get() - Method in interface ratpack.test.http.TestHttpClient
Make a GET request with a path of "" this is the same as calling get("").
get(String) - Method in interface ratpack.test.http.TestHttpClient
Make a GET request to the specified path.
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.
getActive() - Method in interface ratpack.exec.Throttle
How many throttled promises are currently executing.
getAdapted() - Method in interface ratpack.service.LegacyServiceAdapter
Deprecated.
The legacy service being adapted.
getAddress() - Method in interface ratpack.server.ServerConfig
The address of the interface that the application should bind to.
getAddress() - Method in class ratpack.spring.config.RatpackProperties
 
getAddress() - Method in interface ratpack.test.ApplicationUnderTest
The address of the application under test, which is guaranteed to be listening for requests.
getAddress() - Method in interface ratpack.test.embed.EmbeddedApp
The address of the application under test, which is guaranteed to be listening for requests.
getAddress() - Method in class ratpack.test.ServerBackedApplicationUnderTest
Returns the address to the root of the server, starting it if necessary.
getAll(CharSequence) - Method in interface ratpack.http.Headers
Returns all of the header values with the specified header name.
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(TypeToken<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.Context
The contextual path tokens of the current PathBinding.
getAllTokens() - Method in interface ratpack.path.PathBinding
Similar to PathBinding.getTokens() except that tokens of all parent bindings are included.
getApplicationUnderTest() - Method in interface ratpack.test.http.TestHttpClient
 
getAsConfigObject(String, Class<O>) - Method in interface ratpack.config.ConfigData
Binds a segment of the configuration data to the specified type.
getAsConfigObject(String, TypeToken<O>) - Method in interface ratpack.config.ConfigData
Binds a segment of the configuration data to the specified type.
getBaseDir() - Method in interface ratpack.server.ServerConfig
The base dir of the application, which is also the initial FileSystemBinding.
getBasedir() - Method in class ratpack.spring.config.RatpackProperties
 
getBasepath() - Method in class ratpack.spring.config.RatpackProperties
 
getBindHost() - Method in interface ratpack.server.RatpackServer
The actual host/ip that the application is bound to.
getBindings() - Method in class ratpack.guice.BindingsImposition
The bindings to add/override.
getBindings() - Method in interface ratpack.spring.config.RatpackServerCustomizer
 
getBindings() - Method in class ratpack.spring.config.RatpackServerCustomizerAdapter
 
getBindPort() - Method in interface ratpack.server.RatpackServer
The actual port that the application is bound to.
getBlockingExecutor() - Method in interface ratpack.exec.ExecController
 
getBody() - Method in interface ratpack.http.client.ReceivedResponse
 
getBody() - Method in interface ratpack.http.client.RequestSpec
The body of the request, used for specifying the body content.
getBody() - Method in interface ratpack.http.client.StreamedResponse
 
getBody() - Method in interface ratpack.http.Request
The body of the request.
getBody(Block) - Method in interface ratpack.http.Request
The body of the request.
getBody(long) - Method in interface ratpack.http.Request
The body of the request allowing up to the provided size for the content.
getBody(long, Block) - Method in interface ratpack.http.Request
The body of the request allowing up to the provided size for the content.
getBodyBytes() - Method in interface ratpack.test.handling.HandlingResult
The response body, as bytes.
getBodyStream() - Method in interface ratpack.http.Request
Allows reading the body as a stream, with back pressure.
getBodyStream(long) - Method in interface ratpack.http.Request
Allows reading the body as a stream, with back pressure.
getBodyText() - Method in interface ratpack.test.handling.HandlingResult
The response body, interpreted as a utf8 string.
getBoolean(int) - Method in class ratpack.bytebuf.ByteBufRef
 
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.
getByte(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getByteBufAllocator() - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig
Get the settings for the byte buf allocator metric set.
getByteBufAllocator() - Method in interface ratpack.http.client.HttpClient
The buffer allocator used by the client.
getBytes(int, ByteBuf) - Method in class ratpack.bytebuf.ByteBufRef
 
getBytes(int, ByteBuf, int) - Method in class ratpack.bytebuf.ByteBufRef
 
getBytes(int, ByteBuf, int, int) - Method in class ratpack.bytebuf.ByteBufRef
 
getBytes(int, byte[]) - Method in class ratpack.bytebuf.ByteBufRef
 
getBytes(int, byte[], int, int) - Method in class ratpack.bytebuf.ByteBufRef
 
getBytes(int, ByteBuffer) - Method in class ratpack.bytebuf.ByteBufRef
 
getBytes(int, OutputStream, int) - Method in class ratpack.bytebuf.ByteBufRef
 
getBytes(int, GatheringByteChannel, int) - Method in class ratpack.bytebuf.ByteBufRef
 
getBytes(int, FileChannel, long, int) - Method in class ratpack.bytebuf.ByteBufRef
 
getBytes() - Method in interface ratpack.http.TypedData
The raw data as bytes.
getCacheSize() - Method in class ratpack.handlebars.HandlebarsModule.Config
 
getCacheSize() - Method in class ratpack.spring.config.RatpackProperties
 
getChannel() - Method in interface ratpack.handling.direct.DirectChannelAccess
The channel.
getChar(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getCharSequence(int, int, Charset) - Method in class ratpack.bytebuf.ByteBufRef
 
getCharset() - Method in interface ratpack.http.MediaType
The value of the "charset" parameter.
getCharset(String) - Method in interface ratpack.http.MediaType
The value of the "charset" parameter, or the given default value of no charset was specified.
getCipherAlgorithm() - Method in class ratpack.session.clientside.ClientSideSessionConfig
The Cipher algorithm used to encrypt/decrypt the serialized session
getClientCertificate() - Method in interface ratpack.http.Request
The client's verified certificate if the connection was made with HTTPS and client authentication is enabled.
getClientError() - Method in interface ratpack.test.handling.HandlingResult
The client error raised if any, unless a custom client error handler is in use.
getClientErrorCode() - Method in exception ratpack.http.ClientErrorException
 
getClientErrorCode() - Method in exception ratpack.http.RequestBodyTooLargeException
 
getCode() - Method in interface ratpack.http.Status
The status code.
getComment() - Method in interface ratpack.sse.Event
The comment for this event.
getConfigSources() - Method in interface ratpack.config.ConfigDataBuilder
Returns the config sources used for configuration binding.
getConnection() - Method in interface ratpack.jdbctx.Transaction
The underlying connection for the transaction.
getConnection() - Method in interface ratpack.websocket.WebSocketMessage
 
getConnectQueueSize() - Method in interface ratpack.server.ServerConfig
The maximum amount of connections that may be waiting to be accepted at any time.
getConnectTimeout() - Method in interface ratpack.http.client.HttpClient
The default read timeout value.
getConnectTimeout() - Method in interface ratpack.http.client.RequestSpec
Gets the configured socket connection timeout.
getConnectTimeoutMillis() - Method in interface ratpack.server.ServerConfig
The connect timeout of the channel.
getConsole() - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig
Get the settings for the console metrics publisher.
getContentLength() - Method in interface ratpack.http.Request
The advertised content length of the request body.
getContentType(String) - Method in interface ratpack.file.MimeTypes
Calculate the mime type for the given file.
getContentType() - Method in class ratpack.groovy.template.Markup
 
getContentType() - Method in class ratpack.groovy.template.MarkupTemplate
 
getContentType() - Method in class ratpack.handlebars.Template
 
getContentType() - Method in interface ratpack.http.Request
The type of the data as specified in the "content-type" header.
getContentType() - Method in class ratpack.http.ResponseChunks
The intended value of the content-type header.
getContentType() - Method in interface ratpack.http.TypedData
The type of the data.
getContentType() - Method in exception ratpack.parse.NoSuchParserException
The content type of the request.
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.
getContextPath() - Method in class ratpack.spring.config.RatpackProperties
 
getController() - Method in interface ratpack.exec.Execution
The execution controller that this execution is associated with.
getController() - Method in interface ratpack.test.exec.ExecHarness
 
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.
getCookies() - Method in interface ratpack.test.handling.HandlingResult
The cookies to be set as part of the response.
getCookies(String) - Method in interface ratpack.test.http.TestHttpClient
Get cookies with Path= attribute equal to path and all its subpaths.
getCsv() - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig
Get the settings for the csv metrics publisher.
getData() - Method in interface ratpack.session.Session
The session data.
getData() - Method in interface ratpack.sse.Event
The “data” value of the event.
getDataSource(HikariService) - Method in class ratpack.hikari.HikariModule
 
getDataSource() - Method in class ratpack.hikari.HikariService
 
getDate(CharSequence) - Method in interface ratpack.http.Headers
Returns the header value as a date with the specified header name.
getDate(String) - Method in interface ratpack.http.Headers
Returns the header value as a date with the specified header name.
getDecompressResponse() - Method in interface ratpack.http.client.RequestSpec
Gets if responses are automatically decompressed.
getDefaultSerializer() - Method in interface ratpack.session.Session
The serializer that is used when a serializer is not explicitly given.
getDefaultSerializer() - Method in interface ratpack.session.SessionData
getDefaultTimeout() - Method in interface ratpack.exec.util.ReadWriteAccess
The default timeout value.
getDefinition() - Method in class ratpack.groovy.template.Markup
 
getDescription() - Method in interface ratpack.path.PathBinding
Describes the kind of path that this binder binds to.
getDirectChannelAccess() - Method in interface ratpack.handling.Context
Provides direct access to the backing Netty channel.
getDomain() - Method in class ratpack.session.SessionCookieConfig
Use the session cookie only when requesting from the domain.
getDouble(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getDoubleLE(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getDuration() - Method in interface ratpack.handling.RequestOutcome
The amount of elapsed time between Request.getTimestamp() and RequestOutcome.getSentAt().
getDurationUnit() - Method in class ratpack.dropwizard.metrics.GraphiteConfig
The state of duration conversion.
getDurationUnit() - Method in class ratpack.dropwizard.metrics.Slf4jConfig
The state of the duration time unit.
getEncoding() - Method in class ratpack.groovy.template.Markup
 
getEndDelimiter() - Method in class ratpack.handlebars.HandlebarsModule.Config
 
getError() - Method in class ratpack.health.HealthCheck.Result
The exception representing an unhealthy check, may be null.
getEvent() - Method in interface ratpack.sse.Event
The “event” value of the event.
getEventLoop() - Method in interface ratpack.exec.Execution
The specific event loop that this execution is using for compute operations.
getEventLoopGroup() - Method in interface ratpack.exec.ExecController
The event loop group used by Netty for this application.
getExcludeFilter() - Method in class ratpack.dropwizard.metrics.ReporterConfigSupport
The exclude metric filter expression of the reporter.
getExecution() - Method in interface ratpack.handling.Context
The execution of handling this request.
getExecutor() - Method in interface ratpack.exec.ExecController
The event loop (i.e.
getExpires() - Method in class ratpack.session.SessionCookieConfig
Cookie's max age.
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.
getFileSystemBinding() - Method in interface ratpack.handling.Context
Returns the current filesystem binding from the context registry.
getFloat(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getFloatLE(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getFragmentSpec() - Method in class ratpack.thymeleaf.Template
 
getGraphite() - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig
Get the settings for the Graphite metrics publisher.
getGson() - Method in interface ratpack.gson.GsonParseOpts
Get the Gson instance to use when deserializing the JSON.
getGson() - Method in interface ratpack.gson.GsonRender
The Gson instance to use when serializing the object to JSON.
getHandlers() - Method in interface ratpack.spring.config.RatpackServerCustomizer
 
getHandlers() - Method in class ratpack.spring.config.RatpackServerCustomizerAdapter
 
getHeaders() - Method in interface ratpack.http.client.HttpResponse
 
getHeaders() - Method in interface ratpack.http.client.RequestSpec
 
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.HandlingResult
The final response headers.
getHikariPool() - Method in class ratpack.hikari.HikariHealthCheck
 
getHost() - Method in class ratpack.session.store.RedisSessionModule.Config
Get the address for Redis.
getHttpClient() - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig
Get the settings for the http client metric set.
getHttpClient() - Method in interface ratpack.test.ApplicationUnderTest
Creates a new test HTTP client that makes requests to this application.
getId() - Method in class ratpack.groovy.template.TextTemplate
 
getId() - Method in interface ratpack.session.Session
The unique ID for this session.
getId() - Method in interface ratpack.sse.Event
The “id” value of the event.
getIdleTimeout() - Method in interface ratpack.server.ServerConfig
The default amount of time to allow a connection to remain open without any traffic.
getIdName() - Method in class ratpack.session.SessionCookieConfig
The name of the cookie for session id.
getIncludeFilter() - Method in class ratpack.dropwizard.metrics.ReporterConfigSupport
The include metric filter expression of the reporter.
getInputStream() - Method in interface ratpack.http.TypedData
An input stream of the data.
getInstant(CharSequence) - Method in interface ratpack.http.Headers
Returns the header value as an instant with the specified header name.
getInt(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getIntLE(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getItem() - Method in interface ratpack.sse.Event
The stream item that this event.
getItem() - Method in interface ratpack.stream.StreamEvent
The data, if this event represents an emission of data.
getJavaSerializer() - Method in interface ratpack.session.Session
The value serializer that is guaranteed to be able to serialize/deserialize any Java object that implements Serializable.
getJavaSerializer() - Method in interface ratpack.session.SessionData
getJmx() - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig
Get the settings for the JMX metrics publisher.
getKeys() - Method in interface ratpack.session.Session
A convenience shorthand for SessionData.getKeys().
getKeys() - Method in interface ratpack.session.SessionData
The keys of all objects currently in the session.
getLastAccessTimeCookieName() - Method in class ratpack.session.clientside.ClientSideSessionConfig
The name of the cookie used to store session's last access time.
getLeft() - Method in class ratpack.func.Pair
The left item of the pair.
getLocalAddress() - Method in interface ratpack.http.Request
The address of the local network interface that received the request.
getLogger() - Method in class ratpack.dropwizard.metrics.Slf4jConfig
The state of the logger.
getLogLevel() - Method in class ratpack.dropwizard.metrics.Slf4jConfig
The state of the logging level.
getLong(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getLongLE(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getMacAlgorithm() - Method in class ratpack.session.clientside.ClientSideSessionConfig
The Mac algorithm used to sign the serialized session with the secretToken.
getMarker() - Method in class ratpack.dropwizard.metrics.Slf4jConfig
The state of the marker.
getMaxChunkSize() - Method in interface ratpack.server.ServerConfig
The maximum chunk size to use when reading request (server) or response (client) bodies.
getMaxContentLength() - Method in interface ratpack.http.client.HttpClient
The maximum response length accepted by the client.
getMaxContentLength() - Method in interface ratpack.http.client.RequestSpec
Get the configured maximum response length.
getMaxContentLength() - Method in interface ratpack.http.Request
The max allowed content length for the request body.
getMaxContentLength() - Method in exception ratpack.http.RequestBodyTooLargeException
 
getMaxContentLength() - Method in interface ratpack.server.ServerConfig
The max content length to use for the HttpObjectAggregator.
getMaxHeaderSize() - Method in interface ratpack.server.ServerConfig
The maximum size of all headers allowed for reading http requests.
getMaxInactivityInterval() - Method in class ratpack.session.clientside.ClientSideSessionConfig
Maximum inactivity time (in units defined by TimeUnit) after which session will be invalidated.
getMaxInitialLineLength() - Method in interface ratpack.server.ServerConfig
The maximum initial line length allowed for reading http requests.
getMaxMessagesPerRead() - Method in interface ratpack.server.ServerConfig
The maximum number of messages to read per read loop.
getMaxResponseChunkSize() - Method in interface ratpack.http.client.HttpClient
The max size of the chunks to emit when reading a response as a stream.
getMaxSessionCookieSize() - Method in class ratpack.session.clientside.ClientSideSessionConfig
Maximum size of the session cookie.
getMaxThreads() - Method in class ratpack.spring.config.RatpackProperties
 
getMedium(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getMediumLE(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getMessage() - Method in class ratpack.health.HealthCheck.Result
Any message provided as part of the check, may be null.
getMessage() - Method in interface ratpack.http.Status
The message of the status.
getMethod() - Method in interface ratpack.http.client.RequestSpec
Get the configured request method.
getMethod() - Method in interface ratpack.http.Request
The method of the request.
getModel() - Method in class ratpack.groovy.template.MarkupTemplate
 
getModel() - Method in class ratpack.groovy.template.TextTemplate
 
getModel() - Method in interface ratpack.groovy.template.TextTemplateScript
The backing model for this template.
getModel() - Method in class ratpack.handlebars.Template
 
getModel() - Method in class ratpack.thymeleaf.Template
 
getName() - Method in class ratpack.groovy.template.MarkupTemplate
 
getName() - Method in interface ratpack.handlebars.NamedHelper
 
getName() - Method in class ratpack.handlebars.Template
 
getName() - Method in interface ratpack.health.HealthCheck
The unique name of the health check.
getName() - Method in class ratpack.health.HealthCheckHandler
The name of the path token that may indicate a particular health check to execute.
getName() - Method in class ratpack.hikari.HikariHealthCheck
 
getName() - Method in interface ratpack.http.HttpMethod
The name of the method, always in upper case.
getName() - Method in interface ratpack.server.Service
Deprecated.
getName() - Method in interface ratpack.service.Service
The name of this service, used for display purposes.
getName() - Method in interface ratpack.session.SessionKey
The name.
getName() - Method in class ratpack.thymeleaf.Template
 
getNames() - Method in interface ratpack.http.Headers
All header names.
getNettyHeaders() - Method in interface ratpack.http.Headers
Returns the headers in their Netty compliant form.
getNettyMethod() - Method in interface ratpack.http.HttpMethod
Returns the method in the underlying Netty form.
getNettySslContext() - Method in interface ratpack.server.ServerConfig
The SSL context to use if the application will serve content over HTTPS.
getNettyStatus() - Method in interface ratpack.http.Status
The status as Netty's type.
getNumThreads() - Method in interface ratpack.exec.ExecController
The number of threads that will be used for computation.
getObject() - Method in interface ratpack.config.ConfigObject
The bound object.
getObject() - Method in interface ratpack.gson.GsonRender
The underlying object to be rendered.
getObject() - Method in interface ratpack.jackson.JsonRender
The underlying object to be rendered.
getObjectMapper() - Method in interface ratpack.config.ConfigDataBuilder
Returns the object mapper used for configuration binding.
getObjectMapper() - Method in interface ratpack.jackson.JsonParseOpts
 
getObjectWriter(Registry) - Static method in class ratpack.jackson.Jackson
 
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
 
getOpts() - Method in exception ratpack.parse.NoSuchParserException
The parse opts.
getOpts() - Method in class ratpack.parse.Parse
The type of object that provides options/configuration for the parsing.
getOptsType() - Method in interface ratpack.parse.Parser
The type of option object that this parser accepts.
getOptsType() - Method in class ratpack.parse.ParserSupport
The type of option object that this parser accepts.
getParams() - Method in interface ratpack.http.MediaType
The multimap containing parameters of the mime type.
getParent() - Method in interface ratpack.exec.Execution
A ref to the execution that forked this execution.
getParent() - Method in interface ratpack.exec.ExecutionRef
A ref to the execution that forked this execution.
getPassword() - Method in class ratpack.session.store.RedisSessionModule.Config
Get the password for Redis.
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.config.ConfigObject
The path to the config item.
getPath() - Method in interface ratpack.http.Request
The URI without the query string and leading forward slash.
getPath() - Method in class ratpack.session.SessionCookieConfig
Use the session cookie only when requesting from the path.
getPathBinding() - Method in interface ratpack.handling.Context
The current request path binding.
getPathTokens() - Method in interface ratpack.handling.Context
The contextual path tokens of the current PathBinding.
getPollingFrequencyInSeconds() - Method in class ratpack.dropwizard.metrics.HttpClientConfig
The frequency in seconds of which the HttpClient metrics will be refreshed.
getPoolQueueSize() - Method in interface ratpack.http.client.HttpClient
The number of connections that the client will queue if pool was depleted for any given server.
getPoolSize() - Method in interface ratpack.http.client.HttpClient
The number of connections that the client will pool for any given server.
getPort() - Method in class ratpack.impose.ForceServerListenPortImposition
The port to be forced.
getPort() - Method in interface ratpack.server.ServerConfig
The port that the application should listen to requests on.
getPort() - Method in class ratpack.session.store.RedisSessionModule.Config
The Redis port.
getPort() - Method in class ratpack.spring.config.RatpackProperties
 
getPrefix() - Method in class ratpack.dropwizard.metrics.GraphiteConfig
The state of the metric name prefix.
getPrefix() - Method in class ratpack.dropwizard.metrics.Slf4jConfig
The logger prefix.
getProtocol() - Method in interface ratpack.http.Request
The HTTP protocol of the request.
getPublicAddress() - Method in interface ratpack.server.ServerConfig
The public address of the site used for redirects.
getPublisher() - Method in class ratpack.sse.ServerSentEvents
The stream of events.
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.
getRateUnit() - Method in class ratpack.dropwizard.metrics.GraphiteConfig
The state of rate conversion.
getRateUnit() - Method in class ratpack.dropwizard.metrics.Slf4jConfig
The state of the rate time unit.
getRawUri() - Method in interface ratpack.http.Request
The raw URI of the request.
getReadTimeout() - Method in interface ratpack.http.client.HttpClient
The default read timeout value.
getReadTimeout() - Method in interface ratpack.http.client.RequestSpec
Gets the configured socket read timeout.
getReceiveBufferSize() - Method in interface ratpack.server.ServerConfig
getReceivedContentLength() - Method in exception ratpack.http.RequestBodyTooLargeException
 
getRedirects() - Method in interface ratpack.http.client.RequestSpec
Get the configured maximum number of redirects.
getRef() - Method in interface ratpack.exec.Execution
A reference to this execution.
getRegistry() - Method in interface ratpack.exec.ExecResult
Deprecated.
getRegistry() - Method in class ratpack.groovy.handling.GroovyChainAction
The registry that backs this chain.
getRegistry() - Method in interface ratpack.handling.Chain
The registry that backs this chain.
getRegistry() - Method in interface ratpack.server.RatpackServer
Convenience method to provide easy access to the application registry via a server reference
getRegistry() - Method in interface ratpack.server.StartEvent
Deprecated.
The server registry.
getRegistry() - Method in interface ratpack.server.StopEvent
Deprecated.
The server registry.
getRegistry() - Method in interface ratpack.service.StartEvent
The server registry.
getRegistry() - Method in interface ratpack.service.StopEvent
The server registry.
getRegistry() - Method in interface ratpack.test.handling.HandlingResult
The final state of the context registry.
getRegistry() - Method in interface ratpack.test.handling.RequestFixture
A specification of the context registry.
getRemoteAddress() - Method in interface ratpack.http.Request
The address of the client that initiated the request.
getReportDirectory() - Method in class ratpack.dropwizard.metrics.CsvConfig
The directory to output CSV metrics reports to.
getReporterInterval() - Method in class ratpack.dropwizard.metrics.ScheduledReporterConfigSupport
The interval between metrics reports.
getRequest() - Method in interface ratpack.handling.Context
The HTTP request.
getRequest() - Method in interface ratpack.handling.RequestOutcome
The request.
getRequestAmount() - Method in interface ratpack.stream.StreamEvent
The request amount, if this event represents a request.
getRequestMetricGroups() - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig
A map of regular expressions used to group request metrics.
getRequestNum() - Method in interface ratpack.stream.YieldRequest
 
getRequestRegistry() - Method in interface ratpack.test.handling.HandlingResult
The final state of the request registry.
getRequiredConfig() - Method in interface ratpack.server.ServerConfig
The config objects that were declared as required when this server config was built.
getResponse() - Method in interface ratpack.handling.Context
The HTTP response.
getResponse() - Method in interface ratpack.handling.RequestOutcome
The response.
getResponse() - Method in exception ratpack.retrofit.RatpackRetrofitCallException
Get the underlying response that resulted in the exception for this HTTP request.
getResponse() - Method in interface ratpack.test.http.TestHttpClient
 
getResults() - Method in class ratpack.health.HealthCheckResults
The results.
getRight() - Method in class ratpack.func.Pair
The right item of the pair.
getRoot() - Method in interface ratpack.test.embed.EphemeralBaseDir
The root of the base dir.
getRootNode() - Method in interface ratpack.config.ConfigData
 
getScheme() - Method in interface ratpack.server.RatpackServer
The URL scheme the server uses.
getSecretKey() - Method in class ratpack.session.clientside.ClientSideSessionConfig
The secret key used in the symmetric-key encyrption/decryption of the serialized session.
getSecretToken() - Method in class ratpack.session.clientside.ClientSideSessionConfig
The token used to sign the serialized session to prevent tampering.
getSender() - Method in class ratpack.dropwizard.metrics.GraphiteConfig
The GraphiteSender instance.
getSentAt() - Method in interface ratpack.handling.RequestOutcome
The time at when this request was dealt with from the application's point of view.
getSentFile() - Method in interface ratpack.test.handling.HandlingResult
Indicates whether the result of invoking the handler was that it invoked one of the Response.sendFile(java.nio.file.Path) methods.
getServer() - Method in interface ratpack.test.embed.EmbeddedApp
The server for the application.
getServerConfig() - Method in class ratpack.groovy.handling.GroovyChainAction
The server config of the application that this chain is being created for.
getServerConfig() - Method in interface ratpack.guice.BindingsSpec
The launch config for the application.
getServerConfig() - Method in interface ratpack.handling.Chain
The server config of the application that this chain is being created for.
getServerConfig() - Method in interface ratpack.handling.Context
The server configuration for the application.
getServerConfig() - Method in interface ratpack.spring.config.RatpackServerCustomizer
 
getServerConfig() - Method in class ratpack.spring.config.RatpackServerCustomizerAdapter
 
getSession() - Method in interface ratpack.session.SessionData
The corresponding Session object.
getSessionCookieName() - Method in class ratpack.session.clientside.ClientSideSessionConfig
The name of the cookie used to store serialized and encrypted session data.
getSessionTimeout() - Method in class ratpack.spring.config.RatpackProperties
 
getShort(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getShortLE(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getSize() - Method in interface ratpack.exec.Throttle
The size of this throttle.
getSlf4j() - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig
Get the settings for the Slf4j Logger metrics publisher.
getSslContext() - Method in interface ratpack.http.client.RequestSpec
Get the configured SslContext used for client and server SSL authentication.
getSslContext() - Method in interface ratpack.server.ServerConfig
Deprecated.
getStartDelimiter() - Method in class ratpack.handlebars.HandlebarsModule.Config
 
getStatus() - Method in interface ratpack.http.client.HttpResponse
 
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.HandlingResult
The response status information.
getStatusCode() - Method in interface ratpack.http.client.HttpResponse
 
getStreamInterval() - Method in class ratpack.hystrix.HystrixModule.Config
The configured stream interval in seconds;
getSubscriberNum() - Method in interface ratpack.stream.YieldRequest
 
getSubscriptionId() - Method in interface ratpack.stream.StreamEvent
The opaque id of the subscription that this event relates to.
getTemplatesCacheSize() - Method in class ratpack.thymeleaf.ThymeleafModule.Config
The size of the templates cache.
getTemplatesCacheSize() - Method in class ratpack.thymeleaf.ThymeleafModule
 
getTemplatesDirectory() - Method in class ratpack.groovy.template.MarkupTemplateModule.Config
 
getTemplatesMode() - Method in class ratpack.thymeleaf.ThymeleafModule.Config
The mode for templates.
getTemplatesMode() - Method in class ratpack.thymeleaf.ThymeleafModule
 
getTemplatesPath() - Method in class ratpack.groovy.template.TextTemplateModule.Config
 
getTemplatesPath() - Method in class ratpack.handlebars.HandlebarsModule.Config
 
getTemplatesPath() - Method in class ratpack.spring.config.RatpackProperties
 
getTemplatesPrefix() - Method in class ratpack.thymeleaf.ThymeleafModule.Config
The prefix for templates.
getTemplatesPrefix() - Method in class ratpack.thymeleaf.ThymeleafModule
 
getTemplatesSuffix() - Method in class ratpack.handlebars.HandlebarsModule.Config
 
getTemplatesSuffix() - Method in class ratpack.thymeleaf.ThymeleafModule.Config
The suffix for templates.
getTemplatesSuffix() - Method in class ratpack.thymeleaf.ThymeleafModule
 
getText() - Method in interface ratpack.http.TypedData
The data as text.
getText(Charset) - Method in interface ratpack.http.TypedData
 
getText() - Method in interface ratpack.test.http.TestHttpClient
A convenience method for doing a GET request then calling ReceivedResponse.getBody() then TypedData.getText().
getText(String) - Method in interface ratpack.test.http.TestHttpClient
A convenience method for doing a GET request then calling ReceivedResponse.getBody() then TypedData.getText().
getText() - Method in interface ratpack.websocket.WebSocketMessage
 
getThreads() - Method in interface ratpack.server.ServerConfig
The number of threads for handling application requests.
getThrottle() - Method in class ratpack.health.HealthCheckHandler
The throttle for executing health checks.
getThrowable() - Method in interface ratpack.exec.Result
The error exception.
getThrowable() - Method in interface ratpack.stream.StreamEvent
The error, if this event represents an error.
getTimeout() - Method in class ratpack.hikari.HikariHealthCheck
 
getTimestamp() - Method in interface ratpack.http.Request
The timestamp for when this request was received.
getTokens() - Method in interface ratpack.path.PathBinding
Any tokens that the binding has extracted from the path.
getType() - Method in interface ratpack.config.ConfigObject
The raw type of the config item.
getType() - Method in class ratpack.groovy.template.TextTemplate
 
getType() - Method in interface ratpack.http.MediaType
The type without parameters.
getType() - Method in exception ratpack.parse.NoSuchParserException
The target type.
getType() - Method in class ratpack.parse.Parse
The type of object to construct from the request body.
getType() - Method in interface ratpack.render.RenderableDecorator
The type of objects that this decorator decorates.
getType() - Method in class ratpack.render.RenderableDecoratorSupport
The type of objects that this decorator decorates.
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).
getType() - Method in interface ratpack.session.SessionKey
The type.
getTypeToken() - Method in interface ratpack.config.ConfigObject
The complete type of the config item.
getUnsignedByte(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getUnsignedInt(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getUnsignedIntLE(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getUnsignedMedium(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getUnsignedMediumLE(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getUnsignedShort(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getUnsignedShortLE(int) - Method in class ratpack.bytebuf.ByteBufRef
 
getUri() - Method in interface ratpack.http.client.RequestSpec
The request URI.
getUri() - Method in interface ratpack.http.Request
The complete URI of the request (path + query string).
getUrl() - Method in interface ratpack.http.client.RequestSpec
Deprecated.
since 1.4, use RequestSpec.getUri()
getValue() - Method in interface ratpack.exec.Result
The result value.
getValue() - Method in interface ratpack.session.SessionId
Get the session ID value, generating a new one if necessary.
getValueOrThrow() - Method in interface ratpack.exec.Result
Returns the value if this is a success result, or throws the exception if it's an error.
getVersion() - Static method in class ratpack.util.RatpackVersion
The version of Ratpack.
getViewClass() - Method in interface ratpack.jackson.JsonRender
The view class to use when rendering the object.
getWaiting() - Method in interface ratpack.exec.Throttle
The number of throttled promises that are waiting to execute (that is, the queue size).
getWebSocket() - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig
Get the settings for the websockets metrics broadcaster.
getWriteSpinCount() - Method in interface ratpack.server.ServerConfig
The maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.
GONE - Static variable in interface ratpack.http.Status
The 410 status code.
graphite(Action<? super GraphiteConfig>) - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig
Configure the Graphite metrics publisher.
GraphiteConfig - Class in ratpack.dropwizard.metrics
A Configuration implementation to setup GraphiteReporter instances.
GraphiteConfig() - Constructor for class ratpack.dropwizard.metrics.GraphiteConfig
 
Groovy - Class in ratpack.groovy
Static methods for specialized Groovy integration.
Groovy.Ratpack - Interface in ratpack.groovy
The definition of a Groovy Ratpack application.
Groovy.Script - Class in ratpack.groovy
Methods for working with Groovy scripts as application components.
GroovyByContentSpec - Interface in ratpack.groovy.handling
A Groovy oriented content negotiation handler builder.
GroovyByMethodSpec - Interface in ratpack.groovy.handling
A Groovy oriented multi-method handler builder.
GroovyChain - Interface in ratpack.groovy.handling
A Groovy oriented handler chain builder DSL.
GroovyChainAction - Class in ratpack.groovy.handling
A convenience super class for a standalone implementation of a Action<GroovyChain>.
GroovyChainAction() - Constructor for class ratpack.groovy.handling.GroovyChainAction
 
GroovyContext - Interface in ratpack.groovy.handling
Subclass of Context that adds Groovy friendly variants of methods.
GroovyEmbeddedApp - Interface in ratpack.groovy.test.embed
A more Groovy version of EmbeddedApp.
groovyHandler(Closure<?>) - Static method in class ratpack.groovy.Groovy
Creates a handler instance from a closure.
GroovyHandler - Class in ratpack.groovy.handling
A handler subclass that makes a GroovyContext available.
GroovyHandler() - Constructor for class ratpack.groovy.handling.GroovyHandler
 
groovyMarkupTemplate(String) - Static method in class ratpack.groovy.Groovy
Creates a renderable Groovy based markup template, using no model and the default content type.
groovyMarkupTemplate(String, String) - Static method in class ratpack.groovy.Groovy
Creates a renderable Groovy based markup template, using no model.
groovyMarkupTemplate(Map<String, ?>, String) - Static method in class ratpack.groovy.Groovy
Creates a renderable Groovy based markup template, using the default content type.
groovyMarkupTemplate(String, Action<? super ImmutableMap.Builder<String, Object>>) - Static method in class ratpack.groovy.Groovy
Creates a renderable Groovy based markup template, using the default content type.
groovyMarkupTemplate(String, String, Action<? super ImmutableMap.Builder<String, Object>>) - Static method in class ratpack.groovy.Groovy
Creates a renderable Groovy based markup template.
groovyMarkupTemplate(Map<String, ?>, String, String) - Static method in class ratpack.groovy.Groovy
Creates a renderable Groovy based template.
GroovyRatpackMain - Class in ratpack.groovy
A boilerplate entry point, which combines RatpackServer.start(ratpack.func.Action) and Groovy.Script.app().
GroovyRatpackMain() - Constructor for class ratpack.groovy.GroovyRatpackMain
 
GroovyRatpackMainApplicationUnderTest - Class in ratpack.groovy.test
 
GroovyRatpackMainApplicationUnderTest() - Constructor for class ratpack.groovy.test.GroovyRatpackMainApplicationUnderTest
 
GroovyRatpackServerSpec - Interface in ratpack.groovy.server
 
GroovyRendererSupport<T> - Class in ratpack.groovy.render
A specialisation of RendererSupport that makes a GroovyContext available.
GroovyRendererSupport() - Constructor for class ratpack.groovy.render.GroovyRendererSupport
 
GroovyRequestFixture - Interface in ratpack.groovy.test.handling
A more Groovy friendly version of RequestFixture.
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
Creates a renderable Groovy based template.
Gson - Class in ratpack.gson
Support for rendering and parsing JSON using Google's Gson library.
GsonModule - Class in ratpack.gson
Registers JSON parsing and rendering support using Google's Gson library.
GsonModule() - Constructor for class ratpack.gson.GsonModule
 
GsonParseOpts - Interface in ratpack.gson
Parsing configuration for Google's Gson library.
GsonRender - Interface in ratpack.gson
A renderable object wrapper for rendering as JSON.
Guice - Class in ratpack.guice
Static utility methods for creating Google Guice based Ratpack infrastructure.
A B C D E F G H I J L M N O P R S T U V W X Y 
Skip navigation links