org.directwebremoting.extend
Interface ScriptConduit

All Known Implementing Classes:

BaseScriptConduit, HtmlScriptConduit, PlainScriptConduit

public interface ScriptConduit

This interface hides the decoration taking place on different poll types.

Author:

Joe Walker [joe at getahead dot ltd dot uk], Mike Wilson

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.

Method Detail

getOutboundMimeType

java.lang.String getOutboundMimeType()

What mime type should we send to the browser for this data?

Returns:

A mime-type

beginStreamAndChunk

void beginStreamAndChunk()
                         throws java.io.IOException

Called when we are initially setting up the stream.

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

Throws:

java.io.IOException

beginChunk

void beginChunk()
                throws java.io.IOException

Called before a each set of scripts that are to be sent.

Throws:

java.io.IOException

sendScript

void sendScript(java.lang.String script)
                throws java.io.IOException

Write a script to remote side.

Parameters:

script - The script to write

Throws:

java.io.IOException

endChunk

void endChunk()
              throws java.io.IOException

Called after each set of scripts when they have been sent.

Throws:

java.io.IOException

endStreamAndChunk

void endStreamAndChunk()
                       throws java.io.IOException

Called when we are shutting the stream down.

Throws:

java.io.IOException