org.apache.juneau.remoteable.Body Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of juneau-all
Apache Juneau UberJar
There is a newer version: 9.0.1
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
// * with the License.  You may obtain a copy of the License at                                                              *
// *                                                                                                                         *
// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
// *                                                                                                                         *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
// * specific language governing permissions and limitations under the License.                                              *
// ***************************************************************************************************************************
package org.apache.juneau.remoteable;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;

import java.io.*;
import java.lang.annotation.*;

import org.apache.juneau.serializer.*;

/**
 * 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 {@link Serializer} registered with the
 * 		RestClient.
 * 	

 * 		{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.
 * 	

 * 		{@link InputStream} - Raw contents of {@code 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
 * {@link RequestBean @RequestBean}:
 *
 * 
Example:
 * 
 * 	@Remoteable(path="/myproxy")
 * 	public interface MyProxy {
 *
 * 		@RemoteMethod(path="/mymethod")
 * 		String myProxyMethod(@RequestBean MyRequestBean bean);
 * 	}
 *
 * 	public interface MyRequestBean {
 * 		@Body
 * 		MyPojo getMyPojo();
 * 	}
 * 
 *
 * Additional Information
 * 
 * 	
 * 		Interface proxies against 3rd-party REST interfaces
 * 	

 * 		org.apache.juneau.remoteable
 * 
 */
@Documented
@Target({PARAMETER,FIELD,METHOD})
@Retention(RUNTIME)
@Inherited
public @interface Body {}