org.directwebremoting.extend
Interface Remoter

All Known Implementing Classes:

DefaultRemoter, ParallelDefaultRemoter

public interface Remoter

The heart of DWR is a system to generate content from some requests. This interface generates scripts and executes remote calls.

Author:

Joe Walker [joe at getahead dot ltd dot uk]

Method Summary

Replies	execute(Calls calls) Execute a set of remote calls and generate set of reply data for later conversion to whatever wire protocol we are using today.
java.lang.String	generateDtoInheritanceJavaScript(java.lang.String indent, java.lang.String classExpression, java.lang.String superClassExpression, java.lang.String delegateFunction) Generate JavaScript that sets up a DTO class's inheritance from its superclass
java.lang.String	generateDtoJavaScript(java.lang.String jsClassName, java.lang.String indent, java.lang.String assignVariable) Generate JavaScript that forms a mapped DTO class
java.lang.String	generateInterfaceJavaScript(java.lang.String scriptName, java.lang.String indent, java.lang.String assignVariable, java.lang.String contextServletPath) Generate some Javascript that forms an interface definition
java.lang.String	getPathToDwrServlet(java.lang.String contextServletPath) The path to the DWR servlet is probably just equal to request.contextPath plus request.servletPath.

Method Detail

generateInterfaceJavaScript

java.lang.String generateInterfaceJavaScript(java.lang.String scriptName,
                                             java.lang.String indent,
                                             java.lang.String assignVariable,
                                             java.lang.String contextServletPath)
                                             throws java.lang.SecurityException

Generate some Javascript that forms an interface definition

Parameters:

scriptName - The script to generate for

indent - Indent string prepended to all generated text lines

assignVariable - JavaScript identifier to generate an assignment of the interface to

contextServletPath - request.contextPath + request.servletPath.

Returns:

An interface javascript

Throws:

java.lang.SecurityException

generateDtoJavaScript

java.lang.String generateDtoJavaScript(java.lang.String jsClassName,
                                       java.lang.String indent,
                                       java.lang.String assignVariable)
                                       throws java.lang.SecurityException

Generate JavaScript that forms a mapped DTO class

Parameters:

jsClassName - The mapped JavaScript class name

indent - Indent string prepended to all generated text lines

assignVariable - JavaScript identifier to generate an assignment of the class to

Returns:

JavaScript class definition

Throws:

java.lang.SecurityException

generateDtoInheritanceJavaScript

java.lang.String generateDtoInheritanceJavaScript(java.lang.String indent,
                                                  java.lang.String classExpression,
                                                  java.lang.String superClassExpression,
                                                  java.lang.String delegateFunction)

Generate JavaScript that sets up a DTO class's inheritance from its superclass

Parameters:

indent - Indent string prepended to all generated text lines

classExpression - The mapped JavaScript class name

superClassExpression - The mapped JavaScript superclass name

delegateFunction - Name of a callable JavaScript function that will create a prototype delegate (f ex dojo.delegate, in other frameworks sometimes called clone, beget, etc)

Returns:

JavaScript inheritance statement

Throws:

java.lang.SecurityException

execute

Replies execute(Calls calls)

Execute a set of remote calls and generate set of reply data for later conversion to whatever wire protocol we are using today.

Parameters:

calls - The set of calls to execute

Returns:

A set of reply data objects

getPathToDwrServlet

java.lang.String getPathToDwrServlet(java.lang.String contextServletPath)

The path to the DWR servlet is probably just equal to request.contextPath plus request.servletPath. However there are 2 ways to override this. One is to provide an overridePath setting, and the other is to specify useAbsolutePath=true, when the full URL up to the DWR servlet is used. This method simply echos back the contextServletPath unless one of those 2 settings are used in which case the modified value is returned.

Parameters:

contextServletPath - request.contextPath + request.servletPath.

Returns:

The path to the DWR servlet