org.directwebremoting.dwrp
Class BaseScriptConduit

java.lang.Object
  org.directwebremoting.extend.ScriptConduit
      org.directwebremoting.dwrp.BaseScriptConduit

All Implemented Interfaces:

java.lang.Comparable<ScriptConduit>, Alarm

Direct Known Subclasses:

Html4kScriptConduit, HtmlScriptConduit, PlainScriptConduit

public abstract class BaseScriptConduit
extends ScriptConduit
implements Alarm

A ScriptConduit that works with the parent Marshaller. In some ways this is nasty because it has access to essentially private parts of BasePollHandler, however there is nowhere sensible to store them within that class, so this is a hacky simplification.

Author:

Joe Walker [joe at getahead dot ltd dot uk]

Field Summary

Fields inherited from class org.directwebremoting.extend.ScriptConduit

RANK_FAST, RANK_PROCEDURAL, RANK_SLOW

Constructor Summary

BaseScriptConduit(Sleeper sleeper, javax.servlet.http.HttpServletResponse response, java.lang.String batchId, ConverterManager converterManager, boolean jsonOutput)
Simple ctor

Method Summary

void	cancel() Prevent further calls to Sleeper.wakeUp().
void	close(int timetoNextPoll) A poll has finished, get the client to call us back
void	setAccessLogLevel(java.lang.String accessLogLevel) When and what should we log? Options are (specified in the DWR servlet's init-params): 1) call (start of call + successful return values).
void	setDebug(boolean debug) Set the debug status
void	setDebugScriptOutput(boolean debugScriptOutput) Do we debug all the scripts that we output?

Methods inherited from class org.directwebremoting.extend.ScriptConduit

addScript, compareTo, equals, getRank, hashCode, isHoldingConnectionToBrowser, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseScriptConduit

public BaseScriptConduit(Sleeper sleeper,
                         javax.servlet.http.HttpServletResponse response,
                         java.lang.String batchId,
                         ConverterManager converterManager,
                         boolean jsonOutput)
                  throws java.io.IOException

Simple ctor

Parameters:

response - Used to flush output

batchId - The id of the batch that we are responding to

converterManager - How we convert objects to script

Throws:

java.io.IOException - If stream actions fail

Method Detail

close

public void close(int timetoNextPoll)
           throws java.io.IOException

A poll has finished, get the client to call us back

Parameters:

timetoNextPoll - How long before we tell the browser to come back?

Throws:

java.io.IOException - When we fail to call endStream()

cancel

public void cancel()

Description copied from interface: Alarm

Prevent further calls to Sleeper.wakeUp(). See the note about late calls above.

Specified by:

cancel in interface Alarm

setDebug

public void setDebug(boolean debug)

Set the debug status

Parameters:

debug - The new debug setting

setAccessLogLevel

public void setAccessLogLevel(java.lang.String accessLogLevel)

When and what should we log? Options are (specified in the DWR servlet's init-params): 1) call (start of call + successful return values). 2) exception (checked) - default for debug. 3) runtimeexception (unchecked). 4) error - default for production. 5) off.

setDebugScriptOutput

public void setDebugScriptOutput(boolean debugScriptOutput)

Do we debug all the scripts that we output?

Parameters:

debugScriptOutput - true to debug all of the output scripts (verbose)