org.directwebremoting.extend.ScriptConduit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dwr Show documentation

DWR is easy Ajax for Java. It makes it simple to call Java code directly from Javascript. It gets rid of almost all the boilerplate code between the web browser and your Java code. This version 4.0.2 works with Jakarta Servlet 4.0.2.

The newest version!

package org.directwebremoting.extend;

import java.io.IOException;

/**
 * This interface hides the decoration taking place on different poll types.
 * @author Joe Walker [joe at getahead dot ltd dot uk]
 * @author Mike Wilson
 */
public interface ScriptConduit
{
    /**
     * What mime type should we send to the browser for this data?
     * @return A mime-type
     */
    String getOutboundMimeType();

    /**
     * Called when we are initially setting up the stream.
     * This method is always called exactly once in the lifetime of a
     * conduit.
     * @throws IOException ...
     */
    void beginStreamAndChunk() throws IOException;

    /**
     * Called before a each set of scripts that are to be sent.
     * @throws IOException ...
     */
    void beginChunk() throws IOException;

    /**
     * Write a script to remote side.
     * @param script The script to write
     * @throws IOException ...
     */
    void sendScript(String script) throws IOException;

    /**
     * Called after each set of scripts when they have been sent.
     * @throws IOException ...
     */
    void endChunk() throws IOException;

    /**
     * Called when we are shutting the stream down.
     * @throws IOException ...
     */
    void endStreamAndChunk() throws IOException;
}