org.apache.juneau.remoteable

Annotation Type RemoteMethod

@Documented
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Inherited
public @interface RemoteMethod

Annotation applied to Java methods on interface proxy classes.

The return type on the Java method can be any of the following:

• void - Don't parse any response. Note that the method will still throw an exception if an error HTTP status is returned.
• Any parsable POJO - The body of the response will be converted to the POJO using the parser defined on the RestClient.
• HttpResponse - Returns the raw HttpResponse returned by the inner HttpClient.
• Reader - Returns access to the raw reader of the response.
• InputStream - Returns access to the raw input stream of the response.

See Also:

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	httpMethod Defines the HTTP method to use for REST calls.
String	path The path to the REST service for this Java method relative to the parent proxy interface URL.
ReturnValue	returns The value the remoteable method returns.

Element Detail

path

public abstract String path

The path to the REST service for this Java method relative to the parent proxy interface URL.

The default value is the Java method name (e.g. "http://localhost/root-url/org.foo.MyInterface/myMethod") if @Remoteable.methodPaths() is "NAME", or the Java method signature (e.g. "http://localhost/root-url/org.foo.MyInterface/myMethod(int,boolean,java.lang.String)") if it's "SIGNATURE".

Default:

""

httpMethod

public abstract String httpMethod

Defines the HTTP method to use for REST calls.

Possible values:

• POST (default) - Parameters are serialized using the serializer registered with the RestClient.
• GET - Parameters are serialized using the UrlEncodingSerializer registered with the RestClient.

The default value is "POST".

Default:

"POST"

returns

public abstract ReturnValue returns

The value the remoteable method returns.

Possible values:

• ReturnValue.BODY (default) - The body of the HTTP response converted to a POJO.
  The return type on the Java method can be any of the following:
  • void - Don't parse any response. Note that the method will still throw an exception if an error HTTP status is returned.
  • Any parsable POJO - The body of the response will be converted to the POJO using the parser defined on the RestClient.
  • HttpResponse - Returns the raw HttpResponse returned by the inner HttpClient.
  • Reader - Returns access to the raw reader of the response.
  • InputStream - Returns access to the raw input stream of the response.
• ReturnValue.HTTP_STATUS - The HTTP status code on the response.
  The return type on the Java method can be any of the following:
  • int/Integer - The HTTP response code.
  • boolean/Boolean - true if the response code is <400

Default:

org.apache.juneau.remoteable.ReturnValue.BODY