org.apache.juneau.remoteable

Annotation Type Remoteable

@Documented
 @Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
 @Inherited
public @interface Remoteable

Identifies a remote proxy interface against a REST interface.

See Also:

• Overview > juneau-rest-server > Remoteable Proxies
• Overview > juneau-rest-client > Interface Proxies Against 3rd-party REST Interfaces

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	expose Identifies which methods on the interface should be exposed through the proxy.
String	methodPaths Defines the methodology to use for the path names of the methods when not explicitly defined via @RemoteMethod.path().
String	path The absolute or relative path of the REST service.

Element Detail

path

public abstract String path

The absolute or relative path of the REST service.

When a relative path is specified, it's relative to the root-url defined on the RestClient used to instantiate the interface.

When no path is specified, the path is assumed to be the class name (e.g. "http://localhost/root-url/org.foo.MyInterface")

Default:

""

expose

public abstract String expose

Identifies which methods on the interface should be exposed through the proxy.

The options are:

• "DECLARED" (default) - Only methods declared on the immediate interface/class are exposed. Methods on parent interfaces/classes are ignored.
• "ANNOTATED" - Only methods annotated with RemoteMethod are exposed.
• "ALL" - All methods defined on the interface or class are exposed.

Default:

"DECLARED"

methodPaths

public abstract String methodPaths

Defines the methodology to use for the path names of the methods when not explicitly defined via @RemoteMethod.path().

The options are:

• "NAME" (default) - Use the method name (e.g. "myMethod").
• "SIGNATURE" - Use the method signature (e.g. "myMethod(int,boolean,java.lang.String,int[][][])").

Note that if you use "NAME", method names must be unique in the interface.

Default:

"NAME"