All Classes and Interfaces
Class
Description
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.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.
Factory for standard Acteur implementations, mainly used to determine if a
request is valid (matches a URL, is using a supported HTTP method, etc.).
A test which can be performed on a request, for example, to decide about
branching
Provides a default implementation using self-signed certificates, but may
be bound to provide your own.
A web application.
SPI interface which the request handling infrastructure uses to dispatch
events to and otherwise manage the application.
Configures an acteur application for asynchronous authentication.
Asynchronous authenticator.
Deprecated.
Do not use directly - bind AuthenticationActeur instead, so that
authentication strategies are pluggable
Decorator which can do things to the response on authentication
succeess/failure, such as setting/clearing cookies
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).
Marks an endpoint as authenticated if the named setting is set to true.
Result of asynchronous authentication, injectable into subsequent acteurs.
Deprecated.
Use @Authenticated instead
Processes the page annotations in com.mastfrog.acteur.preconditions and adds
acteurs to the list appropriately.
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.
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.
Subclasses of this can be used from the @Early annotation to provide an
object that will process inbound HTTP chunks.
A registry of resources (for example, streams or JDBC objects) which should
be closed if the connection terminates while a response is being processed.
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.
Converts byte buffers and maps to objects
Marks endpoints that should have CORS headers associated with it.
Decorates cors responses.
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).Provide a description for a page or acteur which will be used by
Application.getHelpPageType() to provide an API-level help call.
Annotate an Acteur with this, to have it run as soon as the headers are
received, disabling chunk aggregation.
Convenience implementation of ErrorResponse backed by a map, with
constructors for various common scenarios.
Renders error messages into responses
Information needed to generate an http response for an error.
Deprecated.
Use ErrorResponse.create() instead.
An HTTP request or similar, which is passed to Pages for their Acteurs to
respond to.
Factory for event loop groups used by the Netty transport.
Allows a call to include an example URL and sample inputs and outputs in the
generated documentation.
Handles the case where one HTTP call supports multiple uses or multiple types
of input and output (ex.
Converts exceptions thrown inside Acteurs into error messages.
Registry of things which create error responses for exceptions.
Bind in guice to customize 404 not found responses, and failures that cannot
be handled by ErrorRenderer (i.e.
An application which looks up its pages using registry files on the
classpath, generated by an annotation processor which processes
@HttpCall annotations.
Acteur ServerModule which uses GenericApplication.
If this annotation appears on an Application, it automatically makes a Help
page available.
Generates JSON help for the application; HelpPage converts this into HTML.
Allows code to be plugged in to contribute to the help page information
about specific types of annotation.
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.
Make the request body available as the passed type.
Make the request parameters available as the passed type.
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.
Annotation which can appear on an Acteur with the @HttpCall annotation
or on a Page with that annotation.
Annotation which can be set on Page classes to determine what methods are
respond to.
Annotation which can appear on an Acteur with the @HttpCall annotation
or on a Page with that annotation.
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).
Global interface called when a websocket connection has been successfully
handshaken via WebSocketUpgradeActeur.
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.
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.
Registry of PageAnnotationHandlers
Annotation which can appear on an Acteur with the @HttpCall annotation
or on a Page with that annotation.
Specifieds a glob-style URL path, such as /mything/* - a * can represent
anything but a / character.
Provider of paths for a web application, which can normalize paths and strip
out the base path for the web application, if any.
Annotation which determines regular expressions used to determine whether a
page responds to a given request.
Allows applications to inject encoders or decoders into the Netty channel
pipeline.
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.
Optionally may be bound to trace the activity in response to a request.
Logger which can be injected, which takes care of actually logging each
request and response.
Annotation which can appear on an Acteur with the @HttpCall annotation
or on a Page with that annotation.
Annotation which causes a Page to return
400 Bad Request if the
url parameters do not match what the annotation describes.Annotation which can appear on an Acteur with the @HttpCall annotation
or on a Page with that annotation.
Abstraction for a response
Exception that can be thrown from a Provider and result in a specific HTTP
error response.
Abstraction over Netty's channel/ByteBuf to insulate from changes there.
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).
Hides the complexity of initializing Guice and Settings to start a server
simply.
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.
Guice module for creating a server; also defines settings keys which can
affect behavior.
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.
Simple implementation of SimpleUser
The output condition of an
Acteur.Used by AuthenticateBasicActeur.
Handler which can receive Netty events which the framework cannot directly
handle.
Annotation which can appear on an Acteur with the @HttpCall annotation
or on a Page with that annotation.
Annotation which can appear on an Acteur with the @HttpCall annotation
or on a Page with that annotation.
Use in @Precursors annotation before acteurs which consume and produce
web socket responses.