dk.brics.jwig

Class XMLProducer

java.lang.Object

dk.brics.jwig.WebContext

dk.brics.jwig.AbstractHandler

dk.brics.jwig.XMLProducer

All Implemented Interfaces:

ToXMLable

@Regenerable
public class XMLProducer
extends AbstractHandler
implements ToXMLable

Handler that produces XML data when an object it depends on has been changed.

Field Summary

Fields inherited from class dk.brics.jwig.WebContext

CACHE_PRIORITY, context, HANDLERS, JWIG_DEFUNCT_SESSION, log, MAX_PRIORITY, PRE_CACHE

Constructor Summary

Constructors

Constructor and Description
XMLProducer(Object... dependencies) Constructs a new XML producer.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Invoked when the current response is invalidated.
(package private) XML	invokeRun() Invokes the run and returns the XML result.
(package private) Object	process(String referer) Invokes the run method of the handler, caches the result, and sends it to the client.
XML	toXML() Returns an XML value obtained by invoking run, together with a JavaScript instruction for automatic updating.
void	update() Invoked when a new result has been computed.

Methods inherited from class dk.brics.jwig.AbstractHandler

getHandlerIdentifier, hashCode, toString

Methods inherited from class dk.brics.jwig.WebContext

addCookie, addResponseInvalidator, augment, cache, getCacheAugmentedString, getCookies, getRequestURL, getResponse, getServletContext, getServletRequest, getServletResponse, getUser, getWebAppParam, getWebAppParam, getWebAppURL, getWebSite, getWebSiteURL, getWebSiteURL, handlers, handleUpdatedObjects, isSecure, jwigJS, main, makeURL, makeURL, makeURL, makeURL, makeURL, makeURL, makeURL, next, punish, sendEmail, sendEmails, sendEmailsAsynchronously, sendResponse, touchSessions, transportSessionHandlers, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XMLProducer

public XMLProducer(Object... dependencies)

Constructs a new XML producer. When notified by one of the given objects, the run method is invoked for recomputing the XML data, and the active clients are informed. The run method is assumed to be 'safe' (in the HTTP sense).

See Also:

WebContext.update(Object), EventHandler.getProducer()

Method Detail

destroy

public void destroy()

Invoked when the current response is invalidated.

Overrides:

destroy in class AbstractHandler

invokeRun

XML invokeRun()

Invokes the run and returns the XML result.

process

Object process(String referer)

Invokes the run method of the handler, caches the result, and sends it to the client.

Overrides:

process in class AbstractHandler

toXML

public XML toXML()

Returns an XML value obtained by invoking run, together with a JavaScript instruction for automatic updating.

Specified by:

toXML in interface ToXMLable

update

public void update()

Invoked when a new result has been computed. Invalidates the cached value and informs the active clients.