We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.server.
Package com.vaadin.server
-
Interface Summary Interface Description BootstrapListener Event listener notified when the bootstrap HTML is about to be generated and send to the client.
ClientConnector Interface implemented by all connectors that are capable of communicating with the client side.
ClientConnector.AttachListener Interface for listening
connector attach events.ClientConnector.DetachListener Interface for listening
connector detach events.ConnectorIdGenerator Callback for generating the id for new connectors.
ConnectorResource A resource that is served through the Connector that is using the resource.
Constants Internal constants used by both the client and the server side framework.
DependencyFilter Filter for dependencies loaded using
@StyleSheet,@JavaScriptand@HtmlImport.DeploymentConfiguration A collection of properties configured at deploy time as well as a way of accessing third party properties not explicitly supported by this class.
ErrorHandler Interface for listening to errors in the application.
ErrorHandlingRunnable Defines the interface to handle exceptions thrown during the execution of a FutureAccess.
ErrorMessage Interface for rendering error messages to terminal.
ErrorMessageProducer Deprecated. EventTrigger Provides support for triggering an event from a given parts of a component or using various events.
Extension An extension is an entity that is attached to a Component or another Extension and independently communicates between client and server.
FontIcon A font icon is a type of icon that is made by displaying one character from a specially constructed font containing icons ("icon font").
JsonCodec.BeanProperty Page.BrowserWindowResizeListener Listener that gets notified when the size of the browser window containing the uI has changed.
Page.PopStateListener Listener that that gets notified when the URI of the page changes due to back/forward functionality of the browser.
Page.UriFragmentChangedListener Deprecated. UsePage.PopStateListenerinsteadPaintTarget This interface defines the methods for painting XML to the UIDL stream.
RequestHandler Handler for producing a response to HTTP requests.
Resource Resourceprovided to the client terminal.Scrollable This interface is implemented by all visual objects that can be scrolled programmatically from the server-side.
SerializableBiFunction<T,U,R> A
BiFunctionthat is alsoSerializable.SerializableBiPredicate<T,U> A
BiPredicatethat is alsoSerializable.SerializableComparator<T> A
Comparatorthat is alsoSerializable.SerializableConsumer<T> A
Consumerthat is alsoSerializable.SerializableFunction<T,R> A
Functionthat is alsoSerializable.SerializablePredicate<T> A
Predicatethat is alsoSerializable.SerializableSupplier<T> A
Supplierthat is alsoSerializable.SerializableToIntFunction<T> A
ToIntFunctionthat is alsoSerializable.ServiceDestroyListener Listener that gets notified when the
VaadinServiceto 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 a
VaadinServiceto get an event when a new Vaadin service session is initialized for that service.Setter<BEAN,FIELDVALUE> The function to write the field value to the bean property.
Sizeable Interface to be implemented by components wishing to display some object that may be dynamically resized during runtime.
StreamResource.StreamSource Interface implemented by the source of a StreamResource.
StreamVariable StreamVariable is a special kind of variable whose value is streamed to an
OutputStreamprovided by theStreamVariable.getOutputStream()method.StreamVariable.StreamingEndEvent Event passed to
StreamVariable.streamingFinished(StreamingEndEvent)method the contents have been streamed to StreamVariable successfully.StreamVariable.StreamingErrorEvent Event passed to
StreamVariable.streamingFailed(StreamingErrorEvent)method when the streaming ended before the end of the input.StreamVariable.StreamingEvent StreamVariable.StreamingProgressEvent Event passed to
StreamVariable.onProgress(StreamingProgressEvent)method during the streaming progresses.StreamVariable.StreamingStartEvent Event passed to
StreamVariable.streamingStarted(StreamingStartEvent)method before the streaming of the content toStreamVariablestarts.SynchronizedRequestHandler.ResponseWriter ResponseWriter is optionally returned by request handlers which implement
SynchronizedRequestHandler.synchronizedHandleRequest(VaadinSession, VaadinRequest, VaadinResponse, String)The ResponseWriter will be executed bySynchronizedRequestHandler.handleRequest(VaadinSession, VaadinRequest, VaadinResponse)without holding Vaadin session lock.SystemMessagesProvider Gives out system messages based on Locale.
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 for
VaadinServiceinitialization events.VariableOwner Deprecated. As of 7.0.ViewportGenerator Callback for generating a viewport tag content based on a request.
WidgetsetInfo An interface describing the widgetset that the client should try to load.
WrappedSession A generic session, wrapping a more specific session implementation, e.g.
-
Class Summary Class Description AbstractClientConnector An abstract base class for ClientConnector implementations.
AbstractDeploymentConfiguration An abstract base class for DeploymentConfiguration implementations.
AbstractErrorMessage Base class for component error messages.
AbstractExtension An extension is an entity that is attached to a Component or another Extension and independently communicates between client and server.
AbstractJavaScriptExtension Base class for Extensions with all client-side logic implemented using JavaScript.
BootstrapFragmentResponse A representation of a bootstrap fragment being generated.
BootstrapHandler Deprecated. As of 7.0.BootstrapHandler.BootstrapUriResolver The URI resolver used in the bootstrap process.
BootstrapPageResponse A representation of a bootstrap page being generated.
BootstrapResponse Base class providing common functionality used in different bootstrap modification events.
BrowserWindowOpener Component extension that opens a browser popup window when the extended component is clicked.
ClassResource ClassResourceis a named resource accessed with the class loader.ClientConnector.AttachEvent Event fired after a connector is attached to the application.
ClientConnector.ConnectorErrorEvent An error event for connector related errors.
ClientConnector.DetachEvent Event fired before a connector is detached from the application.
ClientMethodInvocation Internal class for keeping track of pending server to client method invocations for a Connector.
ComponentSizeValidator ComponentSizeValidator.FileLocation ComponentSizeValidator.InvalidLayout CompositeErrorMessage Class for combining multiple error messages together.
ConnectorIdGenerationEvent Event object containing information related to connector id generation.
ConnectorResourceHandler CustomizedSystemMessages Contains the system messages used to notify the user about various critical situations that can occur.
DefaultDeploymentConfiguration The default implementation of
DeploymentConfigurationbased on a base class for resolving system properties and a set of init parameters.DefaultErrorHandler DefaultSystemMessagesProvider System messages provider using the built-in default system messages.
DefaultUIProvider DependencyFilter.FilterContext Provides context information for the dependency filter operation.
DownloadStream Downloadable stream.
DragAndDropService Deprecated. Since 8.1, no direct replacement, seeDragSourceExtensionandDropTargetExtension.EncodeResult ErrorEvent An error thrown by the framework and handled by an
ErrorHandler.ExternalResource ExternalResourceimplements source for resources fetched from location specified by URL:s.FileDownloader Extension that starts a download when the extended component is clicked.
FileResource FileResourcesare files or directories on local filesystem.GenericFontIcon A generic implementation of
FontIconinterface.GlobalResourceHandler A
RequestHandlerthat takes care ofConnectorResources that should not be served by the connector.JavaScriptCallbackHelper Internal helper class used to implement functionality common to
AbstractJavaScriptComponentandAbstractJavaScriptExtension.JsonCodec Decoder for converting RPC parameters and other values from JSON in transfer between the client and the server and vice versa.
JsonPaintTarget User Interface Description Language Target.
KeyMapper<V> KeyMapperis the simple two-way map for generating textual keys for objects and retrieving the objects later with the key.LegacyApplication Deprecated. As of 7.0.LegacyApplicationUIProvider Deprecated. As of 7.0.LegacyCommunicationManager Deprecated. As of 7.0.LegacyPaint LegacyVaadinServlet LocaleService Server side service which handles locale and the transmission of locale date to the client side LocaleService.
Page Page.BrowserWindowResizeEvent Event that is fired when a browser window containing a uI is resized.
Page.PopStateEvent Event fired when the URI of a
Pagechanges (aka HTML 5 popstate event) on the client side due to browsers back/forward functionality.Page.Styles Contains dynamically injected styles injected in the HTML document at runtime.
Page.UriFragmentChangedEvent Event fired when the URI fragment of a
Pagechanges.ResourceReference Responsive An extension providing responsive layout capabilities to any Vaadin component.
ServerRpcManager<T extends ServerRpc> Server side RPC manager that handles RPC calls coming from the client.
ServerRpcMethodInvocation ServiceDestroyEvent Event fired to
ServiceDestroyListenerwhen aVaadinServiceis being destroyed.ServiceInitEvent Event fired to
VaadinServiceInitListenerwhen aVaadinServiceis being initialized.ServletPortletHelper Deprecated. As of 7.1.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.
SizeWithUnit A class for representing a value-unit pair.
StreamResource StreamResourceis a resource provided to the client directly by the application.SynchronizedRequestHandler RequestHandler which takes care of locking and unlocking of the VaadinSession automatically.
SystemError SystemErroris an error message for a problem caused by error in system, not the user application code.SystemMessages Contains the system messages used to notify the user about various critical situations that can occur.
SystemMessagesInfo ThemeResource ThemeResourceis a named theme dependant resource provided and managed by a theme.UIClassSelectionEvent Contains information used by
UIProvider.getUIClass(UIClassSelectionEvent)to choose a UI class to use in a specific situation.UICreateEvent Contains data used by various methods in
UIProviderfor determining information about a new UI that is about to be created.UIProvider UIProviderEvent Base class for the events that are sent to various methods in UIProvider.
UnsupportedBrowserHandler A
RequestHandlerthat presents an informative page if the browser in use is unsupported.UserError UserErroris a controlled error occurred in application.VaadinService Provide deployment specific settings that are required outside terminal specific code.
VaadinServiceClassLoaderUtil Utility class used by
VaadinService.setDefaultClassLoader().VaadinServlet VaadinServletRequest Wrapper for
HttpServletRequest.VaadinServletResponse Wrapper for
HttpServletResponse.VaadinServletService VaadinSession Contains everything that Vaadin needs to store for a specific user.
VaadinSession.FutureAccess Encapsulates a
Runnablesubmitted usingVaadinSession.access(Runnable).WebBrowser Class that provides information about the web browser the user is using.
WrappedHttpSession Wrapper for
HttpSession. -
Enum Summary Enum Description AbstractErrorMessage.ContentMode FontAwesome Deprecated. Since 8.0 replaced with included Vaadin Icons (#7979).PaintTarget.PaintStatus Result of starting to paint a Component (
PaintTarget.startPaintable(Component, String)).Sizeable.Unit VaadinServlet.RequestType Deprecated. As of 7.0.VaadinSession.State The lifecycle state of a VaadinSession.
-
Exception Summary Exception Description LegacyCommunicationManager.InvalidUIDLSecurityKeyException Deprecated. As of 7.1.NoInputStreamException NoOutputStreamException PaintException PaintExcepectionis thrown if painting of a component fails.ServerRpcManager.RpcInvocationException Wrapper exception for exceptions which occur during invocation of an RPC call.
ServiceException SessionExpiredException SystemMessageException UploadException