Index

A B C D E F G H I J L M N O P R S T U V W X 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

acceptInboundMessage(Object) - Method in class com.mastfrog.acteur.ChunkHandler
 
Acteur - Class in com.mastfrog.acteur
A single piece of logic which can Reject an HTTP request Validate an HTTP request and allow the next Acteur in the chain to process it Initiate an HTTP response Acteurs are aggregated into a list in a Page.
Acteur() - Constructor for class com.mastfrog.acteur.Acteur
Create an acteur; subclasses should simply list objects they need for processing the request as arguments, and they will be injected by Guice, either from bindings the application was set up with, or objects provided by other Acteurs which have already been run for this request.
Acteur.ConsumedLockedState - Class in com.mastfrog.acteur
 
Acteur.ConsumedState - Class in com.mastfrog.acteur
State indicating that this acteur chain is taking responsibility for responding to the request.
Acteur.Delegate - Interface in com.mastfrog.acteur
If you write an acteur which delegates to another one, implement this so that that other one's changes to the response will be picked up.
Acteur.RejectedState - Class in com.mastfrog.acteur
A state indicating the acteur neither accepts nor definitively refuses a request.
Acteur.RespondWith - Class in com.mastfrog.acteur
A shorthand state for responding with a particular http response code and optional message, which if non-string, will be rendered as JSON.
ActeurFactory - Class in com.mastfrog.acteur
Factory for standard Acteur implementations, mainly used to determine if a request is valid (matches a URL, is using a supported HTTP method, etc.).
ActeurFactory() - Constructor for class com.mastfrog.acteur.ActeurFactory
 
ActeurFactory.Test - Interface in com.mastfrog.acteur
A test which can be performed on a request, for example, to decide about branching
ActeurSslConfig - Class in com.mastfrog.acteur.server
Provides a default implementation using self-signed certificates, but may be bound to provide your own.
ActeurSslConfig() - Constructor for class com.mastfrog.acteur.server.ActeurSslConfig
 
add(Module) - Method in class com.mastfrog.acteur.server.ServerBuilder
Add a module which should be used for Guice bindings
add(Module) - Method in class com.mastfrog.acteur.server.ServerModule
Add another module to be installed with this one
add(Acteur) - Method in class com.mastfrog.acteur.Page
 
add(HeaderValueType<T>, T) - Method in class com.mastfrog.acteur.Acteur
 
add(HeaderValueType<T>, T) - Method in class com.mastfrog.acteur.Response
Add a header
add(HttpEvent) - Method in interface com.mastfrog.acteur.auth.Tarpit
Add an entry to the tarpit for failing to authenticate, incrementing the count if necessary.
add(Page) - Method in class com.mastfrog.acteur.Application
 
add(Settings) - Method in class com.mastfrog.acteur.server.ServerBuilder
Explicitly add a Settings which should be used for resolving @Named bindings, in addition to any bound to the namespace (i.e.
add(Class<? extends Module>) - Method in class com.mastfrog.acteur.server.ServerBuilder
Add a module type which will be instantiated.
add(Class<? extends Acteur>) - Method in class com.mastfrog.acteur.Page
 
add(Class<? extends Page>) - Method in class com.mastfrog.acteur.Application
Add a subtype of Page which should be instantiated on demand when responding to requests
add(Runnable) - Method in class com.mastfrog.acteur.Closables
 
add(R) - Method in class com.mastfrog.acteur.Closables
 
add(T) - Method in class com.mastfrog.acteur.Closables
 
addIfUnset(HeaderValueType<T>, T) - Method in class com.mastfrog.acteur.Response
 
AGGREGATOR - Static variable in interface com.mastfrog.acteur.server.PipelineDecorator
Name of the pipeline's HttpObjectAggregator
ALL - Enum constant in enum com.mastfrog.acteur.preconditions.RequiredUrlParameters.Combination
 
allowDecimal() - Element in annotation type com.mastfrog.acteur.preconditions.ParametersMustBeNumbersIfPresent
 
allowNegative() - Element in annotation type com.mastfrog.acteur.preconditions.ParametersMustBeNumbersIfPresent
 
AnnotationDescriptionPlugin(Class<T>, HelpGenerator) - Constructor for class com.mastfrog.acteur.HelpGenerator.AnnotationDescriptionPlugin
 
Application - Class in com.mastfrog.acteur
A web application.
Application() - Constructor for class com.mastfrog.acteur.Application
 
Application(Class<?>...) - Constructor for class com.mastfrog.acteur.Application
Create an application, optionally passing in an array of page types (you can also call add() to add them).
applicationClass(Class<? extends Application>) - Method in class com.mastfrog.acteur.server.ServerBuilder
Set the class of the application.
ApplicationControl - Interface in com.mastfrog.acteur.spi
SPI interface which the request handling infrastructure uses to dispatch events to and otherwise manage the application.
applicationScope() - Method in class com.mastfrog.acteur.server.ServerModule
Get the Guice scope used for injecting dynamic request-related objects into Acteur constructors.
appType - Variable in class com.mastfrog.acteur.server.ServerModule
 
as(Class<T>) - Method in class com.mastfrog.acteur.DeferredComputationResult
Get the payload as a specific type.
AsyncAuthenticationModule<AuthInfoType> - Class in com.mastfrog.acteur.auth
Configures an acteur application for asynchronous authentication.
AsyncAuthenticationModule(Class<? extends AuthInfoType>, Class<? extends AsyncAuthenticator<AuthInfoType>>, ReentrantScope) - Constructor for class com.mastfrog.acteur.auth.AsyncAuthenticationModule
 
AsyncAuthenticator<T> - Interface in com.mastfrog.acteur.auth
Asynchronous authenticator.
AT_LEAST_ONE - Enum constant in enum com.mastfrog.acteur.preconditions.RequiredUrlParameters.Combination
 
authenticate(RequestID, HttpEvent, String) - Method in interface com.mastfrog.acteur.auth.AsyncAuthenticator
Authenticate a request, returning a completion stage which will resume the acteur chain when completed.
authenticate(String, BasicCredentials) - Method in interface com.mastfrog.acteur.auth.Authenticator
Handles authentication, saying yea or nay.
AuthenticateBasicActeur - Class in com.mastfrog.acteur.auth
Deprecated.
Do not use directly - bind AuthenticationActeur instead, so that authentication strategies are pluggable
AuthenticateBasicActeur.AuthenticationDecorator - Interface in com.mastfrog.acteur.auth
Deprecated.
Decorator which can do things to the response on authentication succeess/failure, such as setting/clearing cookies
Authenticated - Annotation Type in com.mastfrog.acteur.preconditions
Indicates that this endpoint requires authentication using whatever mechanism is configured (by default, HTTP Basic Auth - you should implement and bind Authenticator to use it).
AuthenticatedIf - Annotation Type in com.mastfrog.acteur.preconditions
Marks an endpoint as authenticated if the named setting is set to true.
AuthenticationActeur - Class in com.mastfrog.acteur.auth
 
AuthenticationActeur() - Constructor for class com.mastfrog.acteur.auth.AuthenticationActeur
 
AuthenticationResult<T> - Class in com.mastfrog.acteur.auth
Result of asynchronous authentication, injectable into subsequent acteurs.
AuthenticationResult(HttpResponseStatus, String) - Constructor for class com.mastfrog.acteur.auth.AuthenticationResult
 
AuthenticationResult(HttpResponseStatus, String, String) - Constructor for class com.mastfrog.acteur.auth.AuthenticationResult
 
AuthenticationResult(String) - Constructor for class com.mastfrog.acteur.auth.AuthenticationResult
 
AuthenticationResult(String, String) - Constructor for class com.mastfrog.acteur.auth.AuthenticationResult
 
AuthenticationResult(T, HttpResponseStatus, String, String) - Constructor for class com.mastfrog.acteur.auth.AuthenticationResult
 
AuthenticationResult(T, String) - Constructor for class com.mastfrog.acteur.auth.AuthenticationResult
 
Authenticator - Interface in com.mastfrog.acteur.auth
 

B

BACKGROUND_THREAD_POOL_NAME - Static variable in class com.mastfrog.acteur.server.ServerModule
Name of the @Named parameter that should be used in an annotation if you want Guice to inject the specific thread pool used for processing requests.
BACKGROUND_THREADS - Static variable in class com.mastfrog.acteur.server.ServerModule
Deprecated.
badRequest() - Method in class com.mastfrog.acteur.Acteur
 
badRequest(Object) - Method in class com.mastfrog.acteur.Acteur
 
badRequest(String) - Static method in class com.mastfrog.acteur.errors.Err
 
BannedUrlParameters - Annotation Type in com.mastfrog.acteur.preconditions
 
banParameters(String...) - Method in class com.mastfrog.acteur.ActeurFactory
Reject request which contain the passed parameters
Base(String, int, T) - Constructor for class com.mastfrog.acteur.auth.SimpleUser.Base
 
Base(String, int, T, String) - Constructor for class com.mastfrog.acteur.auth.SimpleUser.Base
 
BASE_PATH_SETTINGS_KEY - Static variable in interface com.mastfrog.acteur.server.PathFactory
Deprecated.
use @link{ServerModule.SETTINGS_KEY_BASE_PATH}
BasicAuth - Annotation Type in com.mastfrog.acteur.preconditions
Deprecated.
Use @Authenticated instead
branch(Class<? extends Acteur>, Class<? extends Acteur>, ActeurFactory.Test) - Method in class com.mastfrog.acteur.ActeurFactory
 
build() - Method in class com.mastfrog.acteur.server.ServerBuilder
Build a Server object which can be started with its start() method (call await() on the resulting ServerControl object to keep it running).
BuiltInPageAnnotationHandler - Class in com.mastfrog.acteur
Processes the page annotations in com.mastfrog.acteur.preconditions and adds acteurs to the list appropriately.
BYTEBUF_ALLOCATOR_SETTINGS_KEY - Static variable in class com.mastfrog.acteur.server.ServerModule
Property name for setting which byte buffer allocator Netty uses (heap, direct, pooled).

C

category() - Element in annotation type com.mastfrog.acteur.preconditions.Description
 
CHAIN_KEY - Static variable in class com.mastfrog.acteur.websocket.WebSocketUpgradeActeur
 
channel() - Method in interface com.mastfrog.acteur.Event
Get the Netty channel this request is travelling through.
channel() - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 
channel() - Method in class com.mastfrog.acteur.server.WebSocketEvent
 
channelFactory() - Method in class com.mastfrog.acteur.server.EventLoopFactory
 
channelRead(ChannelHandlerContext, Object) - Method in class com.mastfrog.acteur.server.UnknownNetworkEventHandler
 
channelRead0(ChannelHandlerContext, Object) - Method in class com.mastfrog.acteur.ChunkHandler
 
channelType() - Method in class com.mastfrog.acteur.server.EventLoopFactory
 
CheckIfModifiedSinceHeader - Class in com.mastfrog.acteur
Convenience Acteur which compares the current Page's Date against the current request's If-Modified-Since header and returns a 304 response if the browser's cached version is current.
CheckIfNoneMatchHeader - Class in com.mastfrog.acteur
Convenience Acteur which compares the current Page's ETag against the current request's If-None-Match header and returns a 304 response if the browser's cached version is current.
CheckIfUnmodifiedSinceHeader - Class in com.mastfrog.acteur
 
chunked() - Method in class com.mastfrog.acteur.Response
Set this response to be chunked.
chunked(boolean) - Method in class com.mastfrog.acteur.Response
Set chunked encoding - if set to true, the headers will indicate that chunked encoding will be used and no Content-Length header will be sent.
ChunkHandler - Class in com.mastfrog.acteur
Subclasses of this can be used from the @Early annotation to provide an object that will process inbound HTTP chunks.
ChunkHandler() - Constructor for class com.mastfrog.acteur.ChunkHandler
 
Closables - Class in com.mastfrog.acteur
A registry of resources (for example, streams or JDBC objects) which should be closed if the connection terminates while a response is being processed.
codec - Variable in class com.mastfrog.acteur.ContentConverter
 
com.mastfrog.acteur - package com.mastfrog.acteur
Acteur
com.mastfrog.acteur.annotations - package com.mastfrog.acteur.annotations
 
com.mastfrog.acteur.auth - package com.mastfrog.acteur.auth
 
com.mastfrog.acteur.debug - package com.mastfrog.acteur.debug
 
com.mastfrog.acteur.errors - package com.mastfrog.acteur.errors
 
com.mastfrog.acteur.preconditions - package com.mastfrog.acteur.preconditions
 
com.mastfrog.acteur.server - package com.mastfrog.acteur.server
 
com.mastfrog.acteur.spi - package com.mastfrog.acteur.spi
 
com.mastfrog.acteur.websocket - package com.mastfrog.acteur.websocket
 
combination() - Element in annotation type com.mastfrog.acteur.preconditions.RequiredUrlParameters
 
compareTo(ExceptionEvaluator) - Method in class com.mastfrog.acteur.errors.ExceptionEvaluator
 
COMPRESSOR - Static variable in interface com.mastfrog.acteur.server.PipelineDecorator
Name of the pipeline's compressor, if any
Concluders - Annotation Type in com.mastfrog.acteur.annotations
Annotation which is only useful on Acteurs with the HttpCall annotation to trigger page source generation, which specifies some more Acteurs to run after the annotated one.
configure() - Method in class com.mastfrog.acteur.annotations.GenericApplicationModule
 
configure() - Method in class com.mastfrog.acteur.auth.AsyncAuthenticationModule
 
configure() - Method in class com.mastfrog.acteur.server.ServerModule
 
configureBootstrap(ServerBootstrap) - Method in class com.mastfrog.acteur.server.EventLoopFactory
 
configureServerBootstrap(ServerBootstrap, Settings) - Method in interface com.mastfrog.acteur.server.ServerBootstrapConfigurer
 
configureServerBootstrap(ServerBootstrap, Settings) - Method in class com.mastfrog.acteur.server.ServerModule
Deprecated.
Bind an instance of ServerBootstrapConfigurer instead
conflict(String) - Static method in class com.mastfrog.acteur.errors.Err
 
connected(HttpEvent, Channel) - Method in interface com.mastfrog.acteur.websocket.OnWebsocketConnect
Called on connection success.
constructURI(String) - Method in interface com.mastfrog.acteur.server.PathFactory
 
constructURI(String, HttpEvent) - Method in interface com.mastfrog.acteur.server.PathFactory
 
constructURL(Path) - Method in interface com.mastfrog.acteur.server.PathFactory
Generate a URL to this application, using the path and the system default for whether to use http or https.
constructURL(Path, boolean) - Method in interface com.mastfrog.acteur.server.PathFactory
Construct a URL suitable for external use, inserting the basepath and host name if necessary.
constructURL(Protocol, Path) - Method in interface com.mastfrog.acteur.server.PathFactory
Construct a URL suitable for external use, inserting the basepath and host name if necessary.
constructURL(Protocol, Path, boolean) - Method in interface com.mastfrog.acteur.server.PathFactory
 
constructURL(Protocol, Path, int) - Method in interface com.mastfrog.acteur.server.PathFactory
 
constructURL(String) - Method in interface com.mastfrog.acteur.server.PathFactory
Generate a URL to this application, using the path and the system default for whether to use http or https.
constructURL(String, HttpEvent) - Method in interface com.mastfrog.acteur.server.PathFactory
Generate a URL to this application, using the path and the system default for whether to use http or https.
ConsumedLockedState(Object...) - Constructor for class com.mastfrog.acteur.Acteur.ConsumedLockedState
 
ConsumedState(Object...) - Constructor for class com.mastfrog.acteur.Acteur.ConsumedState
 
content() - Method in interface com.mastfrog.acteur.Event
Get the raw request body, if any.
content() - Method in class com.mastfrog.acteur.server.WebSocketEvent
 
content(Object) - Method in class com.mastfrog.acteur.Response
Set a simple string message
ContentConverter - Class in com.mastfrog.acteur
Converts byte buffers and maps to objects
ContentConverter(Codec, Provider<Charset>, Dependencies) - Constructor for class com.mastfrog.acteur.ContentConverter
 
ContentConverter.ContentValidationPlugin - Class in com.mastfrog.acteur
 
ContentValidationPlugin(ContentConverter, Class<?>...) - Constructor for class com.mastfrog.acteur.ContentConverter.ContentValidationPlugin
 
ContentValidationPlugin(ContentConverter, Iterable<Class<?>>) - Constructor for class com.mastfrog.acteur.ContentConverter.ContentValidationPlugin
 
ContentValidationPlugin(ContentConverter, String...) - Constructor for class com.mastfrog.acteur.ContentConverter.ContentValidationPlugin
 
ContentValidationPlugin(ContentConverter, Set<String>) - Constructor for class com.mastfrog.acteur.ContentConverter.ContentValidationPlugin
 
contentWriter(ResponseWriter) - Method in class com.mastfrog.acteur.Response
Set a ResponseWriter which will be called after headers are written and flushed to the socket; this will cause chunked encoding to be used; the ResponseWriter will be called back repeatedly to stream more of the response until it says that it is done.
contentWriter(ChannelFutureListener) - Method in class com.mastfrog.acteur.Response
Set a ChannelFutureListener which will be called after headers are written and flushed to the socket; prefer setResponseWriter() to this method unless you are not using chunked encoding and want to stream your response (in which case, be sure to chunked(false) or you will have encoding errors).
continueAfter(boolean, CompletionStage<?>...) - Method in class com.mastfrog.acteur.Acteur
Continue the Acteur chain, running any subsequent acteurs, once the passed CompletionStages (e.g.
continueAfter(ThrowingConsumer<EnhCompletableFuture<T>>) - Method in class com.mastfrog.acteur.Acteur
Continue the acteur chain once the completable future passed to the passed consumer is consumed.
continueAfter(CompletionStage<?>...) - Method in class com.mastfrog.acteur.Acteur
Continue the Acteur chain, running any subsequent acteurs, once the passed CompletionStages (e.g.
CORS - Annotation Type in com.mastfrog.acteur.preconditions
Marks endpoints that should have CORS headers associated with it.
corsEnabled - Variable in class com.mastfrog.acteur.annotations.GenericApplication.GenericApplicationSettings
 
CORSResponseDecorator - Interface in com.mastfrog.acteur
Decorates cors responses.
count(HttpEvent) - Method in interface com.mastfrog.acteur.auth.Tarpit
Get the number of bad requests
create(HttpResponseStatus, T) - Static method in interface com.mastfrog.acteur.errors.ErrorResponse
 
create(Class<?>...) - Static method in class com.mastfrog.acteur.Application
Create an application
createFallbackResponse(Throwable) - Method in interface com.mastfrog.acteur.FailureResponseFactory
 
createKey(HttpEvent) - Method in class com.mastfrog.acteur.auth.TarpitCacheKeyFactory
Construct a cache key
createNotFoundResponse(Event<?>) - Method in class com.mastfrog.acteur.Application
Create a 404 response
createNotFoundResponse(Event<?>) - Method in interface com.mastfrog.acteur.FailureResponseFactory
 
createObjectFor(Map<String, ?>, Class<T>) - Method in class com.mastfrog.acteur.ContentConverter
 
createProxyFor(Map<String, ?>, Class<T>) - Method in class com.mastfrog.acteur.ContentConverter
 
createSslContext() - Method in class com.mastfrog.acteur.server.ActeurSslConfig
 
ctx() - Method in interface com.mastfrog.acteur.Event
 
ctx() - Method in class com.mastfrog.acteur.server.WebSocketEvent
 
CUSTOMIZED_POOLED_ALLOCATOR - Static variable in class com.mastfrog.acteur.server.ServerModule
Property value for telling the server to use the pooled byte buffer allocator with custom settings.

D

decode() - Element in annotation type com.mastfrog.acteur.preconditions.Path
 
decode() - Element in annotation type com.mastfrog.acteur.preconditions.PathRegex
 
decodedUrlParameter(String) - Method in interface com.mastfrog.acteur.HttpEvent
 
DECODER - Static variable in interface com.mastfrog.acteur.server.PipelineDecorator
Name of the pipeline's HttpObjectDecoder
deConstantNameify(String) - Method in class com.mastfrog.acteur.HelpGenerator.AnnotationDescriptionPlugin
Convert typical Java constant naming conventions - e.g.
decorateApplicationResponse(HttpResponse) - Method in interface com.mastfrog.acteur.CORSResponseDecorator
Adds headers to application-level responses such as Not Found and errors
decorateApplicationResponse(HttpResponse, Page) - Method in interface com.mastfrog.acteur.CORSResponseDecorator
 
decorateCorsPreflight(HttpEvent, Response, Page) - Method in interface com.mastfrog.acteur.CORSResponseDecorator
Adds headers to an acteur response.
decorateResponse(Event<?>, Page, Acteur, HttpResponse) - Method in class com.mastfrog.acteur.Application
Deprecated.
Use onBeforeSendResponse instead
DEFAULT_ALLOCATOR - Static variable in class com.mastfrog.acteur.server.ServerModule
The default allocator to use if none is specified
DEFAULT_COMPRESSION_LEVEL - Static variable in class com.mastfrog.acteur.server.ServerModule
Default value for settings key compression.level
DEFAULT_COMPRESSION_MEMORY_LEVEL - Static variable in class com.mastfrog.acteur.server.ServerModule
Default value for settings key compression.memory.level
DEFAULT_COMPRESSION_THRESHOLD - Static variable in class com.mastfrog.acteur.server.ServerModule
Default value for settings key compression.threshold
DEFAULT_COMPRESSION_WINDOW_BITS - Static variable in class com.mastfrog.acteur.server.ServerModule
Default value for settings key compression.window.bits
DEFAULT_CORS_ALLOW_CREDENTIALS - Static variable in class com.mastfrog.acteur.server.ServerModule
Default value for
DEFAULT_CORS_ALLOW_ORIGIN - Static variable in class com.mastfrog.acteur.server.ServerModule
Default value for @link(ServerModule.SETTINGS_KEY_CORS_ALLOW_ORIGIN}.
DEFAULT_CORS_ENABLED - Static variable in class com.mastfrog.acteur.server.ServerModule
Default value for @link(ServerModule.SETTINGS_KEY_CORS_ENABLED}.
DEFAULT_CORS_MAX_AGE_MINUTES - Static variable in class com.mastfrog.acteur.server.ServerModule
Default value for @link(ServerModule.SETTINGS_KEY_CORS_MAX_AGE_MINUTES}.
DEFAULT_DISABLE_LEAK_DETECTOR - Static variable in class com.mastfrog.acteur.server.ServerModule
 
DEFAULT_FAILED_LOGIN_ATTEMPT_DELAY_THRESHOLD - Static variable in class com.mastfrog.acteur.auth.AuthenticateBasicActeur
Deprecated.
 
DEFAULT_FAILED_LOGIN_ATTEMPT_LIMIT - Static variable in class com.mastfrog.acteur.auth.AuthenticateBasicActeur
Deprecated.
 
DEFAULT_FAILED_LOGIN_DELAY_SECONDS_MULTIPLIER - Static variable in class com.mastfrog.acteur.auth.AuthenticateBasicActeur
Deprecated.
 
DEFAULT_TARPIT_EXPIRATION_TIME_MINUTES - Static variable in interface com.mastfrog.acteur.auth.Tarpit
 
DEFAULT_TCP_NODELAY - Static variable in class com.mastfrog.acteur.server.ServerModule
Default value for TCP_NODELAY for outbound connections.
DEFAULT_WEBSOCKET_ENABLED - Static variable in class com.mastfrog.acteur.server.ServerModule
 
DEFAULT_WEBSOCKET_FRAME_MAX_LENGTH - Static variable in class com.mastfrog.acteur.websocket.WebSocketUpgradeActeur
 
DEFAULT_WEBSOCKET_SECURE_PROTOCOL - Static variable in class com.mastfrog.acteur.websocket.WebSocketUpgradeActeur
 
defer() - Method in class com.mastfrog.acteur.Acteur
Pause the Acteur chain until external code completes the returned CompletableFuture, then restart the acteur chain with the result of the computation available for injection into subsequent acteurs.
DEFERRED - Enum constant in enum com.mastfrog.acteur.ResponseWriter.Status
Don't call the object returing this value back - it will take care of writing more output and closing the channel when done.
DeferredComputationResult - Class in com.mastfrog.acteur
Encapsulates either an object indicating success, or a throwable indicating failure, which is written to a response using DeferredComputationResultActeur (added automatically to the chain if you use Acteur.then(CompletableFuture).
DeferredComputationResultActeur - Class in com.mastfrog.acteur
 
deferThenRespond() - Method in class com.mastfrog.acteur.Acteur
Pause the Acteur chain until external code completes the returned CompletableFuture, then use the result of that computation as the response (JSON or whatever the application is configured to marshal responses to).
deferThenRespond(HttpResponseStatus) - Method in class com.mastfrog.acteur.Acteur
Pause the Acteur chain until external code completes the returned CompletableFuture, then use the result of that computation as the response (JSON or whatever the application is configured to marshal responses to).
DELAY_EXECUTOR - Static variable in class com.mastfrog.acteur.server.ServerModule
Guice binding for @Named(DELAY_EXECUTOR) ScheduledExecutorService to get a scheduled executor service which shares a ThreadFactory with the worker thread pool.
delayedBy(Duration) - Method in class com.mastfrog.acteur.Response
Set a delay before the response body should be sent; this is used for cases such as authentication where failed requests should be throttled.
dependencies() - Method in class com.mastfrog.acteur.Acteur
 
describeYourself(Map<String, Object>) - Method in class com.mastfrog.acteur.Acteur
Provide a description used in help-page generation.
describeYourself(Map<String, Object>) - Method in class com.mastfrog.acteur.auth.AuthenticateBasicActeur
Deprecated.
 
describeYourself(Map<String, Object>) - Method in class com.mastfrog.acteur.CheckIfModifiedSinceHeader
 
describeYourself(Map<String, Object>) - Method in class com.mastfrog.acteur.CheckIfNoneMatchHeader
 
describeYourself(Map<String, Object>) - Method in class com.mastfrog.acteur.CheckIfUnmodifiedSinceHeader
 
description() - Element in annotation type com.mastfrog.acteur.preconditions.Examples.Case
The description of this use case, if any.
Description - Annotation Type in com.mastfrog.acteur.preconditions
Provide a description for a page or acteur which will be used by Application.getHelpPageType() to provide an API-level help call.
DIRECT_ALLOCATOR - Static variable in class com.mastfrog.acteur.server.ServerModule
Property value for telling the server to use the direct byte buffer allocator (non-heap).
DIRECT_OR_HEAP_BY_PLATFORM - Static variable in class com.mastfrog.acteur.server.ServerModule
Property value for telling the server to use the heap or direct byte buffer allocator as decided by Netty's PlatformDependent class.
disableBindings(SettingsBindings...) - Method in class com.mastfrog.acteur.server.ServerBuilder
Disable binding of settings to some types if you know they will not be used, to save (minimal) memory.
disableCORS() - Method in class com.mastfrog.acteur.server.ServerBuilder
 
disableHelp() - Method in class com.mastfrog.acteur.server.ServerBuilder
 
displayName() - Method in class com.mastfrog.acteur.auth.SimpleUser.Base
 
displayName() - Method in interface com.mastfrog.acteur.auth.SimpleUser
Get a human-readable display name, falling back to the name if none is set
DONE - Enum constant in enum com.mastfrog.acteur.ResponseWriter.Status
 

E

Early - Annotation Type in com.mastfrog.acteur.annotations
Annotate an Acteur with this, to have it run as soon as the headers are received, disabling chunk aggregation.
empty() - Static method in class com.mastfrog.acteur.DeferredComputationResult
 
enableCORS() - Method in class com.mastfrog.acteur.server.ServerBuilder
 
enableDefaultCorsHandling() - Method in class com.mastfrog.acteur.Application
 
enableDefaultCorsHandling() - Method in interface com.mastfrog.acteur.spi.ApplicationControl
 
enableHelp() - Method in class com.mastfrog.acteur.server.ServerBuilder
 
enableOnlyBindingsFor(SettingsBindings...) - Method in class com.mastfrog.acteur.server.ServerBuilder
Explicitly set the list of types that are bound to settings to save (minimal) memory.
ENCODER - Static variable in interface com.mastfrog.acteur.server.PipelineDecorator
Name of the pipeline's HttpObjectEncoder
equals(Object) - Method in class com.mastfrog.acteur.auth.SimpleUser.Base
 
equals(Object) - Method in class com.mastfrog.acteur.errors.ExceptionEvaluator
 
Err - Class in com.mastfrog.acteur.errors
Convenience implementation of ErrorResponse backed by a map, with constructors for various common scenarios.
Err(HttpResponseStatus, String) - Constructor for class com.mastfrog.acteur.errors.Err
 
Err(HttpResponseStatus, Map<String, Object>) - Constructor for class com.mastfrog.acteur.errors.Err
 
Err(String) - Constructor for class com.mastfrog.acteur.errors.Err
 
Err(Throwable) - Constructor for class com.mastfrog.acteur.errors.Err
 
Err(Throwable, boolean) - Constructor for class com.mastfrog.acteur.errors.Err
 
ErrorRenderer - Class in com.mastfrog.acteur.errors
Renders error messages into responses
ErrorRenderer() - Constructor for class com.mastfrog.acteur.errors.ErrorRenderer
 
ErrorResponse - Interface in com.mastfrog.acteur.errors
Information needed to generate an http response for an error.
ErrorResponse.Simple<T> - Class in com.mastfrog.acteur.errors
Deprecated.
Use ErrorResponse.create() instead.
evaluate(Throwable, Acteur, Page, Event<?>) - Method in class com.mastfrog.acteur.errors.ExceptionEvaluator
 
evaluate(Throwable, Acteur, Page, Event<?>) - Method in class com.mastfrog.acteur.errors.ExceptionEvaluatorRegistry
 
Event<T> - Interface in com.mastfrog.acteur
An HTTP request or similar, which is passed to Pages for their Acteurs to respond to.
EVENT_THREADS - Static variable in class com.mastfrog.acteur.server.ServerModule
Number of event threads
EventLoopFactory - Class in com.mastfrog.acteur.server
Factory for event loop groups used by the Netty transport.
EventLoopFactory() - Constructor for class com.mastfrog.acteur.server.EventLoopFactory
 
exactPathLength(int) - Method in class com.mastfrog.acteur.ActeurFactory
 
Example - Annotation Type in com.mastfrog.acteur.preconditions
Allows a call to include an example URL and sample inputs and outputs in the generated documentation.
Examples - Annotation Type in com.mastfrog.acteur.preconditions
Handles the case where one HTTP call supports multiple uses or multiple types of input and output (ex.
Examples.Case - Annotation Type in com.mastfrog.acteur.preconditions
 
ExceptionEvaluator - Class in com.mastfrog.acteur.errors
Converts exceptions thrown inside Acteurs into error messages.
ExceptionEvaluator(ExceptionEvaluatorRegistry) - Constructor for class com.mastfrog.acteur.errors.ExceptionEvaluator
 
ExceptionEvaluatorRegistry - Class in com.mastfrog.acteur.errors
Registry of things which create error responses for exceptions.
EXCLUDED_CLASSES - Static variable in class com.mastfrog.acteur.annotations.GenericApplicationModule
 
EXTERNAL_PORT - Static variable in interface com.mastfrog.acteur.server.PathFactory
Deprecated.
use @link{ServerModule.SETTINGS_KEY_URLS_EXTERNAL_PORT}
EXTERNAL_SECURE_PORT - Static variable in interface com.mastfrog.acteur.server.PathFactory
Deprecated.
use

F

failureMessage - Variable in class com.mastfrog.acteur.auth.AuthenticationResult
 
FailureResponseFactory - Interface in com.mastfrog.acteur
Bind in guice to customize 404 not found responses, and failures that cannot be handled by ErrorRenderer (i.e.
failureStatus - Variable in class com.mastfrog.acteur.auth.AuthenticationResult
 
forbidden(String) - Static method in class com.mastfrog.acteur.errors.Err
 
future() - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 

G

GenericApplication - Class in com.mastfrog.acteur.annotations
An application which looks up its pages using registry files on the classpath, generated by an annotation processor which processes @HttpCall annotations.
GenericApplication() - Constructor for class com.mastfrog.acteur.annotations.GenericApplication
 
GenericApplication(boolean) - Constructor for class com.mastfrog.acteur.annotations.GenericApplication
 
GenericApplication(GenericApplication.GenericApplicationSettings, Set<Class<?>>) - Constructor for class com.mastfrog.acteur.annotations.GenericApplication
 
GenericApplication(Class<?>...) - Constructor for class com.mastfrog.acteur.annotations.GenericApplication
 
GenericApplication.GenericApplicationSettings - Class in com.mastfrog.acteur.annotations
 
GenericApplicationModule<T extends GenericApplication> - Class in com.mastfrog.acteur.annotations
Acteur ServerModule which uses GenericApplication.
GenericApplicationModule(ReentrantScope, Settings, Class<? extends T>, Class<?>...) - Constructor for class com.mastfrog.acteur.annotations.GenericApplicationModule
Create a new GenericApplicationModule with a specific subtype of GenericApplication, passing in the scope to be used for request scope.
GenericApplicationModule(Settings) - Constructor for class com.mastfrog.acteur.annotations.GenericApplicationModule
Constructor which just takes a Settings, for use with giulius-tests
GenericApplicationModule(Settings, Class<?>...) - Constructor for class com.mastfrog.acteur.annotations.GenericApplicationModule
Create a new GenericApplicationModule using the passed settings and the specified class exclusion list.
GenericApplicationModule(Settings, Class<? extends T>, Class<?>...) - Constructor for class com.mastfrog.acteur.annotations.GenericApplicationModule
Create a new GenericApplicationModule with a specific subtype of GenericApplication.
GenericApplicationSettings(boolean, boolean) - Constructor for class com.mastfrog.acteur.annotations.GenericApplication.GenericApplicationSettings
 
get() - Method in class com.mastfrog.acteur.debug.HttpProbe
 
get(HeaderValueType<T>) - Method in class com.mastfrog.acteur.Acteur
 
get(HeaderValueType<T>) - Method in class com.mastfrog.acteur.Response
Get a header which has been previously set
getActeur() - Method in class com.mastfrog.acteur.Acteur.ConsumedLockedState
 
getActeur() - Method in class com.mastfrog.acteur.State
Returns whether (and by which action) the next event has to be processed prior to regular processing.
getChannel() - Method in interface com.mastfrog.acteur.Event
Deprecated.
getContent() - Method in interface com.mastfrog.acteur.Event
Deprecated.
use content()
getContentAsJSON(Class<T>) - Method in interface com.mastfrog.acteur.Event
Deprecated.
use jsonContent()
getContentAsString() - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
use stringContent()
getContext() - Method in class com.mastfrog.acteur.State
 
getContextContribution() - Method in class com.mastfrog.acteur.Acteur
 
getDelegate() - Method in interface com.mastfrog.acteur.Acteur.Delegate
Get the acteur being delegated to
getDescription() - Method in class com.mastfrog.acteur.Page
Get a description used in the generated web API help.
getEventGroup() - Method in class com.mastfrog.acteur.server.EventLoopFactory
 
getHeader(HeaderValueType<T>) - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
use header()
getHeader(CharSequence) - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
use header()
getHeaders(HeaderValueType<T>) - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
use headers()
getHeadersAsMap() - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
use headersAsMap()
getIntParameter(String) - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
Use intUrlParameter()
getLockedPage() - Method in class com.mastfrog.acteur.State
Returns whether (and by which "page") the next event has to be processed prior to regular processing.
getLongParameter(String) - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
Use longUrlParameter()
getMethod() - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
use method()
getName() - Method in class com.mastfrog.acteur.Application
 
getParameter(String) - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
Use urlParameter()
getParametersAs(Class<T>) - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
use urlParametersAs
getParametersAsMap() - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
use urlParametersAsMap()
getPath() - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
use path()
getRemoteAddress() - Method in interface com.mastfrog.acteur.Event
Deprecated.
use remoteAddress().
getRequest() - Method in interface com.mastfrog.acteur.Event
Deprecated.
use request()
getRequestScope() - Method in class com.mastfrog.acteur.Application
Get the Scope which is holds per-request state.
getRequestURL(boolean) - Method in interface com.mastfrog.acteur.HttpEvent
Returns a best-effort at reconstructing the inbound URL, following the following algorithm: If the application has external url generation configured via PathFactory, prefer the output of that If not, try to honor non-standard but common headers such as X-Forwarded-Proto, X-URI-Scheme, Forwarded, X-Forwarded-Host Applications which respond to multiple virtual host names may need a custom implementation of PathFactory bound to do this correctly.
getResponse() - Method in class com.mastfrog.acteur.Acteur
 
getState() - Method in class com.mastfrog.acteur.Acteur
 
getWorkerGroup() - Method in class com.mastfrog.acteur.server.EventLoopFactory
 
globPathMatch(boolean, String...) - Method in class com.mastfrog.acteur.ActeurFactory
 
globPathMatch(String...) - Method in class com.mastfrog.acteur.ActeurFactory
 
gone(String) - Static method in class com.mastfrog.acteur.errors.Err
 
GUICE_BINDING_DEFAULT_CONTEXT_OBJECTS - Static variable in class com.mastfrog.acteur.server.ServerModule
Guice #&064;Named binding for objects you want in the context for every request, which can be replaced by ones provided to the context by Acteurs.

H

HANDLER - Static variable in interface com.mastfrog.acteur.server.PipelineDecorator
Name of the pipeline's dispatch handler that invokes acteurs
hasAnnotations(T) - Method in class com.mastfrog.acteur.preconditions.PageAnnotationHandler.Registry
 
hasEarlyPages() - Method in class com.mastfrog.acteur.Application
 
hashCode() - Method in class com.mastfrog.acteur.auth.SimpleUser.Base
 
hashCode() - Method in class com.mastfrog.acteur.errors.ExceptionEvaluator
 
header(HeaderValueType<T>) - Method in interface com.mastfrog.acteur.HttpEvent
Get a header as an appropriate Java object, or null if it is not present.
header(CharSequence) - Method in interface com.mastfrog.acteur.HttpEvent
Get a single HTTP header
headers() - Method in class com.mastfrog.acteur.errors.Err
 
headers() - Method in interface com.mastfrog.acteur.errors.ErrorResponse
 
headers() - Method in exception com.mastfrog.acteur.errors.ResponseException
 
headers() - Element in annotation type com.mastfrog.acteur.preconditions.CORS
The added access control allowed headers.
headers(HeaderValueType<T>) - Method in interface com.mastfrog.acteur.HttpEvent
Get all headers matching a type.
headersAsMap() - Method in interface com.mastfrog.acteur.HttpEvent
Get all headers (pruning duplicate names) as a case-insensitive map of CharSequence to header value.
HEAP_ALLOCATOR - Static variable in class com.mastfrog.acteur.server.ServerModule
Property value for telling the server to use the heap byte buffer allocator.
Help - Annotation Type in com.mastfrog.acteur
If this annotation appears on an Application, it automatically makes a Help page available.
HELP_HTML_URL_PATTERN_SETTINGS_KEY - Static variable in annotation type com.mastfrog.acteur.Help
 
HELP_URL_PATTERN_SETTINGS_KEY - Static variable in annotation type com.mastfrog.acteur.Help
 
helpEnabled - Variable in class com.mastfrog.acteur.annotations.GenericApplication.GenericApplicationSettings
 
HelpGenerator - Class in com.mastfrog.acteur
Generates JSON help for the application; HelpPage converts this into HTML.
HelpGenerator.AnnotationDescriptionPlugin<T extends Annotation> - Class in com.mastfrog.acteur
Allows code to be plugged in to contribute to the help page information about specific types of annotation.
helpPageType() - Static method in class com.mastfrog.acteur.Application
Get the type of the built in help page class, which uses Acteur.describeYourself() and annotations to generate a JSON description of all URLs the application responds to
HOSTNAME_SETTINGS_KEY - Static variable in interface com.mastfrog.acteur.server.PathFactory
Deprecated.
use @link{ServerModule.SETTINGS_KEY_URLS_HOST_NAME}
HTTP_COMPRESSION - Static variable in class com.mastfrog.acteur.server.ServerModule
Settings key for enabling HTTP compression.
HTTP_COMPRESSION_CHECK_RESPONSE_CONTENT_TYPE - Static variable in class com.mastfrog.acteur.server.ServerModule
If true, the response compressor will check the response's Content-Type header and avoid compressing responses with media types that are pre-compressed or liable to be made larger by gzip or deflate compression, such as mpeg or jpeg.
HTTP_COMPRESSION_LEVEL - Static variable in class com.mastfrog.acteur.server.ServerModule
Sets the HTTP compression level from 0 to 9, 0 meaning no compression, 9 meaning maximum compression; the default is 6.
HTTP_COMPRESSION_MEMORY_LEVEL - Static variable in class com.mastfrog.acteur.server.ServerModule
Sets the amount of memory to use for compression state, from 1 to 9, higher numbers using more memory but getting better and faster compression.
HTTP_COMPRESSION_THRESHOLD - Static variable in class com.mastfrog.acteur.server.ServerModule
Sets the compression threshold for responses which have their Content-Length set - Netty's HttpContentCompressor decides to act before HTTP chunks are seen, so chunked responses will use the default behavior.
HTTP_COMPRESSION_WINDOW_BITS - Static variable in class com.mastfrog.acteur.server.ServerModule
Sets the size of the history buffer for compression - should be in the range 9 to 15, higher numbers meaning better commpression at the cost of memory.
HttpCallRegistryLoader - Class in com.mastfrog.acteur.annotations
 
HttpCallRegistryLoader(Class<?>) - Constructor for class com.mastfrog.acteur.annotations.HttpCallRegistryLoader
 
HttpEvent - Interface in com.mastfrog.acteur
 
HttpProbe - Class in com.mastfrog.acteur.debug
 
HttpProbe() - Constructor for class com.mastfrog.acteur.debug.HttpProbe
 

I

id() - Method in class com.mastfrog.acteur.auth.SimpleUser.Base
 
id() - Method in interface com.mastfrog.acteur.auth.SimpleUser
An ID type, typically a database primary key or something like MongoDB's ObjectID
idAsString() - Method in class com.mastfrog.acteur.auth.SimpleUser.Base
 
idAsString() - Method in interface com.mastfrog.acteur.auth.SimpleUser
Get a string representation of the ID suitable for use in URLs or other places
ifThrown(Consumer<Throwable>) - Method in class com.mastfrog.acteur.DeferredComputationResult
 
implicitBindings() - Method in class com.mastfrog.acteur.annotations.HttpCallRegistryLoader
 
ImplicitBindings - Annotation Type in com.mastfrog.acteur
Deprecated.
- With Acteur 1.5 and ServerBuilder, you are not subclassing application anymore, so this class is less useful as it can only appear on the application class. Instead, use HttpCall with the scopeTypes parameter register types on the acteurs that use them; or use ServerBuilder.withType().
info - Variable in class com.mastfrog.acteur.auth.AuthenticationResult
 
InjectRequestBodyAs - Annotation Type in com.mastfrog.acteur.preconditions
Make the request body available as the passed type.
injectRequestBodyAsJSON(Class<T>) - Method in class com.mastfrog.acteur.ActeurFactory
Creates an Acteur which will read the request body, construct an object from it, and include it for injection into later Acteurs in the chain.
injectRequestParametersAs(Class<T>) - Method in class com.mastfrog.acteur.ActeurFactory
Create an acteur which will take the request parameters, turn them into an implementation of some interface and include that in the set of objects later Acteurs in the chain can request for injection.
InjectUrlParametersAs - Annotation Type in com.mastfrog.acteur.preconditions
Make the request parameters available as the passed type.
inputField() - Element in annotation type com.mastfrog.acteur.preconditions.Example
The name of the field on the class returned by inputType() to find an object which can be rendered as JSON sample input in the documentation of this call.
inputType() - Element in annotation type com.mastfrog.acteur.preconditions.Example
The class to look for the value of inputField() on, to instantiate and convert to JSON an example of input to this method.
InstallChunkHandler - Class in com.mastfrog.acteur.annotations
 
instantiateModule(Class<T>, Settings, ReentrantScope) - Static method in class com.mastfrog.acteur.annotations.GenericApplicationModule
 
internalOnError(Throwable) - Method in interface com.mastfrog.acteur.spi.ApplicationControl
 
introspectAnnotation(Application, Annotation, Map<String, Object>) - Method in class com.mastfrog.acteur.HelpGenerator.AnnotationDescriptionPlugin
Introspect, continuing the help mechanism, an annotation found when examining the annotation passed to write() (but must not be the annotation passed there).
intUrlParameter(String) - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
Uses obsolete com.google.common.base.Optional
isAuthenticated() - Method in class com.mastfrog.acteur.auth.AuthenticationResult
 
isClosed() - Method in class com.mastfrog.acteur.Closables
 
isDefaultCorsHandlingEnabled() - Method in class com.mastfrog.acteur.Application
 
isEarlyPageMatch(HttpRequest) - Method in class com.mastfrog.acteur.Application
 
isEnabled() - Method in class com.mastfrog.acteur.debug.HttpProbe
 
isKeepAlive() - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
use requestsConnectionStayOpen()
isLockedInChain() - Method in class com.mastfrog.acteur.State
Deprecated.
no longer used
isPreContent() - Method in interface com.mastfrog.acteur.HttpEvent
 
isRejected() - Method in class com.mastfrog.acteur.State
 
isSsl() - Method in interface com.mastfrog.acteur.HttpEvent
Determine if this event was over an encrypted connection.
iterator() - Method in class com.mastfrog.acteur.annotations.HttpCallRegistryLoader
 
iterator() - Method in class com.mastfrog.acteur.Application
Get the set of page instances, constructing them dynamically.

J

jsonContent(Class<T>) - Method in interface com.mastfrog.acteur.Event
Will use Jackson to parse the request body and return an object of the type requested if possible.
jsonContent(Class<T>) - Method in class com.mastfrog.acteur.server.WebSocketEvent
 

L

logErrors(CompletionStage<?>) - Method in interface com.mastfrog.acteur.spi.ApplicationControl
 
logFailure(ChannelFuture) - Method in interface com.mastfrog.acteur.spi.ApplicationControl
 
longUrlParameter(String) - Method in interface com.mastfrog.acteur.HttpEvent
Deprecated.
Uses obsolete com.google.common.base.Optional

M

matchMethods(boolean, Method...) - Method in class com.mastfrog.acteur.ActeurFactory
Reject the request if it is not an allowed HTTP method, optionally including information in the response, or simply rejecting the request and allowing the next page a crack at it.
matchMethods(Method...) - Method in class com.mastfrog.acteur.ActeurFactory
Deprecated.
Use &#064Methods instead - it is self-documenting
matchPath(boolean, String...) - Method in class com.mastfrog.acteur.ActeurFactory
Deprecated.
matchPath(String...) - Method in class com.mastfrog.acteur.ActeurFactory
Deprecated.
Use &#064PathRegex instead - it is self-documenting
MAX_CONTENT_LENGTH - Static variable in class com.mastfrog.acteur.server.ServerModule
Settings key for the maximum content length.
maxAgeSeconds() - Element in annotation type com.mastfrog.acteur.preconditions.CORS
The maximum age in seconds for cors responses.
maximumBodyLength(int) - Method in class com.mastfrog.acteur.ActeurFactory
 
maximumPathLength(int) - Method in class com.mastfrog.acteur.ActeurFactory
 
MaximumPathLength - Annotation Type in com.mastfrog.acteur.preconditions
Specifies a maximum number of / separated elements in the URL path, for use Acteurs which use the tail of the URL path as an open-ended list of something.
MaximumRequestBodyLength - Annotation Type in com.mastfrog.acteur.preconditions
Annotation which can appear on an Acteur with the @HttpCall annotation or on a Page with that annotation.
mergeNamespaces() - Method in class com.mastfrog.acteur.server.ServerBuilder
If true, do not actually use the namespace feature of Dependencies - there is only one namespace - it is just not named "default".
message - Variable in class com.mastfrog.acteur.errors.Err
 
message - Variable in class com.mastfrog.acteur.errors.ErrorResponse.Simple
Deprecated.
 
message() - Method in class com.mastfrog.acteur.errors.Err
 
message() - Method in interface com.mastfrog.acteur.errors.ErrorResponse
 
message() - Method in class com.mastfrog.acteur.errors.ErrorResponse.Simple
Deprecated.
 
method() - Method in interface com.mastfrog.acteur.HttpEvent
Get the HTTP method for this request
method() - Element in annotation type com.mastfrog.acteur.preconditions.RequireParametersIfMethodMatches
 
methods() - Element in annotation type com.mastfrog.acteur.preconditions.CORS
Set the methods cors responses are valid for.
Methods - Annotation Type in com.mastfrog.acteur.preconditions
Annotation which can be set on Page classes to determine what methods are respond to.
minimumBodyLength(int) - Method in class com.mastfrog.acteur.ActeurFactory
 
minimumPathLength(int) - Method in class com.mastfrog.acteur.ActeurFactory
 
MinimumRequestBodyLength - Annotation Type in com.mastfrog.acteur.preconditions
Annotation which can appear on an Acteur with the @HttpCall annotation or on a Page with that annotation.
modules() - Method in class com.mastfrog.acteur.annotations.HttpCallRegistryLoader
 

N

name() - Method in class com.mastfrog.acteur.auth.SimpleUser.Base
 
name() - Method in interface com.mastfrog.acteur.auth.SimpleUser
Programmatic name of this user suitable for use in urls
next(Object...) - Method in class com.mastfrog.acteur.Acteur
 
noContent() - Method in class com.mastfrog.acteur.Acteur
 
NOT_DONE - Enum constant in enum com.mastfrog.acteur.ResponseWriter.Status
Call the object returning this value again in the future so it can write more output
notFound() - Method in class com.mastfrog.acteur.Acteur
 
notFound(Object) - Method in class com.mastfrog.acteur.Acteur
 

O

of(Object) - Static method in class com.mastfrog.acteur.DeferredComputationResult
 
of(Object, HttpResponseStatus) - Static method in class com.mastfrog.acteur.DeferredComputationResult
 
of(Throwable) - Static method in class com.mastfrog.acteur.errors.Err
 
ok() - Method in class com.mastfrog.acteur.Acteur
 
ok(Object) - Method in class com.mastfrog.acteur.Acteur
 
onActeurWasRun(RequestID, Event<?>, Page, Acteur, ActeurState) - Method in interface com.mastfrog.acteur.debug.Probe
 
onActeurWasRun(RequestID, HttpEvent, Page, Acteur, ActeurState) - Method in class com.mastfrog.acteur.debug.HttpProbe
 
onAfterRespond(RequestID, Event<?>, Acteur, Page, State, HttpResponseStatus, HttpResponse) - Method in class com.mastfrog.acteur.Application
Override to do any post-response tasks
onAfterStart(Server, Dependencies) - Method in class com.mastfrog.acteur.server.ServerModule
 
onAuthenticationFailed(HttpEvent, Page, Response) - Method in interface com.mastfrog.acteur.auth.AuthenticateBasicActeur.AuthenticationDecorator
Deprecated.
Called when authetication failse
onAuthenticationSucceeded(HttpEvent, Page, Response, Object[]) - Method in interface com.mastfrog.acteur.auth.AuthenticateBasicActeur.AuthenticationDecorator
Deprecated.
Called when authentication succeeds.
onBeforeEvent(Event<?>, Channel, Object) - Method in interface com.mastfrog.acteur.OnBeforeEvent
Called before the event is processed to generate some additional objects for injection.
onBeforeEvent(RequestID, Event<?>) - Method in class com.mastfrog.acteur.Application
Called before an event is processed
onBeforeEvent(RequestID, Event<?>) - Method in interface com.mastfrog.acteur.RequestLogger
 
OnBeforeEvent - Interface in com.mastfrog.acteur
Interface which, if present, will be invoked before entering request scope and can provide a set of objects to make available in the request scope, which will be consistent regardless of the page/acteur chain which eventually handles responding to the request (if any).
onBeforeInstallSslHandler(ChannelPipeline) - Method in interface com.mastfrog.acteur.server.PipelineDecorator
 
onBeforeProcessRequest(RequestID, Event<?>) - Method in interface com.mastfrog.acteur.debug.Probe
 
onBeforeProcessRequest(RequestID, HttpEvent) - Method in class com.mastfrog.acteur.debug.HttpProbe
 
onBeforeRespond(RequestID, Event<?>, HttpResponseStatus) - Method in class com.mastfrog.acteur.Application
Called before the response is sent RequestID
onBeforeRunPage(RequestID, Event<?>, Page) - Method in interface com.mastfrog.acteur.debug.Probe
 
onBeforeRunPage(RequestID, HttpEvent, Page) - Method in class com.mastfrog.acteur.debug.HttpProbe
 
onBeforeSendResponse(Application, HttpResponseStatus, Event<?>, Response, Acteur, Page) - Method in interface com.mastfrog.acteur.ResponseDecorator
 
onBeforeSendResponse(RequestID, Event<?>, Acteur, HttpResponseStatus, boolean, Object) - Method in interface com.mastfrog.acteur.debug.Probe
 
onBeforeSendResponse(RequestID, HttpEvent, Acteur, HttpResponseStatus, boolean, Object) - Method in class com.mastfrog.acteur.debug.HttpProbe
 
onBeforeSendResponse(HttpResponseStatus, Event<?>, Response, Acteur, Page) - Method in class com.mastfrog.acteur.Application
 
onBeforeStart(Server, Dependencies) - Method in class com.mastfrog.acteur.server.ServerModule
 
onContent(ChannelHandlerContext, ByteBuf, HttpHeaders, boolean) - Method in class com.mastfrog.acteur.ChunkHandler
Called with each chunk of content as it arrives.
onCreatePipeline(ChannelPipeline) - Method in interface com.mastfrog.acteur.server.PipelineDecorator
Called when the pipeline is first fetched/created, before adding anything
onError(Throwable) - Method in class com.mastfrog.acteur.Application
Deprecated.
Implement ErrorHandler and bind it as an eager singleton
onEvent(Event<?>, Channel) - Method in interface com.mastfrog.acteur.spi.ApplicationControl
 
onFallthrough(RequestID, Event<?>) - Method in interface com.mastfrog.acteur.debug.Probe
 
onFallthrough(RequestID, HttpEvent) - Method in class com.mastfrog.acteur.debug.HttpProbe
 
onInfo(String, Object...) - Method in class com.mastfrog.acteur.debug.HttpProbe
 
onInfo(String, Object...) - Method in interface com.mastfrog.acteur.debug.Probe
 
onInit(Settings) - Method in class com.mastfrog.acteur.server.ServerModule
 
onPipelineInitialized(ChannelPipeline) - Method in interface com.mastfrog.acteur.server.PipelineDecorator
Called after all the standard handlers have been added to the pipeline.
onRespond(RequestID, Event<?>, HttpResponseStatus) - Method in interface com.mastfrog.acteur.RequestLogger
 
onShutdown() - Method in class com.mastfrog.acteur.server.ServerLifecycleHook
Called immediately after shutdown, when the server socket is closed.
onStartup(Application, Channel) - Method in class com.mastfrog.acteur.server.ServerLifecycleHook
Called when the first server channel (socket) is opened.
onSuccess - Variable in class com.mastfrog.acteur.DeferredComputationResult
 
onThrown(RequestID, Event<?>, Throwable) - Method in interface com.mastfrog.acteur.debug.Probe
 
onThrown(RequestID, HttpEvent, Throwable) - Method in class com.mastfrog.acteur.debug.HttpProbe
 
OnWebsocketConnect - Interface in com.mastfrog.acteur.websocket
Global interface called when a websocket connection has been successfully handshaken via WebSocketUpgradeActeur.
optional() - Element in annotation type com.mastfrog.acteur.preconditions.Authenticated
 
OPTIONAL - Static variable in annotation type com.mastfrog.acteur.preconditions.Authenticated
 
ordinal() - Method in class com.mastfrog.acteur.errors.ExceptionEvaluator
 
origins() - Element in annotation type com.mastfrog.acteur.preconditions.CORS
The set of origins cors responses apply to.
outputField() - Element in annotation type com.mastfrog.acteur.preconditions.Example
The name of the field on the class returned by outputType() to find an object which can be rendered as JSON sample output in the documentation of this call.
outputType() - Element in annotation type com.mastfrog.acteur.preconditions.Example
The class to look for the value of outputField() on, to instantiate and convert to JSON an example of output of this method.

P

page - Variable in class com.mastfrog.acteur.Acteur.RejectedState
 
page - Variable in class com.mastfrog.acteur.State
 
Page - Class in com.mastfrog.acteur
Really an aggregation of Acteurs and a place to set header values; in recent versions of Acteur it is rarely necessary to implement this - instead, simply annotate your entry-point Acteur with @HttpCall and one will be generated for you under-the-hood, and use @Precursors and @Concluders to specify Acteurs that should run before/after that one.
Page() - Constructor for class com.mastfrog.acteur.Page
 
PAGE_KEY - Static variable in class com.mastfrog.acteur.websocket.WebSocketUpgradeActeur
 
PageAnnotationHandler - Class in com.mastfrog.acteur.preconditions
Mechanism for pluggable handling of annotations - this way an application can create its own annotations which imply that some acteurs are to be added to a page, and actually add them.
PageAnnotationHandler(PageAnnotationHandler.Registry, Class<?>...) - Constructor for class com.mastfrog.acteur.preconditions.PageAnnotationHandler
 
PageAnnotationHandler.Registry - Class in com.mastfrog.acteur.preconditions
Registry of PageAnnotationHandlers
parametersMayNotBeCombined(String...) - Method in class com.mastfrog.acteur.ActeurFactory
 
ParametersMustBeNumbersIfPresent - Annotation Type in com.mastfrog.acteur.preconditions
Annotation which can appear on an Acteur with the @HttpCall annotation or on a Page with that annotation.
parametersMustBeNumbersIfTheyArePresent(boolean, boolean, String...) - Method in class com.mastfrog.acteur.ActeurFactory
 
path() - Method in interface com.mastfrog.acteur.HttpEvent
Get the logical path of this request.
Path - Annotation Type in com.mastfrog.acteur.preconditions
Specifieds a glob-style URL path, such as /mything/* - a * can represent anything but a / character.
PathFactory - Interface in com.mastfrog.acteur.server
Provider of paths for a web application, which can normalize paths and strip out the base path for the web application, if any.
PathRegex - Annotation Type in com.mastfrog.acteur.preconditions
Annotation which determines regular expressions used to determine whether a page responds to a given request.
PipelineDecorator - Interface in com.mastfrog.acteur.server
Allows applications to inject encoders or decoders into the Netty channel pipeline.
POOLED_ALLOCATOR - Static variable in class com.mastfrog.acteur.server.ServerModule
Property value for telling the server to use the pooled byte buffer allocator.
PORT - Static variable in class com.mastfrog.acteur.server.ServerModule
The port to run on
portForProtocol(Protocol) - Method in interface com.mastfrog.acteur.server.PathFactory
 
PRE_CONTENT_PAGE_HANDLER - Static variable in interface com.mastfrog.acteur.server.PipelineDecorator
Name of the handler for @ early pages/acteurs.
preconditionFailedIfUnmodifiedSinceMatches() - Method in class com.mastfrog.acteur.ActeurFactory
Check the "If-Unmodified-Since" header
preconditionFailedIfUnmodifiedSinceMatchesType() - Method in class com.mastfrog.acteur.ActeurFactory
 
Precursors - Annotation Type in com.mastfrog.acteur.annotations
Annotation which is only useful on Acteurs with the HttpCall annotation to trigger page source generation, which specifies some more Acteurs to run before the annotated one.
Probe - Interface in com.mastfrog.acteur.debug
Optionally may be bound to trace the activity in response to a request.
processAnnotations(T, List<? super Acteur>) - Method in class com.mastfrog.acteur.BuiltInPageAnnotationHandler
 
processAnnotations(T, List<? super Acteur>) - Method in class com.mastfrog.acteur.preconditions.PageAnnotationHandler
 
processAnnotations(T, List<? super Acteur>) - Method in class com.mastfrog.acteur.preconditions.PageAnnotationHandler.Registry
 
put(String, Object) - Method in class com.mastfrog.acteur.errors.Err
 
putAll(Map<String, Object>) - Method in class com.mastfrog.acteur.errors.Err
 

R

readObject(ByteBuf, MimeType, Class<T>) - Method in class com.mastfrog.acteur.ContentConverter
 
redirect(String) - Method in class com.mastfrog.acteur.ActeurFactory
 
redirect(String, HttpResponseStatus) - Method in class com.mastfrog.acteur.ActeurFactory
 
redirectEmptyPath(Path) - Method in class com.mastfrog.acteur.ActeurFactory
 
redirectEmptyPath(String) - Method in class com.mastfrog.acteur.ActeurFactory
 
reflectAndJsonify(Application, String, Class<?>) - Method in class com.mastfrog.acteur.HelpGenerator.AnnotationDescriptionPlugin
Used for examples - looks up the given static field by reflection and returns an html-ized JSONified view of its contents.
register(PageAnnotationHandler) - Method in class com.mastfrog.acteur.preconditions.PageAnnotationHandler.Registry
 
register(Class<T>) - Method in class com.mastfrog.acteur.ContentConverter.ContentValidationPlugin
 
Registry() - Constructor for class com.mastfrog.acteur.preconditions.PageAnnotationHandler.Registry
 
reject() - Method in class com.mastfrog.acteur.Acteur
 
RejectedState() - Constructor for class com.mastfrog.acteur.Acteur.RejectedState
 
RejectedState(HttpResponseStatus) - Constructor for class com.mastfrog.acteur.Acteur.RejectedState
 
remoteAddress() - Method in interface com.mastfrog.acteur.Event
Get the remote address of whoever made the request.
remoteAddress() - Method in class com.mastfrog.acteur.server.WebSocketEvent
 
remove(HttpEvent) - Method in interface com.mastfrog.acteur.auth.Tarpit
 
render(ErrorResponse, Event<?>) - Method in class com.mastfrog.acteur.errors.ErrorRenderer
 
render(ErrorResponse, Response, Event<?>) - Method in class com.mastfrog.acteur.errors.ErrorRenderer
 
reply(Err) - Method in class com.mastfrog.acteur.Acteur
 
reply(HttpResponseStatus) - Method in class com.mastfrog.acteur.Acteur
 
reply(HttpResponseStatus, Object) - Method in class com.mastfrog.acteur.Acteur
 
request() - Method in interface com.mastfrog.acteur.Event
Get the actual HTTP request.
request() - Method in class com.mastfrog.acteur.server.WebSocketEvent
 
RequestLogger - Interface in com.mastfrog.acteur
Logger which can be injected, which takes care of actually logging each request and response.
requestsConnectionStayOpen() - Method in interface com.mastfrog.acteur.HttpEvent
Determine if this request's connection header requests leaving the connection open.
requireAtLeastOneParameter(String...) - Method in class com.mastfrog.acteur.ActeurFactory
Reject the request if none of the passed parameter names are present
RequireAtLeastOneUrlParameterFrom - Annotation Type in com.mastfrog.acteur.preconditions
Annotation which can appear on an Acteur with the @HttpCall annotation or on a Page with that annotation.
RequiredUrlParameters - Annotation Type in com.mastfrog.acteur.preconditions
Annotation which causes a Page to return 400 Bad Request if the url parameters do not match what the annotation describes.
RequiredUrlParameters.Combination - Enum in com.mastfrog.acteur.preconditions
 
requireParameters(String...) - Method in class com.mastfrog.acteur.ActeurFactory
Reject the request unless certain URL parameters are present
requireParametersIfMethodMatches(Method, String...) - Method in class com.mastfrog.acteur.ActeurFactory
 
RequireParametersIfMethodMatches - Annotation Type in com.mastfrog.acteur.preconditions
Annotation which can appear on an Acteur with the @HttpCall annotation or on a Page with that annotation.
respondWith(int) - Method in class com.mastfrog.acteur.ActeurFactory
 
respondWith(int, String) - Method in class com.mastfrog.acteur.ActeurFactory
 
respondWith(HttpResponseStatus) - Method in class com.mastfrog.acteur.ActeurFactory
 
respondWith(HttpResponseStatus, String) - Method in class com.mastfrog.acteur.ActeurFactory
 
RespondWith(int) - Constructor for class com.mastfrog.acteur.Acteur.RespondWith
 
RespondWith(int, Object) - Constructor for class com.mastfrog.acteur.Acteur.RespondWith
 
RespondWith(ErrorResponse) - Constructor for class com.mastfrog.acteur.Acteur.RespondWith
 
RespondWith(HttpResponseStatus) - Constructor for class com.mastfrog.acteur.Acteur.RespondWith
 
RespondWith(HttpResponseStatus, Object) - Constructor for class com.mastfrog.acteur.Acteur.RespondWith
Acteur.this; Response which uses JSON
response() - Method in class com.mastfrog.acteur.Acteur
 
Response - Class in com.mastfrog.acteur
Abstraction for a response
Response() - Constructor for class com.mastfrog.acteur.Response
 
responseCode(HttpResponseStatus) - Method in class com.mastfrog.acteur.ActeurFactory
Create an Acteur which simply always responds with the given HTTP status.
ResponseDecorator - Interface in com.mastfrog.acteur
 
ResponseException - Exception in com.mastfrog.acteur.errors
Exception that can be thrown from a Provider and result in a specific HTTP error response.
ResponseException(HttpResponseStatus, String) - Constructor for exception com.mastfrog.acteur.errors.ResponseException
 
ResponseWriter - Class in com.mastfrog.acteur
Abstraction over Netty's channel/ByteBuf to insulate from changes there.
ResponseWriter() - Constructor for class com.mastfrog.acteur.ResponseWriter
 
ResponseWriter.Output - Interface in com.mastfrog.acteur
 
ResponseWriter.Status - Enum in com.mastfrog.acteur
 
resume(Object...) - Method in class com.mastfrog.acteur.ChunkHandler
 

S

scope - Variable in class com.mastfrog.acteur.server.ServerModule
 
scope() - Method in class com.mastfrog.acteur.server.ServerBuilder
 
SCOPED_BACKGROUND_THREAD_POOL_NAME - Static variable in class com.mastfrog.acteur.server.ServerModule
Name of the @Named parameter that should be used in an annotation if you want Guice to inject the specific thread pool used for processing requests, but wrappered so that all runnables are run within the application's request scope and have whatever context they were submitted with.
SCOPED_WORKER_THREAD_POOL_NAME - Static variable in class com.mastfrog.acteur.server.ServerModule
Name of the @Named parameter that should be used in an annotation if you want Guice to inject the specific thread pool used for processing requests, but wrappered so that all runnables are run within the application's request scope and have whatever context they were submitted with.
send100continue() - Element in annotation type com.mastfrog.acteur.annotations.Early
If true, automatically send the 100-CONTINUE response after the chunk handler is installed.
send404(RequestID, Event<?>, Channel) - Method in class com.mastfrog.acteur.Application
 
sendNotModifiedIfETagHeaderMatches() - Method in class com.mastfrog.acteur.ActeurFactory
Checks the IF_NONE_MATCH header and compares it with the value from the current Page's getETag() method.
sendNotModifiedIfETagHeaderMatchesType() - Method in class com.mastfrog.acteur.ActeurFactory
 
sendNotModifiedIfIfModifiedSinceHeaderMatches() - Method in class com.mastfrog.acteur.ActeurFactory
Check the "If-Modified-Since" header and compares it to the current Page's getLastModified (rounding milliseconds down).
sendNotModifiedIfIfModifiedSinceHeaderMatchesType() - Method in class com.mastfrog.acteur.ActeurFactory
 
ServerBootstrapConfigurer - Interface in com.mastfrog.acteur.server
Bind this if you want to customize Netty's server bootstrap on server initialization (used to install a logging channel factory for logging surprise channel closures and similar).
ServerBuilder - Class in com.mastfrog.acteur.server
Hides the complexity of initializing Guice and Settings to start a server simply.
ServerBuilder() - Constructor for class com.mastfrog.acteur.server.ServerBuilder
Create a ServerBuilder with Namespace.DEFAULT as its namespace.
ServerBuilder(ReentrantScope) - Constructor for class com.mastfrog.acteur.server.ServerBuilder
 
ServerBuilder(String) - Constructor for class com.mastfrog.acteur.server.ServerBuilder
Create a ServerBuilder with the passed namespace as its namespace.
ServerBuilder(String, ReentrantScope) - Constructor for class com.mastfrog.acteur.server.ServerBuilder
 
ServerLifecycleHook - Class in com.mastfrog.acteur.server
Implement and bind as an eager singleton if you have code that should run only in the case of (and after) the server is started.
ServerLifecycleHook(ServerLifecycleHook.Registry) - Constructor for class com.mastfrog.acteur.server.ServerLifecycleHook
 
ServerLifecycleHook.Registry - Class in com.mastfrog.acteur.server
 
ServerModule<A extends Application> - Class in com.mastfrog.acteur.server
Guice module for creating a server; also defines settings keys which can affect behavior.
ServerModule(ReentrantScope, Class<? extends A>) - Constructor for class com.mastfrog.acteur.server.ServerModule
 
ServerModule(ReentrantScope, Class<? extends A>, int, int, int) - Constructor for class com.mastfrog.acteur.server.ServerModule
 
ServerModule(Class<? extends A>) - Constructor for class com.mastfrog.acteur.server.ServerModule
 
ServerModule(Class<? extends A>, int, int, int) - Constructor for class com.mastfrog.acteur.server.ServerModule
 
setBodyWriter(ResponseWriter) - Method in class com.mastfrog.acteur.Response
Deprecated.
use contentWriter() instead
setBodyWriter(ChannelFutureListener) - Method in class com.mastfrog.acteur.Response
Deprecated.
use contentWriter() instead
setChunked(boolean) - Method in class com.mastfrog.acteur.Acteur
 
setChunked(boolean) - Method in class com.mastfrog.acteur.Response
Deprecated.
use chunked() instead
setDelay(Duration) - Method in class com.mastfrog.acteur.Response
Deprecated.
use delayedBy() instead
setEnabled(boolean) - Method in class com.mastfrog.acteur.debug.HttpProbe
 
setMessage(Object) - Method in class com.mastfrog.acteur.Acteur
 
setMessage(Object) - Method in class com.mastfrog.acteur.Response
Deprecated.
use content() instead
setResponseBodyWriter(ChannelFutureListener) - Method in class com.mastfrog.acteur.Acteur
Set a ChannelFutureListener which will be called after headers are written and flushed to the socket; prefer setResponseWriter() to this method unless you are not using chunked encoding and want to stream your response (in which case, be sure to chunked(false) or you will have encoding errors).
setResponseBodyWriter(Class<T>) - Method in class com.mastfrog.acteur.Acteur
Set a ChannelFutureListener which will be called after headers are written and flushed to the socket; prefer setResponseWriter() to this method unless you are not using chunked encoding and want to stream your response (in which case, be sure to setChunked(false) or you will have encoding errors).
setResponseCode(HttpResponseStatus) - Method in class com.mastfrog.acteur.Acteur
 
setResponseCode(HttpResponseStatus) - Method in class com.mastfrog.acteur.Response
Deprecated.
use status() instead
setResponseWriter(Class<T>) - Method in class com.mastfrog.acteur.Acteur
Set a response writer which can iteratively be called back until the response is completed.
setResponseWriter(T) - Method in class com.mastfrog.acteur.Acteur
Set a response writer which can iteratively be called back until the response is completed.
setResumer(Deferral.Resumer) - Method in class com.mastfrog.acteur.ChunkHandler
 
setting() - Element in annotation type com.mastfrog.acteur.preconditions.AuthenticatedIf
 
settings - Variable in class com.mastfrog.acteur.annotations.GenericApplicationModule
 
SETTINGS_KEY_BASE_PATH - Static variable in class com.mastfrog.acteur.server.ServerModule
The base path for all URLs in the application, allowing it to be "mounted" on a URL path - so a server such as NginX can reverse proxy it under the path /foo, and that is transparent to application code, and is used when generating redirect URLs.
SETTINGS_KEY_BIND_ADDRESS - Static variable in class com.mastfrog.acteur.server.ServerModule
If set in settings, only this IP address will be bound when starting the server.
SETTINGS_KEY_CHARSET - Static variable in class com.mastfrog.acteur.server.ServerModule
 
SETTINGS_KEY_CORS_ALLOW_CREDENTIALS - Static variable in class com.mastfrog.acteur.server.ServerModule
If the default support for CORS requests is enabled, this is the value for the Access-Control-Allow-Credentials header.
SETTINGS_KEY_CORS_ALLOW_HEADERS - Static variable in class com.mastfrog.acteur.server.ServerModule
If the default support for CORS requests is enabled, or for requests annotated with &064;CORS that do not specify this, this is the value of what hosts the response is valid for (what sites can use scripts from this server without the browser blocking them).
SETTINGS_KEY_CORS_ALLOW_ORIGIN - Static variable in class com.mastfrog.acteur.server.ServerModule
If the default support for CORS requests is enabled, this is the value of what hosts the response is valid for (what sites can use scripts from this server without the browser blocking them).
SETTINGS_KEY_CORS_CACHE_CONTROL_MAX_AGE - Static variable in class com.mastfrog.acteur.server.ServerModule
If the default support for CORS requests is enabled, this is the value of what hosts the response is valid for (what sites can use scripts from this server without the browser blocking them).
SETTINGS_KEY_CORS_ENABLED - Static variable in class com.mastfrog.acteur.server.ServerModule
Settings key if true, do CORS responses on OPTIONS requests.
SETTINGS_KEY_CORS_MAX_AGE_MINUTES - Static variable in class com.mastfrog.acteur.server.ServerModule
If the default support for CORS requests is enabled, this is the max age in minutes that the browser should regard the response as valid.
SETTINGS_KEY_CORS_REPLACE_ALLOW_HEADERS - Static variable in class com.mastfrog.acteur.server.ServerModule
If the default support for CORS requests is enabled, use this instead of the default cors allow headers string.
SETTINGS_KEY_CUSTOM_ALLOC_CACHE_ALIGNMENT - Static variable in class com.mastfrog.acteur.server.ServerModule
Fine tuning for using customized pooled byte buf allocator.
SETTINGS_KEY_CUSTOM_ALLOC_MAX_ORDER - Static variable in class com.mastfrog.acteur.server.ServerModule
Fine tuning for using customized pooled byte buf allocator.
SETTINGS_KEY_CUSTOM_ALLOC_NORMAL_CACHE_SIZE - Static variable in class com.mastfrog.acteur.server.ServerModule
Fine tuning for using customized pooled byte buf allocator.
SETTINGS_KEY_CUSTOM_ALLOC_NUM_DIRECT_ARENAS - Static variable in class com.mastfrog.acteur.server.ServerModule
Fine tuning for using customized pooled byte buf allocator.
SETTINGS_KEY_CUSTOM_ALLOC_NUM_HEAP_ARENAS - Static variable in class com.mastfrog.acteur.server.ServerModule
Fine tuning for using customized pooled byte buf allocator.
SETTINGS_KEY_CUSTOM_ALLOC_PAGE_SIZE - Static variable in class com.mastfrog.acteur.server.ServerModule
Fine tuning for using customized pooled byte buf allocator.
SETTINGS_KEY_CUSTOM_ALLOC_PREFER_DIRECT - Static variable in class com.mastfrog.acteur.server.ServerModule
Fine tuning for using customized pooled byte buf allocator.
SETTINGS_KEY_CUSTOM_ALLOC_SMALL_CACHE_SIZE - Static variable in class com.mastfrog.acteur.server.ServerModule
Fine tuning for using customized pooled byte buf allocator.
SETTINGS_KEY_CUSTOM_ALLOC_TINY_CACHE_SIZE - Static variable in class com.mastfrog.acteur.server.ServerModule
Fine tuning for using customized pooled byte buf allocator.
SETTINGS_KEY_CUSTOM_ALLOC_USE_CACHE_ALL_THREADS - Static variable in class com.mastfrog.acteur.server.ServerModule
Fine tuning for using customized pooled byte buf allocator.
SETTINGS_KEY_DECODE_REAL_IP - Static variable in class com.mastfrog.acteur.server.ServerModule
If true, the return value of Event.remoteAddress() will prefer the headers X-Forwarded-For or X-Real-IP if present, so that running an acteur application behind a reverse proxy does not mask the actual IP address.
SETTINGS_KEY_DEFAULT_EXCEPTION_HANDLING - Static variable in class com.mastfrog.acteur.errors.ExceptionEvaluatorRegistry
 
SETTINGS_KEY_DEFAULT_SECURE_URLS - Static variable in interface com.mastfrog.acteur.server.PathFactory
Deprecated.
use @link{ServerModule.SETTINGS_KEY_GENERATE_SECURE_URLS}
SETTINGS_KEY_DELAY_THREAD_POOL_THREADS - Static variable in class com.mastfrog.acteur.server.ServerModule
Number of threads to process delayed responses (see Acteur.setDelay()).
SETTINGS_KEY_DISABLE_LEAK_DETECTOR - Static variable in class com.mastfrog.acteur.server.ServerModule
If set to true (the default), turn off Netty's leak detector.
SETTINGS_KEY_GENERATE_SECURE_URLS - Static variable in class com.mastfrog.acteur.server.ServerModule
Whether or not methods on PathFactory which do not take a protocol or secure parameter should generate secure or insecure URLs.
SETTINGS_KEY_GENERATE_URLS_WITH_INET_ADDRESS_GET_LOCALHOST - Static variable in class com.mastfrog.acteur.server.ServerModule
URLs are generated using the host from InetAddress.getLocalHostName().
SETTINGS_KEY_MAX_CHUNK_SIZE - Static variable in class com.mastfrog.acteur.server.ServerModule
Length in bytes of the maximum inbound HTTP chunk size, after which the http codec will return a /bad-request response.
SETTINGS_KEY_MAX_HEADER_BUFFER_SIZE - Static variable in class com.mastfrog.acteur.server.ServerModule
Length in bytes of the maximum HTTP header buffer size after which the http codec will return a /bad-request response.
SETTINGS_KEY_MAX_REQUEST_LINE_LENGTH - Static variable in class com.mastfrog.acteur.server.ServerModule
Length in bytes of the maximum request line length, after which the http codec will return a /bad-request response.
SETTINGS_KEY_RENDER_STACK_TRACES - Static variable in class com.mastfrog.acteur.server.ServerModule
Render stack traces into the response if an exception is thrown.
SETTINGS_KEY_SOCKET_CONNECT_TIMEOUT_MILLIS - Static variable in class com.mastfrog.acteur.server.ServerModule
Low level socket option for outbound connections.
SETTINGS_KEY_SOCKET_MAX_MESSAGES_PER_INDIVIDUAL_READ - Static variable in class com.mastfrog.acteur.server.ServerModule
Low level socket option for outbound connections.
SETTINGS_KEY_SOCKET_MAX_MESSAGES_PER_READ - Static variable in class com.mastfrog.acteur.server.ServerModule
Low level socket option for outbound connections.
SETTINGS_KEY_SOCKET_SO_RCVBUF - Static variable in class com.mastfrog.acteur.server.ServerModule
Low level socket option for outbound connections.
SETTINGS_KEY_SOCKET_SO_SNDBUF - Static variable in class com.mastfrog.acteur.server.ServerModule
Low level socket option for outbound connections.
SETTINGS_KEY_SOCKET_TCP_NODELAY - Static variable in class com.mastfrog.acteur.server.ServerModule
Low level socket option for outbound connections; default value is true, disabling Nagle's algorithm.
SETTINGS_KEY_SOCKET_WRITE_SPIN_COUNT - Static variable in class com.mastfrog.acteur.server.ServerModule
Low level socket option for outbound connections.
SETTINGS_KEY_SSL_ENABLED - Static variable in class com.mastfrog.acteur.server.ServerModule
If enabled, serve HTTPS by default.
SETTINGS_KEY_SSL_ENGINE - Static variable in class com.mastfrog.acteur.server.ServerModule
Settings key for the SSL engine to use - the name of one of the constants on SslProvider.
SETTINGS_KEY_SYSTEM_EXIT_ON_BIND_FAILURE - Static variable in class com.mastfrog.acteur.server.ServerModule
Determine if the application should exit if an exception is thrown when binding the server socket (usually because the port is in use).
SETTINGS_KEY_TARPIT_BAD_LOGIN_ATTEMPT_COUNT - Static variable in class com.mastfrog.acteur.auth.AuthenticateBasicActeur
Deprecated.
 
SETTINGS_KEY_TARPIT_DELAY_RESPONSE_AFTER - Static variable in class com.mastfrog.acteur.auth.AuthenticateBasicActeur
Deprecated.
 
SETTINGS_KEY_TARPIT_DELAY_SECONDS - Static variable in class com.mastfrog.acteur.auth.AuthenticateBasicActeur
Deprecated.
 
SETTINGS_KEY_TARPIT_EXPIRATION_TIME_MINUTES - Static variable in interface com.mastfrog.acteur.auth.Tarpit
 
SETTINGS_KEY_URLS_EXTERNAL_PORT - Static variable in class com.mastfrog.acteur.server.ServerModule
The external port if running behind a proxy, for use when PathFactory generates redirect URLs.
SETTINGS_KEY_URLS_EXTERNAL_SECURE_PORT - Static variable in class com.mastfrog.acteur.server.ServerModule
The secure port if running behind a proxy, for use when PathFactory generates redirect URLs.
SETTINGS_KEY_URLS_HOST_NAME - Static variable in class com.mastfrog.acteur.server.ServerModule
The host name to use in URLs generated for redirects and similar, by PathFactory.
SETTINGS_KEY_USE_FORK_JOIN_POOL - Static variable in class com.mastfrog.acteur.server.ServerModule
If true (the default), a ForkJoinPool will be used for dispatching work to acteurs; if not, a fixed thread ExecutorService will be used.
SETTINGS_KEY_WEBSOCKET_FRAME_MAX_LENGTH - Static variable in class com.mastfrog.acteur.websocket.WebSocketUpgradeActeur
 
SETTINGS_KEY_WEBSOCKET_SECURE_PROTOCOL - Static variable in class com.mastfrog.acteur.websocket.WebSocketUpgradeActeur
 
SETTINGS_KEY_WEBSOCKETS_ENABLED - Static variable in class com.mastfrog.acteur.server.ServerModule
If enabled, turn on websocket support for the server process.
SILENT - Static variable in interface com.mastfrog.acteur.RequestLogger
 
Simple(HttpResponseStatus, T) - Constructor for class com.mastfrog.acteur.errors.ErrorResponse.Simple
Deprecated.
 
SimpleUser<IdType> - Interface in com.mastfrog.acteur.auth
A base interface for user object types which allows authentication frameworks such as acteur-auth to share basic user properties, so they can be dropped in.
SimpleUser.Base<T> - Class in com.mastfrog.acteur.auth
Simple implementation of SimpleUser
ssl() - Method in class com.mastfrog.acteur.server.ServerBuilder
 
SSL_HANDLER - Static variable in interface com.mastfrog.acteur.server.PipelineDecorator
 
sslConfig(SslContext) - Method in class com.mastfrog.acteur.server.ServerBuilder
 
startupExceptionsThrown() - Method in class com.mastfrog.acteur.server.ServerLifecycleHook.Registry
 
State - Class in com.mastfrog.acteur
The output condition of an Acteur.
status - Variable in class com.mastfrog.acteur.errors.Err
 
status - Variable in class com.mastfrog.acteur.errors.ErrorResponse.Simple
Deprecated.
 
status() - Method in class com.mastfrog.acteur.errors.Err
 
status() - Method in class com.mastfrog.acteur.errors.ErrorResponse.Simple
Deprecated.
 
status() - Method in interface com.mastfrog.acteur.errors.ErrorResponse
 
status() - Method in exception com.mastfrog.acteur.errors.ResponseException
 
status(HttpResponseStatus) - Method in class com.mastfrog.acteur.Response
Set the response code
stringContent() - Method in interface com.mastfrog.acteur.HttpEvent
Get the request body as a string, in the encoding specified by the request's content-type header, or UTF-8 if none.

T

Tarpit - Interface in com.mastfrog.acteur.auth
Used by AuthenticateBasicActeur.
TarpitCacheKeyFactory - Class in com.mastfrog.acteur.auth
 
TarpitCacheKeyFactory() - Constructor for class com.mastfrog.acteur.auth.TarpitCacheKeyFactory
 
test(HttpEvent) - Method in interface com.mastfrog.acteur.ActeurFactory.Test
Perform the test
then(ThrowingConsumer<Deferral.Resumer>) - Method in class com.mastfrog.acteur.Acteur
Defer the acteur chain, allowing the passed ThrowingConsumer to run any amount of asynchonous logic, and call Resumer.resume() with objects to be available for injection into subsequent Acteurs.
then(CompletionStage<T>) - Method in class com.mastfrog.acteur.Acteur
Pass a CompletionStage (for example, CompletableFuture) which will execute asynchronously.
then(CompletionStage<T>, HttpResponseStatus) - Method in class com.mastfrog.acteur.Acteur
Pass a CompletionStage (for example, CompletableFuture) which will execute asynchronously.
thrown - Variable in class com.mastfrog.acteur.DeferredComputationResult
 
thrown(Throwable) - Static method in class com.mastfrog.acteur.DeferredComputationResult
 
title() - Element in annotation type com.mastfrog.acteur.preconditions.Examples.Case
The title of this use case, if any.
toDependenciesBuilder() - Method in class com.mastfrog.acteur.server.ServerBuilder
 
toExternalPath(Path) - Method in interface com.mastfrog.acteur.server.PathFactory
Prepend the base path if necessary
toExternalPath(String) - Method in interface com.mastfrog.acteur.server.PathFactory
Prepend the base path if necessary
token - Variable in class com.mastfrog.acteur.auth.AuthenticationResult
 
toObject(ByteBuf, MimeType, Class<T>) - Method in class com.mastfrog.acteur.ContentConverter
 
toObject(Map<String, ?>, Class<T>) - Method in class com.mastfrog.acteur.ContentConverter
 
toPath(String) - Method in interface com.mastfrog.acteur.server.PathFactory
Convert a URI from a request to a path, stripping out the basepath if any.
toString() - Method in class com.mastfrog.acteur.Acteur.RespondWith
 
toString() - Method in class com.mastfrog.acteur.auth.SimpleUser.Base
 
toString() - Method in class com.mastfrog.acteur.Closables
 
toString() - Method in class com.mastfrog.acteur.errors.ErrorResponse.Simple
Deprecated.
 
toString(ByteBuf, Charset) - Method in class com.mastfrog.acteur.ContentConverter
 
trailer(HeaderValueType<T>, T) - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 
type() - Method in interface com.mastfrog.acteur.auth.AsyncAuthenticator
The type of the user object that will be inside the authentication result
types() - Method in class com.mastfrog.acteur.preconditions.PageAnnotationHandler.Registry
 
types() - Method in class com.mastfrog.acteur.preconditions.PageAnnotationHandler
 

U

unchunked() - Method in class com.mastfrog.acteur.Response
Set this response not to use HTTP chunked encoding.
unhandled - Variable in class com.mastfrog.acteur.errors.Err
 
UnknownNetworkEventHandler - Class in com.mastfrog.acteur.server
Handler which can receive Netty events which the framework cannot directly handle.
UnknownNetworkEventHandler() - Constructor for class com.mastfrog.acteur.server.UnknownNetworkEventHandler
 
unwind(Throwable) - Method in class com.mastfrog.acteur.errors.ExceptionEvaluator
 
urlParameter(String) - Method in interface com.mastfrog.acteur.HttpEvent
Get a single request parameter
urlParameter(String, boolean) - Method in interface com.mastfrog.acteur.HttpEvent
 
urlParametersAs(Class<T>) - Method in interface com.mastfrog.acteur.HttpEvent
Very primitive Java dynamic proxy magic: You write a Java interface with methods that each return a primitive type, and whose name corresponds to a URL parameter you expect to get.
urlParametersAsMap() - Method in interface com.mastfrog.acteur.HttpEvent
Gets the HTTP parameters as a flat map, ignoring duplicated keys.
UrlParametersMayNotBeCombined - Annotation Type in com.mastfrog.acteur.preconditions
Annotation which can appear on an Acteur with the @HttpCall annotation or on a Page with that annotation.
UrlParametersMayNotBeCombinedSets - Annotation Type in com.mastfrog.acteur.preconditions
Annotation which can appear on an Acteur with the @HttpCall annotation or on a Page with that annotation.

V

validate(HttpEvent, String) - Method in interface com.mastfrog.acteur.auth.AsyncAuthenticator
Validate an incoming authenticated request.
validate(ByteBuf, MimeType, Class<T>, Codec) - Method in class com.mastfrog.acteur.ContentConverter.ContentValidationPlugin
Validate the contents of a bytebuf without necessarily instantiating an object.
validate(Class<T>, Map<String, ?>) - Method in class com.mastfrog.acteur.ContentConverter.ContentValidationPlugin
Validate a map which will be further deserialized into an object of type T.
value() - Element in annotation type com.mastfrog.acteur.annotations.Concluders
 
value() - Element in annotation type com.mastfrog.acteur.annotations.Early
If set, the acteur chain will be paused after the acteur annotated with @Empty, and this chunk handler will be called with each chunk of content; you can call its resume() method when you're ready to continue preparing the response.
value() - Element in annotation type com.mastfrog.acteur.annotations.Precursors
 
value() - Element in annotation type com.mastfrog.acteur.Help
 
value() - Element in annotation type com.mastfrog.acteur.ImplicitBindings
Deprecated.
A list of types which Acteurs will pass in their state, which should be injectable into subsequent acteurs.
value() - Element in annotation type com.mastfrog.acteur.preconditions.Authenticated
Unused for basic auth, but may be by other authentication schemes
value() - Element in annotation type com.mastfrog.acteur.preconditions.AuthenticatedIf
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.BannedUrlParameters
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.CORS
By default, returns true.
value() - Element in annotation type com.mastfrog.acteur.preconditions.Description
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.Example
Example usage - typically a sample URL.
value() - Element in annotation type com.mastfrog.acteur.preconditions.Examples.Case
The example for this use case.
value() - Element in annotation type com.mastfrog.acteur.preconditions.Examples
Example cases
value() - Element in annotation type com.mastfrog.acteur.preconditions.InjectRequestBodyAs
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.InjectUrlParametersAs
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.MaximumPathLength
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.MaximumRequestBodyLength
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.Methods
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.MinimumRequestBodyLength
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.ParametersMustBeNumbersIfPresent
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.Path
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.PathRegex
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.RequireAtLeastOneUrlParameterFrom
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.RequiredUrlParameters
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.RequireParametersIfMethodMatches
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.UrlParametersMayNotBeCombined
 
value() - Element in annotation type com.mastfrog.acteur.preconditions.UrlParametersMayNotBeCombinedSets
 
valueOf(String) - Static method in enum com.mastfrog.acteur.preconditions.RequiredUrlParameters.Combination
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mastfrog.acteur.ResponseWriter.Status
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.mastfrog.acteur.preconditions.RequiredUrlParameters.Combination
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mastfrog.acteur.ResponseWriter.Status
Returns an array containing the constants of this enum type, in the order they are declared.
version() - Method in class com.mastfrog.acteur.auth.SimpleUser.Base
 
version() - Method in interface com.mastfrog.acteur.auth.SimpleUser
Version of this user, to be incremented when the record of this user is modified

W

WebSocketEvent - Class in com.mastfrog.acteur.server
 
WebSocketEvent(WebSocketFrame, ChannelHandlerContext, SocketAddress, Codec) - Constructor for class com.mastfrog.acteur.server.WebSocketEvent
 
WebSocketUpgradeActeur - Class in com.mastfrog.acteur.websocket
Use in @Precursors annotation before acteurs which consume and produce web socket responses.
WebSocketUpgradeActeur(HttpEvent, PathFactory, Settings, Page, Deferral, Chain, ApplicationControl, OnWebsocketConnect) - Constructor for class com.mastfrog.acteur.websocket.WebSocketUpgradeActeur
 
what - Variable in class com.mastfrog.acteur.DeferredComputationResult
 
withCode(int) - Static method in class com.mastfrog.acteur.errors.Err
 
withCode(int, String) - Static method in class com.mastfrog.acteur.errors.Err
 
withCode(HttpResponseStatus) - Method in class com.mastfrog.acteur.errors.Err
 
withHeader(CharSequence, CharSequence) - Method in class com.mastfrog.acteur.errors.Err
 
withHeader(CharSequence, CharSequence) - Method in exception com.mastfrog.acteur.errors.ResponseException
 
withHeaders(Map<? extends CharSequence, ? extends CharSequence>) - Method in class com.mastfrog.acteur.errors.Err
 
withShutdownHookWaitMillis(Duration) - Method in class com.mastfrog.acteur.server.ServerBuilder
 
withType(Class<?>...) - Method in class com.mastfrog.acteur.server.ServerBuilder
Add a type which will be bound.
WORKER_THREAD_POOL_NAME - Static variable in class com.mastfrog.acteur.server.ServerModule
Name of the @Named parameter that should be used in an annotation if you want Guice to inject the specific thread pool used for processing requests.
WORKER_THREADS - Static variable in class com.mastfrog.acteur.server.ServerModule
Settings key for the number of worker threads to use.
wrap(Class<? extends Acteur>, Dependencies) - Static method in class com.mastfrog.acteur.Acteur
 
write(byte[]) - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 
write(Application, Map<String, Object>, T) - Method in class com.mastfrog.acteur.HelpGenerator.AnnotationDescriptionPlugin
Add key/value pairs to the passed map, describing this annotation, for the JSON help description.
write(Event<?>, ResponseWriter.Output) - Method in class com.mastfrog.acteur.ResponseWriter
 
write(Event<?>, ResponseWriter.Output, int) - Method in class com.mastfrog.acteur.ResponseWriter
 
write(ByteBuf) - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 
write(FileRegion) - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 
write(HttpContent) - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 
write(InputStream) - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 
write(String) - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 
write(ByteBuffer) - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 
writeIf(boolean, String) - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 
writeObject(Object) - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 
writeObjectIf(Object, boolean) - Method in interface com.mastfrog.acteur.ResponseWriter.Output
 

X

X_INTERNAL_COMPRESS - Static variable in class com.mastfrog.acteur.server.ServerModule
Header which, when attached to a response, bypasses the compresser - used in an application which supports HTTP compression but which, for some resources, will serve pre-compressed data.
X_INTERNAL_COMPRESS_HEADER - Static variable in class com.mastfrog.acteur.server.ServerModule
Header which, when attached to a response, bypasses the compresser - used in an application which supports HTTP compression but which, for some resources, will serve pre-compressed data.
A B C D E F G H I J L M N O P R S T U V W X 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form