Class CmsUIServlet

  • All Implemented Interfaces:
    com.vaadin.server.Constants, com.vaadin.server.SessionInitListener, com.vaadin.server.SystemMessagesProvider, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

    public class CmsUIServlet
    extends com.vaadin.server.VaadinServlet
    implements com.vaadin.server.SystemMessagesProvider, com.vaadin.server.SessionInitListener
    Servlet for workplace UI requests.

    See Also:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.vaadin.server.VaadinServlet

        com.vaadin.server.VaadinServlet.RequestType
    • Field Summary

      • Fields inherited from interface com.vaadin.server.Constants

        ATMOSPHERE_MISSING_ERROR, CANNOT_ACQUIRE_CLASSLOADER_SEVERE, DEFAULT_BUFFER_SIZE, DEFAULT_THEME_CACHETIME, DEFAULT_THEME_NAME, DEFAULT_WIDGETSET, ERROR_NO_UI_FOUND, INVALID_ATMOSPHERE_VERSION_WARNING, INVALID_SECURITY_KEY_MSG, MAX_BUFFER_SIZE, NOT_PRODUCTION_MODE_INFO, PARAMETER_VAADIN_RESOURCES, PARAMETER_WIDGETSET, PORTAL_PARAMETER_VAADIN_RESOURCE_PATH, PORTAL_PARAMETER_VAADIN_THEME, PORTAL_PARAMETER_VAADIN_WIDGETSET, PORTLET_CONTEXT, PUSH_NOT_SUPPORTED_ERROR, REQUIRED_ATMOSPHERE_RUNTIME_VERSION, SERVLET_PARAMETER_CLOSE_IDLE_SESSIONS, SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION, SERVLET_PARAMETER_HEARTBEAT_INTERVAL, SERVLET_PARAMETER_LEGACY_DESIGN_PREFIX, SERVLET_PARAMETER_PRODUCTION_MODE, SERVLET_PARAMETER_PUSH_MODE, SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING, SERVLET_PARAMETER_RESOURCE_CACHE_TIME, SERVLET_PARAMETER_SENDURLSASPARAMETERS, SERVLET_PARAMETER_SYNC_ID_CHECK, SERVLET_PARAMETER_UI_PROVIDER, THEME_DIR_PATH, URL_PARAMETER_THEME, WARNING_HEARTBEAT_INTERVAL_NOT_NUMERIC, WARNING_PUSH_MODE_NOT_RECOGNIZED, WARNING_RESOURCE_CACHING_TIME_NOT_NUMERIC, WARNING_XSRF_PROTECTION_DISABLED, WIDGETSET_DIR_PATH, WIDGETSET_MISMATCH_INFO
    • Constructor Summary

      Constructors 
      Constructor Description
      CmsUIServlet()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected com.vaadin.server.VaadinServletService createServletService​(com.vaadin.server.DeploymentConfiguration deploymentConfiguration)  
      CmsObject getCmsObject()
      Returns the current cms context.
      com.vaadin.server.SystemMessages getSystemMessages​(com.vaadin.server.SystemMessagesInfo systemMessagesInfo)  
      protected void service​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)  
      protected void servletInitialized()  
      void sessionInit​(com.vaadin.server.SessionInitEvent event)  
      void setBroadcastPoll()
      Sets that the current request is a broadcast call.
      void setCms​(CmsObject cms)
      Sets the current cms context.
      • Methods inherited from class com.vaadin.server.VaadinServlet

        allowServePrecompressedResource, createDeploymentConfiguration, createDeploymentConfiguration, createServletService, createVaadinRequest, criticalNotification, destroy, findResourceURL, getApplicationUrl, getCacheTime, getCurrent, getDefaultTheme, getLastPathParameter, getRequestType, getResourcePath, getService, getStaticFilePath, handleContextRootWithoutSlash, init, isAllowedVAADINResourceUrl, isStaticResourceRequest, safeEscapeForHtml, serveStaticResources, serveStaticResourcesInVAADIN, stripSpecialChars, writeStaticResourceResponse
      • Methods inherited from class javax.servlet.http.HttpServlet

        doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service
      • Methods inherited from class javax.servlet.GenericServlet

        getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getCmsObject

        public CmsObject getCmsObject()
        Returns the current cms context.

        Returns:
        the current cms context
      • getSystemMessages

        public com.vaadin.server.SystemMessages getSystemMessages​(com.vaadin.server.SystemMessagesInfo systemMessagesInfo)
        Specified by:
        getSystemMessages in interface com.vaadin.server.SystemMessagesProvider
        See Also:
        SystemMessagesProvider.getSystemMessages(com.vaadin.server.SystemMessagesInfo)
      • sessionInit

        public void sessionInit​(com.vaadin.server.SessionInitEvent event)
        Specified by:
        sessionInit in interface com.vaadin.server.SessionInitListener
        See Also:
        SessionInitListener.sessionInit(com.vaadin.server.SessionInitEvent)
      • setBroadcastPoll

        public void setBroadcastPoll()
        Sets that the current request is a broadcast call.

      • setCms

        public void setCms​(CmsObject cms)
        Sets the current cms context.

        Parameters:
        cms - the current cms context to set
      • createServletService

        protected com.vaadin.server.VaadinServletService createServletService​(com.vaadin.server.DeploymentConfiguration deploymentConfiguration)
                                                                       throws com.vaadin.server.ServiceException
        Overrides:
        createServletService in class com.vaadin.server.VaadinServlet
        Throws:
        com.vaadin.server.ServiceException
        See Also:
        VaadinServlet.createServletService(com.vaadin.server.DeploymentConfiguration)
      • service

        protected void service​(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws javax.servlet.ServletException,
                               java.io.IOException
        Overrides:
        service in class com.vaadin.server.VaadinServlet
        Throws:
        javax.servlet.ServletException
        java.io.IOException
        See Also:
        VaadinServlet.service(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
      • servletInitialized

        protected void servletInitialized()
                                   throws javax.servlet.ServletException
        Overrides:
        servletInitialized in class com.vaadin.server.VaadinServlet
        Throws:
        javax.servlet.ServletException
        See Also:
        VaadinServlet.servletInitialized()