Package com.vaadin.flow.server
-
Interface Summary Interface Description AbstractConfiguration Defines a base contract for configuration (e.g.BootstrapHandler.PageBuilder Interface for objects capable of building the bootstrap page.BootstrapInitialPredicate The callback used by bootstrap handlers in order to know when a request needs to pre-render the UI and include the initial UIDL in the page.BootstrapListener Deprecated. Since 3.0, this API is deprecated in favor ofIndexHtmlRequestListener
when using client-side bootstrappingBootstrapUrlPredicate The callback used by bootstrap handlers in order to know when a request is a valid URL to render the page.Command A generic command interface meant to be used for passing lambdas around.DependencyFilter Filter for dependencies loaded using@StyleSheet
, and *@JavaScript
.ErrorHandler Application errors handler.ErrorHandlingCommand Defines the interface to handle exceptions thrown during the execution of a FutureAccess.ErrorRouteRegistry Interface class for RouteRegistries that can be used to request for error navigation views for Exceptions.InputStreamFactory Creates input stream instances that provides the actual data of aStreamResource
.PageConfigurator Deprecated. since 3.0 useAppShellConfigurator
RequestHandler Handler for producing a response to HTTP requests.RouteRegistry The RouteRegistry interface class that gives the out facing usage needs for a route registry implementation.ServiceDestroyListener Listener that gets notified when theVaadinService
to which it has been registered is destroyed.SessionDestroyListener A listener that gets notified when a Vaadin service session is no longer used.SessionExpiredHandler A specialized RequestHandler which is capable of sending session expiration messages to the user.SessionInitListener Event listener that can be registered to aVaadinService
to get an event when a new Vaadin service session is initialized for that service.StaticFileHandler Handler for static files.StaticFileHandlerFactory A factory to create aStaticFileHandler
.StreamRegistration Stream registration result.StreamResourceWriter Output stream consumer.StreamVariable StreamVariable is a special kind of variable whose value is streamed to anOutputStream
provided by theStreamVariable.getOutputStream()
method.StreamVariable.StreamingEndEvent Event passed toStreamVariable.streamingFinished(StreamingEndEvent)
method the contents have been streamed to StreamVariable successfully.StreamVariable.StreamingErrorEvent Event passed toStreamVariable.streamingFailed(StreamingErrorEvent)
method when the streaming ended before the end of the input.StreamVariable.StreamingEvent Streaming event interface.StreamVariable.StreamingProgressEvent Event passed toStreamVariable.onProgress(StreamingProgressEvent)
method during the streaming progresses.StreamVariable.StreamingStartEvent Event passed toStreamVariable.streamingStarted(StreamingStartEvent)
method before the streaming of the content toStreamVariable
starts.SystemMessagesProvider Gives out system messages based on Locale.UIInitListener Event listener that can be registered for receiving an event when aUI
is initialized.VaadinConfig Configuration in whichVaadinService
is running.VaadinContext Context in whichVaadinService
is running.VaadinRequest A generic request to the server, wrapping a more specific request type, e.g.VaadinResponse A generic response from the server, wrapping a more specific response type, e.g.VaadinServiceInitListener Listener forVaadinService
initialization events.WrappedSession A generic session, wrapping a more specific session implementation, e.g. -
Class Summary Class Description AbstractDeploymentConfiguration An abstract base class for DeploymentConfiguration implementations.AbstractPropertyConfiguration Provides a configuration based on string properties.AbstractStreamResource Abstract stream resource class.AppShellRegistry The registry class forAppShellConfigurator
annotations.AppShellRegistry.AppShellRegistryWrapper A wrapper class for storing theAppShellRegistry
instance in the servlet context.AppShellSettings Initial page settings class for modifying the application shell.Attributes TheAttributes
class represents a set of attributes.BootstrapHandler Request handler which handles bootstrapping of the application, i.e.BootstrapHandler.BootstrapContext Provides context information for the bootstrap process.BootstrapHandler.BootstrapPageBuilder Builds bootstrap pages.BootstrapHandler.BootstrapUriResolver The URI resolver used in the bootstrap process.BootstrapPageResponse Deprecated. Since 3.0, this API is deprecated in favor ofIndexHtmlResponse
when using client-side bootstrappingConstants Constants used by the server side framework.CustomizedSystemMessages Contains the system messages used to notify the user about various critical situations that can occur.DefaultDeploymentConfiguration The default implementation ofDeploymentConfiguration
based on a base class for resolving system properties and a set of init parameters.DefaultErrorHandler The default implementation ofErrorHandler
.DefaultSystemMessagesProvider System messages provider using the built-in default system messages.DeploymentConfigurationFactory CreatesDeploymentConfiguration
filled with all parameters specified by the framework users.ErrorEvent An error thrown by the framework and handled by anErrorHandler
.FutureAccess Encapsulates aCommand
submitted usingVaadinSession.access(Command)
.HandlerHelper Contains helper methods forVaadinServlet
and generally for handlingVaadinRequests
.InitialPageSettings Deprecated. since 3.0 useAppShellSettings
InitParameters Constants for all servlet init parameters.InlineTargets Data holder class for collectedInline
annotations to be added to the initial page.Platform Provides information about the current version of Vaadin Platform.PropertyDeploymentConfiguration The property handling implementation ofDeploymentConfiguration
based on a base class for resolving system properties and a set of init parameters.PwaConfiguration Holds the configuration from thePWA
annotation.PwaIcon Implementation of icons used in PWA resources.PwaRegistry Registry for PWA data.ServiceContextUriResolver A URI resolver which resolves paths for loading through VaadinService resource methods.ServiceDestroyEvent Event fired toServiceDestroyListener
when aVaadinService
is being destroyed.ServiceInitEvent Event fired toVaadinServiceInitListener
when aVaadinService
is being initialized.SessionDestroyEvent Event fired when a Vaadin service session is no longer in use.SessionInitEvent Event gets fired when a new Vaadin service session is initialized for a Vaadin service.SessionRouteRegistry SessionRouteRegistry is a mutable route registry that is valid in the scope of VaadinSession.StaticFileServer Handles sending of resources from the WAR root (web content) or META-INF/resources in the case thatVaadinServlet
is mapped using "/*".StreamReceiver Represents a receiver for data upload from the client.StreamResource Represents dynamically generated data.StreamResourceRegistry Registry forStreamResource
instances.SynchronizedRequestHandler RequestHandler which takes care of locking and unlocking of the VaadinSession automatically.SystemMessages Contains the system messages used to notify the user about various critical situations that can occur.SystemMessagesInfo Provides information available forSystemMessagesProvider
when defining whatSystemMessages
to use.UIInitEvent Event fired toUIInitListener
when aUI
has been initialized.UnsupportedBrowserHandler ARequestHandler
that presents an informative page if the browser in use is unsupported.VaadinService An abstraction of the underlying technology, e.g.VaadinServlet The main servlet, which handles all incoming requests to the application.VaadinServletConfig VaadinConfig
implementation for Servlets.VaadinServletContext VaadinContext
that goes withVaadinServletService
.VaadinServletRequest Wrapper forHttpServletRequest
.VaadinServletResponse Wrapper forHttpServletResponse
.VaadinServletService A service implementation connected to aVaadinServlet
.VaadinSession Contains everything that Vaadin needs to store for a specific user.Version Provides information about the current version of Vaadin Flow.WebBrowser Provides information about the web browser the user is using that is directly available in the request, for instance browser name and version and IP address.WrappedHttpSession Wrapper forHttpSession
. -
Enum Summary Enum Description HandlerHelper.RequestType Framework internal enum for tracking the type of a request.HttpStatusCode HTTP status codes as defined in RFC 2068.InitialPageSettings.Position Append position enum.InitialPageSettings.WrapMode Content wrapping mode enum.PwaIcon.Domain Place where icon belongs to (header or manifest.webmanifest).VaadinSessionState The lifecycle state of a VaadinSession. -
Exception Summary Exception Description AmbiguousRouteConfigurationException Exception indicating that the application's routes already has the navigation target with the given path.BootstrapException A Vaadin internal runtime exception thrown when the writing of the bootstrap page inBootstrapHandler
fails for some reason.ExecutionFailedException Thrown byFallibleCommand
if it's unable to complete its execution.InvalidApplicationConfigurationException Exception indicating that the application's routes have been configured incorrectly.InvalidCustomElementNameException Exception indicating that the custom-element name is invalid.InvalidI18NConfigurationException Exception indicating that the application's I18N localization has been configured incorrectly.InvalidRouteConfigurationException Exception indicating that the application's routes have been configured incorrectly.InvalidRouteLayoutConfigurationException Exception indicating that Route layouts configuration has problems.NoInputStreamException Exception for when there is noInputStream
available.NoOutputStreamException Exception for when there is noOutputStream
available.ServiceException Thrown for problems which occur in theVaadinService
layer.SessionExpiredException Exception indicating that the session has expired.UploadException Upload exception class. -
Annotation Types Summary Annotation Type Description PWA Defines application PWA properties.