| java.lang.Object org.sakaiproject.courier.impl.BasicCourierService
BasicCourierService | public class BasicCourierService implements CourierService(Code) | |
BasicCourierService is the implementation for the CourierService.
|
Field Summary | |
protected Map | m_addresses Stores a List of Deliveries for each address, keyed by address. |
Method Summary | |
public void | clear(String address, String elementId) Clear any pending delivery requests to the particular client window for this element. | public void | clear(String address) Clear any pending delivery requests to this session client window. | public void | deliver(Delivery delivery) Queue up a delivery for the client window identified in the Delivery object. | public void | destroy() Returns to uninitialized state. | public List | getDeliveries(String address) Access and de-queue the Deliveries queued up for a particular session client window.
Parameters: address - The address of client window. | public boolean | hasDeliveries(String address) Check to see if there are any deliveries queued up for a particular session client window.
Parameters: address - The address of the client window. | public void | init() Final initialization, once all dependencies are set. |
m_addresses | protected Map m_addresses(Code) | | Stores a List of Deliveries for each address, keyed by address.
|
clear | public void clear(String address, String elementId)(Code) | | Clear any pending delivery requests to the particular client window for this element.
Parameters: address - The address of the client window. Parameters: elementId - The id of the html element. |
clear | public void clear(String address)(Code) | | Clear any pending delivery requests to this session client window.
Parameters: address - The address of client window. |
deliver | public void deliver(Delivery delivery)(Code) | | Queue up a delivery for the client window identified in the Delivery object. The particular form of delivery is determined by the type of Delivery object sent.
Parameters: delivery - The Delivery (or extension) object to deliver. |
destroy | public void destroy()(Code) | | Returns to uninitialized state.
|
getDeliveries | public List getDeliveries(String address)(Code) | | Access and de-queue the Deliveries queued up for a particular session client window.
Parameters: address - The address of client window. a List of Delivery objects addressed to this session client window. |
hasDeliveries | public boolean hasDeliveries(String address)(Code) | | Check to see if there are any deliveries queued up for a particular session client window.
Parameters: address - The address of the client window. true if there are deliveries for this client window, false if not. |
init | public void init()(Code) | | Final initialization, once all dependencies are set.
|
|
|