org.apache.juneau.remoteable

Annotation Type Body

@Documented
 @Target(value={PARAMETER,FIELD,METHOD})
 @Retention(value=RUNTIME)
 @Inherited
public @interface Body

Annotation applied to Java method arguments of interface proxies to denote that they are the HTTP body of the request.

Example:

@Remoteable(path="/myproxy") public interface MyProxy { @RemoteMethod(path="/mymethod") String myProxyMethod(@Body MyPojo pojo); }

The argument can be any of the following types:

• Any serializable POJO - Converted to text using the Serializer registered with the RestClient.
• Reader - Raw contents of Reader will be serialized to remote resource.
• InputStream - Raw contents of InputStream will be serialized to remote resource.
• HttpEntity - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
• NameValuePairs - Converted to a URL-encoded FORM post.

The annotation can also be applied to a bean property field or getter when the argument is annotated with @RequestBean:

Example:

@Remoteable(path="/myproxy") public interface MyProxy { @RemoteMethod(path="/mymethod") String myProxyMethod(@RequestBean MyRequestBean bean); } public interface MyRequestBean { @Body MyPojo getMyPojo(); }

See Also:

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