Package com.vaadin.server

Provides classes and interfaces that wrap the terminal-side functionalities for the server-side application. (FIXME: This could be a little more descriptive and wordy.)

Package Specification

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.
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
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.
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.UriFragmentChangedListener	Listener that that gets notified when the URI fragment of the page changes.
PaintTarget	This interface defines the methods for painting XML to the UIDL stream.
RequestHandler	Handler for producing a response to HTTP requests.
Resource	Resource provided to the client terminal.
Scrollable	This interface is implemented by all visual objects that can be scrolled programmatically from the server-side.
ServiceDestroyListener	Listener that gets notified when the VaadinService 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 a VaadinService to get an event when a new Vaadin service session is initialized for that service.
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 OutputStream provided by the StreamVariable.getOutputStream() method.
StreamVariable.StreamingEndEvent	Event passed to #uploadFinished(StreamingEndEvent) method the contents have been streamed to StreamVariable successfully.
StreamVariable.StreamingErrorEvent	Event passed to #uploadFailed(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 #uploadStarted(StreamingStartEvent) method before the streaming of the content to StreamVariable starts.
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.
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.
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	ClassResource is 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.
ConnectorResourceHandler
CustomizedSystemMessages	Contains the system messages used to notify the user about various critical situations that can occur.
DefaultDeploymentConfiguration	The default implementation of DeploymentConfiguration based 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
DownloadStream	Downloadable stream.
DragAndDropService
EncodeResult
ErrorEvent	An error thrown by the framework and handled by an ErrorHandler.
ExternalResource	ExternalResource implements source for resources fetched from location specified by URL:s.
FileDownloader	Extension that starts a download when the extended component is clicked.
FileResource	FileResources are files or directories on local filesystem.
GAEVaadinServlet	ApplicationServlet to be used when deploying to Google App Engine, in web.xml:
GenericFontIcon	A generic implementation of FontIcon interface
GlobalResourceHandler	A RequestHandler that takes care of ConnectorResources that should not be served by the connector.
JavaScriptCallbackHelper	Internal helper class used to implement functionality common to AbstractJavaScriptComponent and AbstractJavaScriptExtension.
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>	KeyMapper is 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.Styles	Contains dynamically injected styles injected in the HTML document at runtime.
Page.UriFragmentChangedEvent	Event fired when the URI fragment of a Page changes.
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 ServiceDestroyListener when a VaadinService is being destroyed.
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	StreamResource is a resource provided to the client directly by the application.
SynchronizedRequestHandler	RequestHandler which takes care of locking and unlocking of the VaadinSession automatically.
SystemError	SystemError is 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	ThemeResource is 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 UIProvider for 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 RequestHandler that presents an informative page if the browser in use is unsupported.
UserError	UserError is a controlled error occurred in application.
VaadinService	Provide deployment specific settings that are required outside terminal specific code.
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 Runnable submitted using VaadinSession.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
DeploymentConfiguration.LegacyProperyToStringMode	Deprecated.
ErrorMessage.ErrorLevel
FontAwesome	FontAwesome set of font icons.
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	PaintExcepection is 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