org.directwebremoting.annotations.RemoteProxy 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.

There is a newer version: 5.0.0

Show newest version

package org.directwebremoting.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.directwebremoting.create.NewCreator;
import org.directwebremoting.extend.Creator;

/**
 * Make a class available for remote access.
 * @author Maik Schreiber [blizzy AT blizzy DOT de]
 * @author Joe Walker [joe at getahead dot ltd dot uk]
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface RemoteProxy
{
    /**
     * Name of the JavaScript variable (default: the simple class name without package).
     * @return ...
     */
    String name() default "";

    /**
     * Creator that creates instances of the class (default: "{@code new}" creator).
     * @return ...
     */
    Class creator() default NewCreator.class;

    /**
     * Parameters for the creator.
     * @return ...
     */
    Param[] creatorParams() default {};

    /**
     * Scope of the JavaScript variable (default: PAGE).
     * @return ...
     */
    ScriptScope scope() default ScriptScope.PAGE;
}