org.directwebremoting.dwrp
Class PlainScriptConduit

java.lang.Object
  extended by org.directwebremoting.dwrp.BaseScriptConduit
      extended by org.directwebremoting.dwrp.PlainScriptConduit
All Implemented Interfaces:
ScriptConduit

public class PlainScriptConduit
extends BaseScriptConduit

A ScriptConduit for use with plain Javascript output.

Scripts are plain Javascript without 'execute-in-parent-context' wrapping, but with script-start and script-end markers.

If this conduit is used the client should direct the output to an iframe and then poll, looking for new data into the iframe. The html tags should be removed and script between script-start and script-end tags eval()ed.

This conduit is useful for Firefox. It will not work as it stands with IE 6/7 because they don't allow the browser to see data entering an iframe until it overflows a 4k buffer.

Author:
Joe Walker [joe at getahead dot ltd dot uk]

Constructor Summary
PlainScriptConduit(java.io.PrintWriter out, java.lang.String instanceId, java.lang.String scriptTagProtection)
          Simple ctor
 
Method Summary
 void beginChunk()
          Called before a each set of scripts that are to be sent.
 void beginStreamAndChunk()
          Called when we are initially setting up the stream.
 void endChunk()
          Called after each set of scripts when they have been sent.
 void endStreamAndChunk()
          Called when we are shutting the stream down.
 java.lang.String getOutboundMimeType()
          What mime type should we send to the browser for this data?
 void sendScript(java.lang.String script)
          Write a script to remote side.
 
Methods inherited from class org.directwebremoting.dwrp.BaseScriptConduit
setAccessLogLevel, setDebugScriptOutput
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PlainScriptConduit

public PlainScriptConduit(java.io.PrintWriter out,
                          java.lang.String instanceId,
                          java.lang.String scriptTagProtection)
Simple ctor

Method Detail

getOutboundMimeType

public java.lang.String getOutboundMimeType()
Description copied from interface: ScriptConduit
What mime type should we send to the browser for this data?

Returns:
A mime-type

beginStreamAndChunk

public void beginStreamAndChunk()
Description copied from interface: ScriptConduit
Called when we are initially setting up the stream.

This method is always called exactly once in the lifetime of a conduit.


beginChunk

public void beginChunk()
Description copied from interface: ScriptConduit
Called before a each set of scripts that are to be sent.


sendScript

public void sendScript(java.lang.String script)
Description copied from interface: ScriptConduit
Write a script to remote side.

Parameters:
script - The script to write

endChunk

public void endChunk()
Description copied from interface: ScriptConduit
Called after each set of scripts when they have been sent.


endStreamAndChunk

public void endStreamAndChunk()
                       throws java.io.IOException
Description copied from interface: ScriptConduit
Called when we are shutting the stream down.

Throws:
java.io.IOException

Copyright ยจ 2008