Package muntjac :: Package terminal :: Package gwt :: Package server :: Module communication_manager :: Class CommunicationManager
[hide private]
[frames] | no frames]

Class CommunicationManager

source code

                                         object --+            
                                                  |            
                                util.IEventListener --+        
                                                      |        
                                   paintable.IPaintable --+    
                                                          |    
                                             object --+   |    
                                                      |   |    
                      paintable.IRepaintRequestListener --+    
                                                          |    
abstract_communication_manager.AbstractCommunicationManager --+
                                                              |
                                                             CommunicationManager

Application manager processes changes and paints for single application instance.

This class handles applications running as servlets.


See Also: AbstractCommunicationManager

Authors:
Vaadin Ltd., Richard Lincoln

Version: 1.1.2

Instance Methods [hide private]
 
__init__(self, application, applicationServlet=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
handleFileUpload(self, request, response, applicationServlet)
Handles file upload request submitted via Upload component.
source code
 
handleUidlRequest(self, request, response, applicationServlet, window)
Handles UIDL request.
source code
 
getApplicationWindow(self, request, applicationServlet, application, assumedWindow)
Gets the existing application or creates a new one.
source code
 
handleURI(self, window, request, response, applicationServlet)
Calls the Window URI handler for a request and returns the DownloadStream returned by the handler.
source code
 
unregisterPaintable(self, p)
Called when communication manager stops listening for repaints for given component.
source code
 
getStreamVariableTargetUrl(self, owner, name, value) source code
 
cleanStreamVariable(self, owner, name) source code

Inherited from abstract_communication_manager.AbstractCommunicationManager: changeVariables, closeJsonMessage, convertArray, convertMap, convertStringArray, convertVariableValue, decodeVariableValue, doGetApplicationWindow, doHandleSimpleMultipartFileUpload, doHandleUidlRequest, doHandleXhrFilePost, endApplication, generateLocale, getApplication, getDirtyVisibleComponents, getDragAndDropService, getPaintableId, getRequestPayload, getRequestTheme, getTagForType, getTheme, getTimeoutInterval, getVariableOwner, handleChangeVariablesError, handleVariableBurst, handleVariables, hasPaintableId, highlightPaintable, makeAllPaintablesDirty, openJsonMessage, paintAfterVariableChanges, paintablePainted, printHighlightedComponentHierarchy, printLocaleDeclarations, repaintRequested, requireLocale, sendUploadResponse, streamToReceiver, tryToCloseStream, writeUidlResponce

Inherited from paintable.IPaintable: addCallback, addListener, getDebugId, paint, removeCallback, removeListener, requestRepaint, requestRepaintRequests, setDebugId

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]

Inherited from abstract_communication_manager.AbstractCommunicationManager: isChildOf, removePath

Class Variables [hide private]

Inherited from abstract_communication_manager.AbstractCommunicationManager: VAR_ARRAYITEM_SEPARATOR, VAR_BURST_SEPARATOR, VAR_ESCAPE_CHARACTER

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, application, applicationServlet=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

Deprecated: use CommunicationManager instead

handleFileUpload(self, request, response, applicationServlet)

source code 

Handles file upload request submitted via Upload component.

See Also: getStreamVariableTargetUrl @raise IOException: @raise InvalidUIDLSecurityKeyException:

handleUidlRequest(self, request, response, applicationServlet, window)

source code 

Handles UIDL request.

Parameters:
  • request
  • response
  • applicationServlet
  • window - target window of the UIDL request, can be null if window not found
Raises:

getApplicationWindow(self, request, applicationServlet, application, assumedWindow)

source code 

Gets the existing application or creates a new one. Get a window within an application based on the requested URI.

Parameters:
  • request - the HTTP Request.
  • application - the Application to query for window.
  • assumedWindow - if the window has been already resolved once, this parameter must contain the window.
Returns:
Window matching the given URI or null if not found.
Raises:
  • ServletException - if an exception has occurred that interferes with the servlet's normal operation.

handleURI(self, window, request, response, applicationServlet)

source code 

Calls the Window URI handler for a request and returns the DownloadStream returned by the handler.

If the window is the main window of an application, the deprecated Application.handleURI is called first to handle ApplicationResources and the window handler is only called if it returns None.

Parameters:
  • window - the target window of the request
  • request - the request instance
  • response - the response to write to
Returns:
DownloadStream if the request was handled and further processing should be suppressed, null otherwise.
Overrides: abstract_communication_manager.AbstractCommunicationManager.handleURI

unregisterPaintable(self, p)

source code 

Called when communication manager stops listening for repaints for given component.

Overrides: abstract_communication_manager.AbstractCommunicationManager.unregisterPaintable
(inherited documentation)

getStreamVariableTargetUrl(self, owner, name, value)

source code 
Overrides: abstract_communication_manager.AbstractCommunicationManager.getStreamVariableTargetUrl

cleanStreamVariable(self, owner, name)

source code 
Overrides: abstract_communication_manager.AbstractCommunicationManager.cleanStreamVariable