org.apache.juneau.http.remote

Annotation Type RemoteMethod

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

Annotation applied to Java methods on REST proxy.

• Overview > juneau-rest-client > REST Proxies

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	method Defines the HTTP method to use for REST calls.
String	path REST service path.
RemoteReturn	returns The value the remote method returns.

Element Detail

path

public abstract String path

REST service path.

The possible values are:

• An absolute URL.
• A relative URL interpreted as relative to the root URL defined on the RestClient and/or Remote.path().
• No path.

If you do not specify a path, then the path is inferred from the Java method name.

Example:

// POST /pet @RestMethod public void postPet(...) {...}

Default:

""

method

public abstract String method

Defines the HTTP method to use for REST calls.

If not specified, then the method is inferred from the Java method name.

Example:

// POST /pet @RestMethod public void postPet(...) {...}

If the method cannot be inferred, then the default is "GET".

Default:

""

returns

public abstract RemoteReturn returns

The value the remote method returns.

Possible values:

• RemoteReturn.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.
  • Any POJO annotated with the @Response annotation. This allows for response beans to be used which also allows for OpenAPI-based parsing and validation.
  • 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.
• RemoteReturn.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.http.remote.RemoteReturn.BODY