org.apache.juneau.remoteable.RequestBean 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.lang.annotation.*;

import org.apache.juneau.serializer.*;
import org.apache.juneau.urlencoding.*;

/**
 * Annotation applied to Java method arguments of interface proxies to denote a bean with remoteable annotations.
 *
 * Example:
 * 
 * 	@Remoteable(path="/myproxy")
 * 	public interface MyProxy {
 *
 * 		@RemoteMethod(path="/mymethod/{p1}/{p2}")
 * 		String myProxyMethod(@RequestBean MyRequestBean bean);
 * 	}
 *
 * 	public interface MyRequestBean {
 *
 * 		@Path
 * 		String getP1();
 *
 * 		@Path("p2")
 * 		String getX();
 *
 * 		@Query
 * 		String getQ1();
 *
 * 		@Query
 * 		@BeanProperty(name="q2")
 * 		String getQuery2();
 *
 * 		@QueryIfNE("q3")
 * 		String getQuery3();
 *
 * 		@QueryIfNE
 * 		Map<String,Object> getExtraQueries();
 *
 * 		@FormData
 * 		String getF1();
 *
 * 		@FormData
 * 		@BeanProperty(name="f2")
 * 		String getFormData2();
 *
 * 		@FormDataIfNE("f3")
 * 		String getFormData3();
 *
 * 		@FormDataIfNE
 * 		Map<String,Object> getExtraFormData();
 *
 * 		@Header
 * 		String getH1();
 *
 * 		@Header
 * 		@BeanProperty(name="H2")
 * 		String getHeader2();
 *
 * 		@HeaderIfNE("H3")
 * 		String getHeader3();
 *
 * 		@HeaderIfNE
 * 		Map<String,Object> getExtraHeaders();
 * 	}
 * 
 *
 * Additional Information
 * 
 * 	
 * 		Interface proxies against 3rd-party REST interfaces
 * 	

 * 		org.apache.juneau.remoteable
 * 
 */
@Documented
@Target(PARAMETER)
@Retention(RUNTIME)
@Inherited
public @interface RequestBean {

	/**
	 * Specifies the {@link PartSerializer} class used for serializing values to strings.
	 *
	 * 
	 * The default value defaults to the using the part serializer defined on the client which by default is
	 * {@link UrlEncodingSerializer}.
	 *
	 * 
	 * This annotation is provided to allow values to be custom serialized.
	 */
	Class serializer() default PartSerializer.class;
}