http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2f6fc8b5/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormData.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormData.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormData.html index 2edda6c..ec0a060 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormData.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormData.html @@ -26,82 +26,92 @@ <span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> <span class="sourceLineNo">020</span>import org.apache.juneau.annotation.*;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.urlencoding.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span><a name="line.22"></a> -<span class="sourceLineNo">023</span>/**<a name="line.23"></a> -<span class="sourceLineNo">024</span> * Annotation applied to Java method arguments of interface proxies to denote that they are FORM post parameters on the request.<a name="line.24"></a> -<span class="sourceLineNo">025</span> * <p><a name="line.25"></a> -<span class="sourceLineNo">026</span> * <h5 class='section'>Example:</h5><a name="line.26"></a> -<span class="sourceLineNo">027</span> * <p class='bcode'><a name="line.27"></a> -<span class="sourceLineNo">028</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.28"></a> -<span class="sourceLineNo">029</span> * <jk>public interface</jk> MyProxy {<a name="line.29"></a> -<span class="sourceLineNo">030</span> *<a name="line.30"></a> -<span class="sourceLineNo">031</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod1"</js>)<a name="line.31"></a> -<span class="sourceLineNo">032</span> * String myProxyMethod1(<ja>@FormData</ja>(<js>"foo"</js>)</ja> String foo, <ja>@FormData</ja>(<js>"bar"</js>)</ja> MyPojo pojo);<a name="line.32"></a> -<span class="sourceLineNo">033</span> *<a name="line.33"></a> -<span class="sourceLineNo">034</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod2"</js>)<a name="line.34"></a> -<span class="sourceLineNo">035</span> * String myProxyMethod2(<ja>@FormData</ja> NameValuePairs form);<a name="line.35"></a> -<span class="sourceLineNo">036</span> *<a name="line.36"></a> -<span class="sourceLineNo">037</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod3"</js>)<a name="line.37"></a> -<span class="sourceLineNo">038</span> * String myProxyMethod2(<ja>@FormData</ja> Map&lt;String,Object&gt; form);<a name="line.38"></a> -<span class="sourceLineNo">039</span> * }<a name="line.39"></a> -<span class="sourceLineNo">040</span> * </p><a name="line.40"></a> -<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> -<span class="sourceLineNo">042</span> * The argument can be any of the following types:<a name="line.42"></a> -<span class="sourceLineNo">043</span> * <ul class='spaced-list'><a name="line.43"></a> -<span class="sourceLineNo">044</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * <li><code>NameValuePairs</code> - Individual name-value pairs.<a name="line.45"></a> -<span class="sourceLineNo">046</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.47"></a> -<span class="sourceLineNo">048</span> * <li>A bean - Individual name-value pairs.<a name="line.48"></a> -<span class="sourceLineNo">049</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.49"></a> -<span class="sourceLineNo">050</span> * </ul><a name="line.50"></a> -<span class="sourceLineNo">051</span> * <p><a name="line.51"></a> -<span class="sourceLineNo">052</span> * The annotation can also be applied to a bean property field or getter when the argument is annotated with<a name="line.52"></a> -<span class="sourceLineNo">053</span> * {@link RequestBean @RequestBean}:<a name="line.53"></a> -<span class="sourceLineNo">054</span> * <p><a name="line.54"></a> -<span class="sourceLineNo">055</span> * <h5 class='section'>Example:</h5><a name="line.55"></a> -<span class="sourceLineNo">056</span> * <p class='bcode'><a name="line.56"></a> -<span class="sourceLineNo">057</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.57"></a> -<span class="sourceLineNo">058</span> * <jk>public interface</jk> MyProxy {<a name="line.58"></a> -<span class="sourceLineNo">059</span> *<a name="line.59"></a> -<span class="sourceLineNo">060</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)<a name="line.60"></a> -<span class="sourceLineNo">061</span> * String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);<a name="line.61"></a> -<span class="sourceLineNo">062</span> * }<a name="line.62"></a> -<span class="sourceLineNo">063</span> *<a name="line.63"></a> -<span class="sourceLineNo">064</span> * <jk>public interface</jk> MyRequestBean {<a name="line.64"></a> -<span class="sourceLineNo">065</span> * <ja>@FormData</ja><a name="line.65"></a> -<span class="sourceLineNo">066</span> * String getFoo();<a name="line.66"></a> -<span class="sourceLineNo">067</span> *<a name="line.67"></a> -<span class="sourceLineNo">068</span> * <ja>@FormData</ja><a name="line.68"></a> -<span class="sourceLineNo">069</span> * MyPojo getBar();<a name="line.69"></a> -<span class="sourceLineNo">070</span> * }<a name="line.70"></a> -<span class="sourceLineNo">071</span> * </p><a name="line.71"></a> -<span class="sourceLineNo">072</span> * <p><a name="line.72"></a> -<span class="sourceLineNo">073</span> * When used in a request bean, the {@link #value()} can be used to override the form data parameter name.<a name="line.73"></a> -<span class="sourceLineNo">074</span> * It can also be overridden via the {@link BeanProperty#name @BeanProperty.name()} annotation.<a name="line.74"></a> -<span class="sourceLineNo">075</span> * A name of <js>"*"</js> where the bean property value is a map or bean will cause the individual entries in the<a name="line.75"></a> -<span class="sourceLineNo">076</span> * map or bean to be expanded to form data parameters.<a name="line.76"></a> -<span class="sourceLineNo">077</span> */<a name="line.77"></a> -<span class="sourceLineNo">078</span>@Documented<a name="line.78"></a> -<span class="sourceLineNo">079</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.79"></a> -<span class="sourceLineNo">080</span>@Retention(RUNTIME)<a name="line.80"></a> -<span class="sourceLineNo">081</span>@Inherited<a name="line.81"></a> -<span class="sourceLineNo">082</span>public @interface FormData {<a name="line.82"></a> -<span class="sourceLineNo">083</span><a name="line.83"></a> -<span class="sourceLineNo">084</span> /**<a name="line.84"></a> -<span class="sourceLineNo">085</span> * The form post parameter name.<a name="line.85"></a> -<span class="sourceLineNo">086</span> * <p><a name="line.86"></a> -<span class="sourceLineNo">087</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.87"></a> -<span class="sourceLineNo">088</span> * for the following data types:<a name="line.88"></a> -<span class="sourceLineNo">089</span> * <ul><a name="line.89"></a> -<span class="sourceLineNo">090</span> * <li><code>NameValuePairs</code><a name="line.90"></a> -<span class="sourceLineNo">091</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.91"></a> -<span class="sourceLineNo">092</span> * <li>A bean<a name="line.92"></a> -<span class="sourceLineNo">093</span> * </ul><a name="line.93"></a> -<span class="sourceLineNo">094</span> */<a name="line.94"></a> -<span class="sourceLineNo">095</span> String value() default "*";<a name="line.95"></a> -<span class="sourceLineNo">096</span>}<a name="line.96"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.serializer.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.urlencoding.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span><a name="line.23"></a> +<span class="sourceLineNo">024</span>/**<a name="line.24"></a> +<span class="sourceLineNo">025</span> * Annotation applied to Java method arguments of interface proxies to denote that they are FORM post parameters on the request.<a name="line.25"></a> +<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> +<span class="sourceLineNo">027</span> * <h5 class='section'>Example:</h5><a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p class='bcode'><a name="line.28"></a> +<span class="sourceLineNo">029</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <jk>public interface</jk> MyProxy {<a name="line.30"></a> +<span class="sourceLineNo">031</span> *<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod1"</js>)<a name="line.32"></a> +<span class="sourceLineNo">033</span> * String myProxyMethod1(<ja>@FormData</ja>(<js>"foo"</js>)</ja> String foo, <ja>@FormData</ja>(<js>"bar"</js>)</ja> MyPojo pojo);<a name="line.33"></a> +<span class="sourceLineNo">034</span> *<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod2"</js>)<a name="line.35"></a> +<span class="sourceLineNo">036</span> * String myProxyMethod2(<ja>@FormData</ja> NameValuePairs form);<a name="line.36"></a> +<span class="sourceLineNo">037</span> *<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod3"</js>)<a name="line.38"></a> +<span class="sourceLineNo">039</span> * String myProxyMethod2(<ja>@FormData</ja> Map&lt;String,Object&gt; form);<a name="line.39"></a> +<span class="sourceLineNo">040</span> * }<a name="line.40"></a> +<span class="sourceLineNo">041</span> * </p><a name="line.41"></a> +<span class="sourceLineNo">042</span> * <p><a name="line.42"></a> +<span class="sourceLineNo">043</span> * The argument can be any of the following types:<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <ul class='spaced-list'><a name="line.44"></a> +<span class="sourceLineNo">045</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serialize(PartType,Object)}.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <li><code>NameValuePairs</code> - Individual name-value pairs.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * Values are converted to text using {@link UrlEncodingSerializer#serialize(PartType,Object)}.<a name="line.48"></a> +<span class="sourceLineNo">049</span> * <li>A bean - Individual name-value pairs.<a name="line.49"></a> +<span class="sourceLineNo">050</span> * Values are converted to text using {@link UrlEncodingSerializer#serialize(PartType,Object)}.<a name="line.50"></a> +<span class="sourceLineNo">051</span> * </ul><a name="line.51"></a> +<span class="sourceLineNo">052</span> * <p><a name="line.52"></a> +<span class="sourceLineNo">053</span> * The annotation can also be applied to a bean property field or getter when the argument is annotated with<a name="line.53"></a> +<span class="sourceLineNo">054</span> * {@link RequestBean @RequestBean}:<a name="line.54"></a> +<span class="sourceLineNo">055</span> * <p><a name="line.55"></a> +<span class="sourceLineNo">056</span> * <h5 class='section'>Example:</h5><a name="line.56"></a> +<span class="sourceLineNo">057</span> * <p class='bcode'><a name="line.57"></a> +<span class="sourceLineNo">058</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.58"></a> +<span class="sourceLineNo">059</span> * <jk>public interface</jk> MyProxy {<a name="line.59"></a> +<span class="sourceLineNo">060</span> *<a name="line.60"></a> +<span class="sourceLineNo">061</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)<a name="line.61"></a> +<span class="sourceLineNo">062</span> * String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);<a name="line.62"></a> +<span class="sourceLineNo">063</span> * }<a name="line.63"></a> +<span class="sourceLineNo">064</span> *<a name="line.64"></a> +<span class="sourceLineNo">065</span> * <jk>public interface</jk> MyRequestBean {<a name="line.65"></a> +<span class="sourceLineNo">066</span> * <ja>@FormData</ja><a name="line.66"></a> +<span class="sourceLineNo">067</span> * String getFoo();<a name="line.67"></a> +<span class="sourceLineNo">068</span> *<a name="line.68"></a> +<span class="sourceLineNo">069</span> * <ja>@FormData</ja><a name="line.69"></a> +<span class="sourceLineNo">070</span> * MyPojo getBar();<a name="line.70"></a> +<span class="sourceLineNo">071</span> * }<a name="line.71"></a> +<span class="sourceLineNo">072</span> * </p><a name="line.72"></a> +<span class="sourceLineNo">073</span> * <p><a name="line.73"></a> +<span class="sourceLineNo">074</span> * When used in a request bean, the {@link #value()} can be used to override the form data parameter name.<a name="line.74"></a> +<span class="sourceLineNo">075</span> * It can also be overridden via the {@link BeanProperty#name @BeanProperty.name()} annotation.<a name="line.75"></a> +<span class="sourceLineNo">076</span> * A name of <js>"*"</js> where the bean property value is a map or bean will cause the individual entries in the<a name="line.76"></a> +<span class="sourceLineNo">077</span> * map or bean to be expanded to form data parameters.<a name="line.77"></a> +<span class="sourceLineNo">078</span> */<a name="line.78"></a> +<span class="sourceLineNo">079</span>@Documented<a name="line.79"></a> +<span class="sourceLineNo">080</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.80"></a> +<span class="sourceLineNo">081</span>@Retention(RUNTIME)<a name="line.81"></a> +<span class="sourceLineNo">082</span>@Inherited<a name="line.82"></a> +<span class="sourceLineNo">083</span>public @interface FormData {<a name="line.83"></a> +<span class="sourceLineNo">084</span><a name="line.84"></a> +<span class="sourceLineNo">085</span> /**<a name="line.85"></a> +<span class="sourceLineNo">086</span> * The form post parameter name.<a name="line.86"></a> +<span class="sourceLineNo">087</span> * <p><a name="line.87"></a> +<span class="sourceLineNo">088</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.88"></a> +<span class="sourceLineNo">089</span> * for the following data types:<a name="line.89"></a> +<span class="sourceLineNo">090</span> * <ul><a name="line.90"></a> +<span class="sourceLineNo">091</span> * <li><code>NameValuePairs</code><a name="line.91"></a> +<span class="sourceLineNo">092</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.92"></a> +<span class="sourceLineNo">093</span> * <li>A bean<a name="line.93"></a> +<span class="sourceLineNo">094</span> * </ul><a name="line.94"></a> +<span class="sourceLineNo">095</span> */<a name="line.95"></a> +<span class="sourceLineNo">096</span> String value() default "*";<a name="line.96"></a> +<span class="sourceLineNo">097</span><a name="line.97"></a> +<span class="sourceLineNo">098</span> /**<a name="line.98"></a> +<span class="sourceLineNo">099</span> * Specifies the {@link PartSerializer} class used for serializing values to strings.<a name="line.99"></a> +<span class="sourceLineNo">100</span> * <p><a name="line.100"></a> +<span class="sourceLineNo">101</span> * The default serializer converters values to UON notation.<a name="line.101"></a> +<span class="sourceLineNo">102</span> * <p><a name="line.102"></a> +<span class="sourceLineNo">103</span> * This annotation is provided to allow values to be custom serialized.<a name="line.103"></a> +<span class="sourceLineNo">104</span> */<a name="line.104"></a> +<span class="sourceLineNo">105</span> Class<? extends PartSerializer> serializer() default UrlEncodingSerializer.class;<a name="line.105"></a> +<span class="sourceLineNo">106</span>}<a name="line.106"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2f6fc8b5/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormDataIfNE.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormDataIfNE.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormDataIfNE.html index 61207eb..68d07a5 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormDataIfNE.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/FormDataIfNE.html @@ -25,28 +25,40 @@ <span class="sourceLineNo">017</span><a name="line.17"></a> <span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>/**<a name="line.20"></a> -<span class="sourceLineNo">021</span> * Identical to {@link FormData @FormData} except skips values if they're null/blank.<a name="line.21"></a> -<span class="sourceLineNo">022</span> */<a name="line.22"></a> -<span class="sourceLineNo">023</span>@Documented<a name="line.23"></a> -<span class="sourceLineNo">024</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.24"></a> -<span class="sourceLineNo">025</span>@Retention(RUNTIME)<a name="line.25"></a> -<span class="sourceLineNo">026</span>@Inherited<a name="line.26"></a> -<span class="sourceLineNo">027</span>public @interface FormDataIfNE {<a name="line.27"></a> -<span class="sourceLineNo">028</span><a name="line.28"></a> -<span class="sourceLineNo">029</span> /**<a name="line.29"></a> -<span class="sourceLineNo">030</span> * The form post parameter name.<a name="line.30"></a> -<span class="sourceLineNo">031</span> * <p><a name="line.31"></a> -<span class="sourceLineNo">032</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.32"></a> -<span class="sourceLineNo">033</span> * for the following data types:<a name="line.33"></a> -<span class="sourceLineNo">034</span> * <ul><a name="line.34"></a> -<span class="sourceLineNo">035</span> * <li><code>NameValuePairs</code><a name="line.35"></a> -<span class="sourceLineNo">036</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.36"></a> -<span class="sourceLineNo">037</span> * <li>A bean<a name="line.37"></a> -<span class="sourceLineNo">038</span> * </ul><a name="line.38"></a> -<span class="sourceLineNo">039</span> */<a name="line.39"></a> -<span class="sourceLineNo">040</span> String value() default "*";<a name="line.40"></a> -<span class="sourceLineNo">041</span>}<a name="line.41"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.serializer.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.urlencoding.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>/**<a name="line.23"></a> +<span class="sourceLineNo">024</span> * Identical to {@link FormData @FormData} except skips values if they're null/blank.<a name="line.24"></a> +<span class="sourceLineNo">025</span> */<a name="line.25"></a> +<span class="sourceLineNo">026</span>@Documented<a name="line.26"></a> +<span class="sourceLineNo">027</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.27"></a> +<span class="sourceLineNo">028</span>@Retention(RUNTIME)<a name="line.28"></a> +<span class="sourceLineNo">029</span>@Inherited<a name="line.29"></a> +<span class="sourceLineNo">030</span>public @interface FormDataIfNE {<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span> /**<a name="line.32"></a> +<span class="sourceLineNo">033</span> * The form post parameter name.<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <p><a name="line.34"></a> +<span class="sourceLineNo">035</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.35"></a> +<span class="sourceLineNo">036</span> * for the following data types:<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <ul><a name="line.37"></a> +<span class="sourceLineNo">038</span> * <li><code>NameValuePairs</code><a name="line.38"></a> +<span class="sourceLineNo">039</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.39"></a> +<span class="sourceLineNo">040</span> * <li>A bean<a name="line.40"></a> +<span class="sourceLineNo">041</span> * </ul><a name="line.41"></a> +<span class="sourceLineNo">042</span> */<a name="line.42"></a> +<span class="sourceLineNo">043</span> String value() default "*";<a name="line.43"></a> +<span class="sourceLineNo">044</span><a name="line.44"></a> +<span class="sourceLineNo">045</span> /**<a name="line.45"></a> +<span class="sourceLineNo">046</span> * Specifies the {@link PartSerializer} class used for serializing values to strings.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <p><a name="line.47"></a> +<span class="sourceLineNo">048</span> * The default serializer converters values to UON notation.<a name="line.48"></a> +<span class="sourceLineNo">049</span> * <p><a name="line.49"></a> +<span class="sourceLineNo">050</span> * This annotation is provided to allow values to be custom serialized.<a name="line.50"></a> +<span class="sourceLineNo">051</span> */<a name="line.51"></a> +<span class="sourceLineNo">052</span> Class<? extends PartSerializer> serializer() default UrlEncodingSerializer.class;<a name="line.52"></a> +<span class="sourceLineNo">053</span>}<a name="line.53"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2f6fc8b5/content/site/apidocs/src-html/org/apache/juneau/remoteable/Header.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/Header.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/Header.html index ab090b0..0791608 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/Header.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/Header.html @@ -26,79 +26,89 @@ <span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> <span class="sourceLineNo">020</span>import org.apache.juneau.annotation.*;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.urlencoding.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span><a name="line.22"></a> -<span class="sourceLineNo">023</span>/**<a name="line.23"></a> -<span class="sourceLineNo">024</span> * Annotation applied to Java method arguments of interface proxies to denote that they are serialized as an HTTP header value.<a name="line.24"></a> -<span class="sourceLineNo">025</span> * <p><a name="line.25"></a> -<span class="sourceLineNo">026</span> * <h5 class='section'>Example:</h5><a name="line.26"></a> -<span class="sourceLineNo">027</span> * <p class='bcode'><a name="line.27"></a> -<span class="sourceLineNo">028</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.28"></a> -<span class="sourceLineNo">029</span> * <jk>public interface</jk> MyProxy {<a name="line.29"></a> -<span class="sourceLineNo">030</span> *<a name="line.30"></a> -<span class="sourceLineNo">031</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod1"</js>)<a name="line.31"></a> -<span class="sourceLineNo">032</span> * String myProxyMethod1(<ja>@Header</ja>(<js>"Foo"</js>)</ja> String foo, <ja>@Header</ja>(<js>"Bar"</js>)</ja> MyPojo pojo);<a name="line.32"></a> -<span class="sourceLineNo">033</span> *<a name="line.33"></a> -<span class="sourceLineNo">034</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod2"</js>)<a name="line.34"></a> -<span class="sourceLineNo">035</span> * String myProxyMethod2(<ja>@Header</ja> Map&lt;String,Object&gt; headers);<a name="line.35"></a> -<span class="sourceLineNo">036</span> * }<a name="line.36"></a> -<span class="sourceLineNo">037</span> * </p><a name="line.37"></a> -<span class="sourceLineNo">038</span> * <p><a name="line.38"></a> -<span class="sourceLineNo">039</span> * The argument can be any of the following types:<a name="line.39"></a> -<span class="sourceLineNo">040</span> * <ul class='spaced-list'><a name="line.40"></a> -<span class="sourceLineNo">041</span> * <li><code>NameValuePairs</code> - Individual name-value pairs.<a name="line.41"></a> -<span class="sourceLineNo">042</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.42"></a> -<span class="sourceLineNo">043</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.43"></a> -<span class="sourceLineNo">044</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * <li>A bean - Individual name-value pairs.<a name="line.45"></a> -<span class="sourceLineNo">046</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * </ul><a name="line.47"></a> -<span class="sourceLineNo">048</span> * <p><a name="line.48"></a> -<span class="sourceLineNo">049</span> * The annotation can also be applied to a bean property field or getter when the argument is annotated with<a name="line.49"></a> -<span class="sourceLineNo">050</span> * {@link RequestBean @RequestBean}:<a name="line.50"></a> -<span class="sourceLineNo">051</span> * <p><a name="line.51"></a> -<span class="sourceLineNo">052</span> * <h5 class='section'>Example:</h5><a name="line.52"></a> -<span class="sourceLineNo">053</span> * <p class='bcode'><a name="line.53"></a> -<span class="sourceLineNo">054</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.54"></a> -<span class="sourceLineNo">055</span> * <jk>public interface</jk> MyProxy {<a name="line.55"></a> -<span class="sourceLineNo">056</span> *<a name="line.56"></a> -<span class="sourceLineNo">057</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)<a name="line.57"></a> -<span class="sourceLineNo">058</span> * String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);<a name="line.58"></a> -<span class="sourceLineNo">059</span> * }<a name="line.59"></a> -<span class="sourceLineNo">060</span> *<a name="line.60"></a> -<span class="sourceLineNo">061</span> * <jk>public interface</jk> MyRequestBean {<a name="line.61"></a> -<span class="sourceLineNo">062</span> * <ja>@Header</ja>(<js>"Foo"</js>)<a name="line.62"></a> -<span class="sourceLineNo">063</span> * String getFoo();<a name="line.63"></a> -<span class="sourceLineNo">064</span> *<a name="line.64"></a> -<span class="sourceLineNo">065</span> * <ja>@Header</ja>(<js>"Bar"</js>)<a name="line.65"></a> -<span class="sourceLineNo">066</span> * MyPojo getBar();<a name="line.66"></a> -<span class="sourceLineNo">067</span> * }<a name="line.67"></a> -<span class="sourceLineNo">068</span> * </p><a name="line.68"></a> -<span class="sourceLineNo">069</span> * <p><a name="line.69"></a> -<span class="sourceLineNo">070</span> * When used in a request bean, the {@link #value()} can be used to override the header name.<a name="line.70"></a> -<span class="sourceLineNo">071</span> * It can also be overridden via the {@link BeanProperty#name @BeanProperty.name()} annotation.<a name="line.71"></a> -<span class="sourceLineNo">072</span> * A name of <js>"*"</js> where the bean property value is a map or bean will cause the individual entries in the<a name="line.72"></a> -<span class="sourceLineNo">073</span> * map or bean to be expanded to headers.<a name="line.73"></a> -<span class="sourceLineNo">074</span> */<a name="line.74"></a> -<span class="sourceLineNo">075</span>@Documented<a name="line.75"></a> -<span class="sourceLineNo">076</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.76"></a> -<span class="sourceLineNo">077</span>@Retention(RUNTIME)<a name="line.77"></a> -<span class="sourceLineNo">078</span>@Inherited<a name="line.78"></a> -<span class="sourceLineNo">079</span>public @interface Header {<a name="line.79"></a> -<span class="sourceLineNo">080</span><a name="line.80"></a> -<span class="sourceLineNo">081</span> /**<a name="line.81"></a> -<span class="sourceLineNo">082</span> * The HTTP header name.<a name="line.82"></a> -<span class="sourceLineNo">083</span> * <p><a name="line.83"></a> -<span class="sourceLineNo">084</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.84"></a> -<span class="sourceLineNo">085</span> * for the following data types:<a name="line.85"></a> -<span class="sourceLineNo">086</span> * <ul><a name="line.86"></a> -<span class="sourceLineNo">087</span> * <li><code>NameValuePairs</code><a name="line.87"></a> -<span class="sourceLineNo">088</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.88"></a> -<span class="sourceLineNo">089</span> * <li>A bean<a name="line.89"></a> -<span class="sourceLineNo">090</span> * </ul><a name="line.90"></a> -<span class="sourceLineNo">091</span> */<a name="line.91"></a> -<span class="sourceLineNo">092</span> String value() default "*";<a name="line.92"></a> -<span class="sourceLineNo">093</span>}<a name="line.93"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.serializer.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.urlencoding.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span><a name="line.23"></a> +<span class="sourceLineNo">024</span>/**<a name="line.24"></a> +<span class="sourceLineNo">025</span> * Annotation applied to Java method arguments of interface proxies to denote that they are serialized as an HTTP header value.<a name="line.25"></a> +<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> +<span class="sourceLineNo">027</span> * <h5 class='section'>Example:</h5><a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p class='bcode'><a name="line.28"></a> +<span class="sourceLineNo">029</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <jk>public interface</jk> MyProxy {<a name="line.30"></a> +<span class="sourceLineNo">031</span> *<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod1"</js>)<a name="line.32"></a> +<span class="sourceLineNo">033</span> * String myProxyMethod1(<ja>@Header</ja>(<js>"Foo"</js>)</ja> String foo, <ja>@Header</ja>(<js>"Bar"</js>)</ja> MyPojo pojo);<a name="line.33"></a> +<span class="sourceLineNo">034</span> *<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod2"</js>)<a name="line.35"></a> +<span class="sourceLineNo">036</span> * String myProxyMethod2(<ja>@Header</ja> Map&lt;String,Object&gt; headers);<a name="line.36"></a> +<span class="sourceLineNo">037</span> * }<a name="line.37"></a> +<span class="sourceLineNo">038</span> * </p><a name="line.38"></a> +<span class="sourceLineNo">039</span> * <p><a name="line.39"></a> +<span class="sourceLineNo">040</span> * The argument can be any of the following types:<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <ul class='spaced-list'><a name="line.41"></a> +<span class="sourceLineNo">042</span> * <li><code>NameValuePairs</code> - Individual name-value pairs.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serialize(PartType,Object)}.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.44"></a> +<span class="sourceLineNo">045</span> * Values are converted to text using {@link UrlEncodingSerializer#serialize(PartType,Object)}.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <li>A bean - Individual name-value pairs.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * Values are converted to text using {@link UrlEncodingSerializer#serialize(PartType,Object)}.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * </ul><a name="line.48"></a> +<span class="sourceLineNo">049</span> * <p><a name="line.49"></a> +<span class="sourceLineNo">050</span> * The annotation can also be applied to a bean property field or getter when the argument is annotated with<a name="line.50"></a> +<span class="sourceLineNo">051</span> * {@link RequestBean @RequestBean}:<a name="line.51"></a> +<span class="sourceLineNo">052</span> * <p><a name="line.52"></a> +<span class="sourceLineNo">053</span> * <h5 class='section'>Example:</h5><a name="line.53"></a> +<span class="sourceLineNo">054</span> * <p class='bcode'><a name="line.54"></a> +<span class="sourceLineNo">055</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <jk>public interface</jk> MyProxy {<a name="line.56"></a> +<span class="sourceLineNo">057</span> *<a name="line.57"></a> +<span class="sourceLineNo">058</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)<a name="line.58"></a> +<span class="sourceLineNo">059</span> * String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);<a name="line.59"></a> +<span class="sourceLineNo">060</span> * }<a name="line.60"></a> +<span class="sourceLineNo">061</span> *<a name="line.61"></a> +<span class="sourceLineNo">062</span> * <jk>public interface</jk> MyRequestBean {<a name="line.62"></a> +<span class="sourceLineNo">063</span> * <ja>@Header</ja>(<js>"Foo"</js>)<a name="line.63"></a> +<span class="sourceLineNo">064</span> * String getFoo();<a name="line.64"></a> +<span class="sourceLineNo">065</span> *<a name="line.65"></a> +<span class="sourceLineNo">066</span> * <ja>@Header</ja>(<js>"Bar"</js>)<a name="line.66"></a> +<span class="sourceLineNo">067</span> * MyPojo getBar();<a name="line.67"></a> +<span class="sourceLineNo">068</span> * }<a name="line.68"></a> +<span class="sourceLineNo">069</span> * </p><a name="line.69"></a> +<span class="sourceLineNo">070</span> * <p><a name="line.70"></a> +<span class="sourceLineNo">071</span> * When used in a request bean, the {@link #value()} can be used to override the header name.<a name="line.71"></a> +<span class="sourceLineNo">072</span> * It can also be overridden via the {@link BeanProperty#name @BeanProperty.name()} annotation.<a name="line.72"></a> +<span class="sourceLineNo">073</span> * A name of <js>"*"</js> where the bean property value is a map or bean will cause the individual entries in the<a name="line.73"></a> +<span class="sourceLineNo">074</span> * map or bean to be expanded to headers.<a name="line.74"></a> +<span class="sourceLineNo">075</span> */<a name="line.75"></a> +<span class="sourceLineNo">076</span>@Documented<a name="line.76"></a> +<span class="sourceLineNo">077</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.77"></a> +<span class="sourceLineNo">078</span>@Retention(RUNTIME)<a name="line.78"></a> +<span class="sourceLineNo">079</span>@Inherited<a name="line.79"></a> +<span class="sourceLineNo">080</span>public @interface Header {<a name="line.80"></a> +<span class="sourceLineNo">081</span><a name="line.81"></a> +<span class="sourceLineNo">082</span> /**<a name="line.82"></a> +<span class="sourceLineNo">083</span> * The HTTP header name.<a name="line.83"></a> +<span class="sourceLineNo">084</span> * <p><a name="line.84"></a> +<span class="sourceLineNo">085</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.85"></a> +<span class="sourceLineNo">086</span> * for the following data types:<a name="line.86"></a> +<span class="sourceLineNo">087</span> * <ul><a name="line.87"></a> +<span class="sourceLineNo">088</span> * <li><code>NameValuePairs</code><a name="line.88"></a> +<span class="sourceLineNo">089</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.89"></a> +<span class="sourceLineNo">090</span> * <li>A bean<a name="line.90"></a> +<span class="sourceLineNo">091</span> * </ul><a name="line.91"></a> +<span class="sourceLineNo">092</span> */<a name="line.92"></a> +<span class="sourceLineNo">093</span> String value() default "*";<a name="line.93"></a> +<span class="sourceLineNo">094</span><a name="line.94"></a> +<span class="sourceLineNo">095</span> /**<a name="line.95"></a> +<span class="sourceLineNo">096</span> * Specifies the {@link PartSerializer} class used for serializing values to strings.<a name="line.96"></a> +<span class="sourceLineNo">097</span> * <p><a name="line.97"></a> +<span class="sourceLineNo">098</span> * The default serializer converters values to UON notation.<a name="line.98"></a> +<span class="sourceLineNo">099</span> * <p><a name="line.99"></a> +<span class="sourceLineNo">100</span> * This annotation is provided to allow values to be custom serialized.<a name="line.100"></a> +<span class="sourceLineNo">101</span> */<a name="line.101"></a> +<span class="sourceLineNo">102</span> Class<? extends PartSerializer> serializer() default UrlEncodingSerializer.class;<a name="line.102"></a> +<span class="sourceLineNo">103</span>}<a name="line.103"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2f6fc8b5/content/site/apidocs/src-html/org/apache/juneau/remoteable/HeaderIfNE.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/HeaderIfNE.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/HeaderIfNE.html index 4ee60d5..bc59ea5 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/HeaderIfNE.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/HeaderIfNE.html @@ -25,28 +25,40 @@ <span class="sourceLineNo">017</span><a name="line.17"></a> <span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>/**<a name="line.20"></a> -<span class="sourceLineNo">021</span> * Identical to {@link Header @Header} except skips values if they're null/blank.<a name="line.21"></a> -<span class="sourceLineNo">022</span> */<a name="line.22"></a> -<span class="sourceLineNo">023</span>@Documented<a name="line.23"></a> -<span class="sourceLineNo">024</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.24"></a> -<span class="sourceLineNo">025</span>@Retention(RUNTIME)<a name="line.25"></a> -<span class="sourceLineNo">026</span>@Inherited<a name="line.26"></a> -<span class="sourceLineNo">027</span>public @interface HeaderIfNE {<a name="line.27"></a> -<span class="sourceLineNo">028</span><a name="line.28"></a> -<span class="sourceLineNo">029</span> /**<a name="line.29"></a> -<span class="sourceLineNo">030</span> * The HTTP header name.<a name="line.30"></a> -<span class="sourceLineNo">031</span> * <p><a name="line.31"></a> -<span class="sourceLineNo">032</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.32"></a> -<span class="sourceLineNo">033</span> * for the following data types:<a name="line.33"></a> -<span class="sourceLineNo">034</span> * <ul><a name="line.34"></a> -<span class="sourceLineNo">035</span> * <li><code>NameValuePairs</code><a name="line.35"></a> -<span class="sourceLineNo">036</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.36"></a> -<span class="sourceLineNo">037</span> * <li>A bean<a name="line.37"></a> -<span class="sourceLineNo">038</span> * </ul><a name="line.38"></a> -<span class="sourceLineNo">039</span> */<a name="line.39"></a> -<span class="sourceLineNo">040</span> String value() default "*";<a name="line.40"></a> -<span class="sourceLineNo">041</span>}<a name="line.41"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.serializer.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.urlencoding.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>/**<a name="line.23"></a> +<span class="sourceLineNo">024</span> * Identical to {@link Header @Header} except skips values if they're null/blank.<a name="line.24"></a> +<span class="sourceLineNo">025</span> */<a name="line.25"></a> +<span class="sourceLineNo">026</span>@Documented<a name="line.26"></a> +<span class="sourceLineNo">027</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.27"></a> +<span class="sourceLineNo">028</span>@Retention(RUNTIME)<a name="line.28"></a> +<span class="sourceLineNo">029</span>@Inherited<a name="line.29"></a> +<span class="sourceLineNo">030</span>public @interface HeaderIfNE {<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span> /**<a name="line.32"></a> +<span class="sourceLineNo">033</span> * The HTTP header name.<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <p><a name="line.34"></a> +<span class="sourceLineNo">035</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.35"></a> +<span class="sourceLineNo">036</span> * for the following data types:<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <ul><a name="line.37"></a> +<span class="sourceLineNo">038</span> * <li><code>NameValuePairs</code><a name="line.38"></a> +<span class="sourceLineNo">039</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.39"></a> +<span class="sourceLineNo">040</span> * <li>A bean<a name="line.40"></a> +<span class="sourceLineNo">041</span> * </ul><a name="line.41"></a> +<span class="sourceLineNo">042</span> */<a name="line.42"></a> +<span class="sourceLineNo">043</span> String value() default "*";<a name="line.43"></a> +<span class="sourceLineNo">044</span><a name="line.44"></a> +<span class="sourceLineNo">045</span> /**<a name="line.45"></a> +<span class="sourceLineNo">046</span> * Specifies the {@link PartSerializer} class used for serializing values to strings.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <p><a name="line.47"></a> +<span class="sourceLineNo">048</span> * The default serializer converters values to UON notation.<a name="line.48"></a> +<span class="sourceLineNo">049</span> * <p><a name="line.49"></a> +<span class="sourceLineNo">050</span> * This annotation is provided to allow values to be custom serialized.<a name="line.50"></a> +<span class="sourceLineNo">051</span> */<a name="line.51"></a> +<span class="sourceLineNo">052</span> Class<? extends PartSerializer> serializer() default UrlEncodingSerializer.class;<a name="line.52"></a> +<span class="sourceLineNo">053</span>}<a name="line.53"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2f6fc8b5/content/site/apidocs/src-html/org/apache/juneau/remoteable/Path.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/Path.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/Path.html index 377814e..d23e75e 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/Path.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/Path.html @@ -26,73 +26,83 @@ <span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> <span class="sourceLineNo">020</span>import org.apache.juneau.annotation.*;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.urlencoding.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span><a name="line.22"></a> -<span class="sourceLineNo">023</span>/**<a name="line.23"></a> -<span class="sourceLineNo">024</span> * Annotation applied to Java method arguments of interface proxies to denote that they are path variables on the request.<a name="line.24"></a> -<span class="sourceLineNo">025</span> * <p><a name="line.25"></a> -<span class="sourceLineNo">026</span> * <h5 class='section'>Example:</h5><a name="line.26"></a> -<span class="sourceLineNo">027</span> * <p class='bcode'><a name="line.27"></a> -<span class="sourceLineNo">028</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.28"></a> -<span class="sourceLineNo">029</span> * <jk>public interface</jk> MyProxy {<a name="line.29"></a> -<span class="sourceLineNo">030</span> *<a name="line.30"></a> -<span class="sourceLineNo">031</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod1/{foo}"</js>)<a name="line.31"></a> -<span class="sourceLineNo">032</span> * String myProxyMethod1(<ja>@Path</ja>(<js>"foo"</js>)</ja> String foo);<a name="line.32"></a> -<span class="sourceLineNo">033</span> * }<a name="line.33"></a> -<span class="sourceLineNo">034</span> * </p><a name="line.34"></a> -<span class="sourceLineNo">035</span> * <p><a name="line.35"></a> -<span class="sourceLineNo">036</span> * The argument can be any of the following types:<a name="line.36"></a> -<span class="sourceLineNo">037</span> * <ul class='spaced-list'><a name="line.37"></a> -<span class="sourceLineNo">038</span> * <li><code>NameValuePairs</code> - Individual name-value pairs.<a name="line.38"></a> -<span class="sourceLineNo">039</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.39"></a> -<span class="sourceLineNo">040</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.40"></a> -<span class="sourceLineNo">041</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.41"></a> -<span class="sourceLineNo">042</span> * <li>A bean - Individual name-value pairs.<a name="line.42"></a> -<span class="sourceLineNo">043</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.43"></a> -<span class="sourceLineNo">044</span> * </ul><a name="line.44"></a> -<span class="sourceLineNo">045</span> * <p><a name="line.45"></a> -<span class="sourceLineNo">046</span> * The annotation can also be applied to a bean property field or getter when the argument is annotated with<a name="line.46"></a> -<span class="sourceLineNo">047</span> * {@link RequestBean @RequestBean}:<a name="line.47"></a> -<span class="sourceLineNo">048</span> * <p><a name="line.48"></a> -<span class="sourceLineNo">049</span> * <h5 class='section'>Example:</h5><a name="line.49"></a> -<span class="sourceLineNo">050</span> * <p class='bcode'><a name="line.50"></a> -<span class="sourceLineNo">051</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.51"></a> -<span class="sourceLineNo">052</span> * <jk>public interface</jk> MyProxy {<a name="line.52"></a> -<span class="sourceLineNo">053</span> *<a name="line.53"></a> -<span class="sourceLineNo">054</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod1/{foo}"</js>)<a name="line.54"></a> -<span class="sourceLineNo">055</span> * String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);<a name="line.55"></a> -<span class="sourceLineNo">056</span> * }<a name="line.56"></a> -<span class="sourceLineNo">057</span> *<a name="line.57"></a> -<span class="sourceLineNo">058</span> * <jk>public interface</jk> MyRequestBean {<a name="line.58"></a> -<span class="sourceLineNo">059</span> * <ja>@Path</ja><a name="line.59"></a> -<span class="sourceLineNo">060</span> * String getFoo();<a name="line.60"></a> -<span class="sourceLineNo">061</span> * }<a name="line.61"></a> -<span class="sourceLineNo">062</span> * </p><a name="line.62"></a> -<span class="sourceLineNo">063</span> * <p><a name="line.63"></a> -<span class="sourceLineNo">064</span> * When used in a request bean, the {@link #value()} can be used to override the path variable name.<a name="line.64"></a> -<span class="sourceLineNo">065</span> * It can also be overridden via the {@link BeanProperty#name @BeanProperty.name()} annotation.<a name="line.65"></a> -<span class="sourceLineNo">066</span> * A name of <js>"*"</js> where the bean property value is a map or bean will cause the individual entries in the<a name="line.66"></a> -<span class="sourceLineNo">067</span> * map or bean to be expanded to path variables.<a name="line.67"></a> -<span class="sourceLineNo">068</span> */<a name="line.68"></a> -<span class="sourceLineNo">069</span>@Documented<a name="line.69"></a> -<span class="sourceLineNo">070</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.70"></a> -<span class="sourceLineNo">071</span>@Retention(RUNTIME)<a name="line.71"></a> -<span class="sourceLineNo">072</span>@Inherited<a name="line.72"></a> -<span class="sourceLineNo">073</span>public @interface Path {<a name="line.73"></a> -<span class="sourceLineNo">074</span><a name="line.74"></a> -<span class="sourceLineNo">075</span> /**<a name="line.75"></a> -<span class="sourceLineNo">076</span> * The path parameter name.<a name="line.76"></a> -<span class="sourceLineNo">077</span> * <p><a name="line.77"></a> -<span class="sourceLineNo">078</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.78"></a> -<span class="sourceLineNo">079</span> * for the following data types:<a name="line.79"></a> -<span class="sourceLineNo">080</span> * <ul><a name="line.80"></a> -<span class="sourceLineNo">081</span> * <li><code>NameValuePairs</code><a name="line.81"></a> -<span class="sourceLineNo">082</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.82"></a> -<span class="sourceLineNo">083</span> * <li>A bean<a name="line.83"></a> -<span class="sourceLineNo">084</span> * </ul><a name="line.84"></a> -<span class="sourceLineNo">085</span> */<a name="line.85"></a> -<span class="sourceLineNo">086</span> String value() default "*";<a name="line.86"></a> -<span class="sourceLineNo">087</span>}<a name="line.87"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.serializer.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.urlencoding.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span><a name="line.23"></a> +<span class="sourceLineNo">024</span>/**<a name="line.24"></a> +<span class="sourceLineNo">025</span> * Annotation applied to Java method arguments of interface proxies to denote that they are path variables on the request.<a name="line.25"></a> +<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> +<span class="sourceLineNo">027</span> * <h5 class='section'>Example:</h5><a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p class='bcode'><a name="line.28"></a> +<span class="sourceLineNo">029</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <jk>public interface</jk> MyProxy {<a name="line.30"></a> +<span class="sourceLineNo">031</span> *<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod1/{foo}"</js>)<a name="line.32"></a> +<span class="sourceLineNo">033</span> * String myProxyMethod1(<ja>@Path</ja>(<js>"foo"</js>)</ja> String foo);<a name="line.33"></a> +<span class="sourceLineNo">034</span> * }<a name="line.34"></a> +<span class="sourceLineNo">035</span> * </p><a name="line.35"></a> +<span class="sourceLineNo">036</span> * <p><a name="line.36"></a> +<span class="sourceLineNo">037</span> * The argument can be any of the following types:<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <ul class='spaced-list'><a name="line.38"></a> +<span class="sourceLineNo">039</span> * <li><code>NameValuePairs</code> - Individual name-value pairs.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serialize(PartType,Object)}.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * Values are converted to text using {@link UrlEncodingSerializer#serialize(PartType,Object)}.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <li>A bean - Individual name-value pairs.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * Values are converted to text using {@link UrlEncodingSerializer#serialize(PartType,Object)}.<a name="line.44"></a> +<span class="sourceLineNo">045</span> * </ul><a name="line.45"></a> +<span class="sourceLineNo">046</span> * <p><a name="line.46"></a> +<span class="sourceLineNo">047</span> * The annotation can also be applied to a bean property field or getter when the argument is annotated with<a name="line.47"></a> +<span class="sourceLineNo">048</span> * {@link RequestBean @RequestBean}:<a name="line.48"></a> +<span class="sourceLineNo">049</span> * <p><a name="line.49"></a> +<span class="sourceLineNo">050</span> * <h5 class='section'>Example:</h5><a name="line.50"></a> +<span class="sourceLineNo">051</span> * <p class='bcode'><a name="line.51"></a> +<span class="sourceLineNo">052</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <jk>public interface</jk> MyProxy {<a name="line.53"></a> +<span class="sourceLineNo">054</span> *<a name="line.54"></a> +<span class="sourceLineNo">055</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod1/{foo}"</js>)<a name="line.55"></a> +<span class="sourceLineNo">056</span> * String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);<a name="line.56"></a> +<span class="sourceLineNo">057</span> * }<a name="line.57"></a> +<span class="sourceLineNo">058</span> *<a name="line.58"></a> +<span class="sourceLineNo">059</span> * <jk>public interface</jk> MyRequestBean {<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <ja>@Path</ja><a name="line.60"></a> +<span class="sourceLineNo">061</span> * String getFoo();<a name="line.61"></a> +<span class="sourceLineNo">062</span> * }<a name="line.62"></a> +<span class="sourceLineNo">063</span> * </p><a name="line.63"></a> +<span class="sourceLineNo">064</span> * <p><a name="line.64"></a> +<span class="sourceLineNo">065</span> * When used in a request bean, the {@link #value()} can be used to override the path variable name.<a name="line.65"></a> +<span class="sourceLineNo">066</span> * It can also be overridden via the {@link BeanProperty#name @BeanProperty.name()} annotation.<a name="line.66"></a> +<span class="sourceLineNo">067</span> * A name of <js>"*"</js> where the bean property value is a map or bean will cause the individual entries in the<a name="line.67"></a> +<span class="sourceLineNo">068</span> * map or bean to be expanded to path variables.<a name="line.68"></a> +<span class="sourceLineNo">069</span> */<a name="line.69"></a> +<span class="sourceLineNo">070</span>@Documented<a name="line.70"></a> +<span class="sourceLineNo">071</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.71"></a> +<span class="sourceLineNo">072</span>@Retention(RUNTIME)<a name="line.72"></a> +<span class="sourceLineNo">073</span>@Inherited<a name="line.73"></a> +<span class="sourceLineNo">074</span>public @interface Path {<a name="line.74"></a> +<span class="sourceLineNo">075</span><a name="line.75"></a> +<span class="sourceLineNo">076</span> /**<a name="line.76"></a> +<span class="sourceLineNo">077</span> * The path parameter name.<a name="line.77"></a> +<span class="sourceLineNo">078</span> * <p><a name="line.78"></a> +<span class="sourceLineNo">079</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.79"></a> +<span class="sourceLineNo">080</span> * for the following data types:<a name="line.80"></a> +<span class="sourceLineNo">081</span> * <ul><a name="line.81"></a> +<span class="sourceLineNo">082</span> * <li><code>NameValuePairs</code><a name="line.82"></a> +<span class="sourceLineNo">083</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.83"></a> +<span class="sourceLineNo">084</span> * <li>A bean<a name="line.84"></a> +<span class="sourceLineNo">085</span> * </ul><a name="line.85"></a> +<span class="sourceLineNo">086</span> */<a name="line.86"></a> +<span class="sourceLineNo">087</span> String value() default "*";<a name="line.87"></a> +<span class="sourceLineNo">088</span><a name="line.88"></a> +<span class="sourceLineNo">089</span> /**<a name="line.89"></a> +<span class="sourceLineNo">090</span> * Specifies the {@link PartSerializer} class used for serializing values to strings.<a name="line.90"></a> +<span class="sourceLineNo">091</span> * <p><a name="line.91"></a> +<span class="sourceLineNo">092</span> * The default serializer converters values to UON notation.<a name="line.92"></a> +<span class="sourceLineNo">093</span> * <p><a name="line.93"></a> +<span class="sourceLineNo">094</span> * This annotation is provided to allow values to be custom serialized.<a name="line.94"></a> +<span class="sourceLineNo">095</span> */<a name="line.95"></a> +<span class="sourceLineNo">096</span> Class<? extends PartSerializer> serializer() default UrlEncodingSerializer.class;<a name="line.96"></a> +<span class="sourceLineNo">097</span>}<a name="line.97"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2f6fc8b5/content/site/apidocs/src-html/org/apache/juneau/remoteable/Query.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/Query.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/Query.html index 516ee0e..b878a33 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/Query.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/Query.html @@ -26,84 +26,94 @@ <span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> <span class="sourceLineNo">020</span>import org.apache.juneau.annotation.*;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.urlencoding.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span><a name="line.22"></a> -<span class="sourceLineNo">023</span>/**<a name="line.23"></a> -<span class="sourceLineNo">024</span> * Annotation applied to Java method arguments of interface proxies to denote that they are QUERY parameters on the request.<a name="line.24"></a> -<span class="sourceLineNo">025</span> * <p><a name="line.25"></a> -<span class="sourceLineNo">026</span> * <h5 class='section'>Example:</h5><a name="line.26"></a> -<span class="sourceLineNo">027</span> * <p class='bcode'><a name="line.27"></a> -<span class="sourceLineNo">028</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.28"></a> -<span class="sourceLineNo">029</span> * <jk>public interface</jk> MyProxy {<a name="line.29"></a> -<span class="sourceLineNo">030</span> *<a name="line.30"></a> -<span class="sourceLineNo">031</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod1"</js>)<a name="line.31"></a> -<span class="sourceLineNo">032</span> * String myProxyMethod1(<ja>@Query</ja>(<js>"foo"</js>)</ja> String foo, <ja>@Query</ja>(<js>"bar"</js>)</ja> MyPojo pojo);<a name="line.32"></a> -<span class="sourceLineNo">033</span> *<a name="line.33"></a> -<span class="sourceLineNo">034</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod2"</js>)<a name="line.34"></a> -<span class="sourceLineNo">035</span> * String myProxyMethod2(<ja>@Query</ja> Map&lt;String,Object&gt; query);<a name="line.35"></a> -<span class="sourceLineNo">036</span> *<a name="line.36"></a> -<span class="sourceLineNo">037</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod3"</js>)<a name="line.37"></a> -<span class="sourceLineNo">038</span> * String myProxyMethod2(<ja>@Query</ja> String queryString);<a name="line.38"></a> -<span class="sourceLineNo">039</span> * }<a name="line.39"></a> -<span class="sourceLineNo">040</span> * </p><a name="line.40"></a> -<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> -<span class="sourceLineNo">042</span> * The argument can be any of the following types:<a name="line.42"></a> -<span class="sourceLineNo">043</span> * <ul class='spaced-list'><a name="line.43"></a> -<span class="sourceLineNo">044</span> * <li><code>NameValuePairs</code> - Individual name-value pairs.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.45"></a> -<span class="sourceLineNo">046</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.46"></a> -<span class="sourceLineNo">047</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.47"></a> -<span class="sourceLineNo">048</span> * <li>A bean - Individual name-value pairs.<a name="line.48"></a> -<span class="sourceLineNo">049</span> * Values are converted to text using {@link UrlEncodingSerializer#serializePart(Object, Boolean, Boolean)}.<a name="line.49"></a> -<span class="sourceLineNo">050</span> * <li>{@link String} - Treated as a query string.<a name="line.50"></a> -<span class="sourceLineNo">051</span> * </ul><a name="line.51"></a> -<span class="sourceLineNo">052</span> * <p><a name="line.52"></a> -<span class="sourceLineNo">053</span> * The annotation can also be applied to a bean property field or getter when the argument is annotated with<a name="line.53"></a> -<span class="sourceLineNo">054</span> * {@link RequestBean @RequestBean}:<a name="line.54"></a> -<span class="sourceLineNo">055</span> * <p><a name="line.55"></a> -<span class="sourceLineNo">056</span> * <h5 class='section'>Example:</h5><a name="line.56"></a> -<span class="sourceLineNo">057</span> * <p class='bcode'><a name="line.57"></a> -<span class="sourceLineNo">058</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.58"></a> -<span class="sourceLineNo">059</span> * <jk>public interface</jk> MyProxy {<a name="line.59"></a> -<span class="sourceLineNo">060</span> *<a name="line.60"></a> -<span class="sourceLineNo">061</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)<a name="line.61"></a> -<span class="sourceLineNo">062</span> * String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);<a name="line.62"></a> -<span class="sourceLineNo">063</span> * }<a name="line.63"></a> -<span class="sourceLineNo">064</span> *<a name="line.64"></a> -<span class="sourceLineNo">065</span> * <jk>public interface</jk> MyRequestBean {<a name="line.65"></a> -<span class="sourceLineNo">066</span> * <ja>@Query</ja><a name="line.66"></a> -<span class="sourceLineNo">067</span> * String getFoo();<a name="line.67"></a> -<span class="sourceLineNo">068</span> *<a name="line.68"></a> -<span class="sourceLineNo">069</span> * <ja>@Query</ja><a name="line.69"></a> -<span class="sourceLineNo">070</span> * MyPojo getBar();<a name="line.70"></a> -<span class="sourceLineNo">071</span> * }<a name="line.71"></a> -<span class="sourceLineNo">072</span> * </p><a name="line.72"></a> -<span class="sourceLineNo">073</span> * <p><a name="line.73"></a> -<span class="sourceLineNo">074</span> * When used in a request bean, the {@link #value()} can be used to override the query parameter name.<a name="line.74"></a> -<span class="sourceLineNo">075</span> * It can also be overridden via the {@link BeanProperty#name @BeanProperty.name()} annotation.<a name="line.75"></a> -<span class="sourceLineNo">076</span> * A name of <js>"*"</js> where the bean property value is a map or bean will cause the individual entries in the<a name="line.76"></a> -<span class="sourceLineNo">077</span> * map or bean to be expanded to query parameters.<a name="line.77"></a> -<span class="sourceLineNo">078</span> */<a name="line.78"></a> -<span class="sourceLineNo">079</span>@Documented<a name="line.79"></a> -<span class="sourceLineNo">080</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.80"></a> -<span class="sourceLineNo">081</span>@Retention(RUNTIME)<a name="line.81"></a> -<span class="sourceLineNo">082</span>@Inherited<a name="line.82"></a> -<span class="sourceLineNo">083</span>public @interface Query {<a name="line.83"></a> -<span class="sourceLineNo">084</span><a name="line.84"></a> -<span class="sourceLineNo">085</span> /**<a name="line.85"></a> -<span class="sourceLineNo">086</span> * The query parameter name.<a name="line.86"></a> -<span class="sourceLineNo">087</span> * <p><a name="line.87"></a> -<span class="sourceLineNo">088</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.88"></a> -<span class="sourceLineNo">089</span> * for the following data types:<a name="line.89"></a> -<span class="sourceLineNo">090</span> * <ul><a name="line.90"></a> -<span class="sourceLineNo">091</span> * <li><code>String</code> - A complete query string.<a name="line.91"></a> -<span class="sourceLineNo">092</span> * <li><code>NameValuePairs</code><a name="line.92"></a> -<span class="sourceLineNo">093</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.93"></a> -<span class="sourceLineNo">094</span> * <li>A bean<a name="line.94"></a> -<span class="sourceLineNo">095</span> * </ul><a name="line.95"></a> -<span class="sourceLineNo">096</span> */<a name="line.96"></a> -<span class="sourceLineNo">097</span> String value() default "*";<a name="line.97"></a> -<span class="sourceLineNo">098</span>}<a name="line.98"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.serializer.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.urlencoding.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span><a name="line.23"></a> +<span class="sourceLineNo">024</span>/**<a name="line.24"></a> +<span class="sourceLineNo">025</span> * Annotation applied to Java method arguments of interface proxies to denote that they are QUERY parameters on the request.<a name="line.25"></a> +<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> +<span class="sourceLineNo">027</span> * <h5 class='section'>Example:</h5><a name="line.27"></a> +<span class="sourceLineNo">028</span> * <p class='bcode'><a name="line.28"></a> +<span class="sourceLineNo">029</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <jk>public interface</jk> MyProxy {<a name="line.30"></a> +<span class="sourceLineNo">031</span> *<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod1"</js>)<a name="line.32"></a> +<span class="sourceLineNo">033</span> * String myProxyMethod1(<ja>@Query</ja>(<js>"foo"</js>)</ja> String foo, <ja>@Query</ja>(<js>"bar"</js>)</ja> MyPojo pojo);<a name="line.33"></a> +<span class="sourceLineNo">034</span> *<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod2"</js>)<a name="line.35"></a> +<span class="sourceLineNo">036</span> * String myProxyMethod2(<ja>@Query</ja> Map&lt;String,Object&gt; query);<a name="line.36"></a> +<span class="sourceLineNo">037</span> *<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod3"</js>)<a name="line.38"></a> +<span class="sourceLineNo">039</span> * String myProxyMethod2(<ja>@Query</ja> String queryString);<a name="line.39"></a> +<span class="sourceLineNo">040</span> * }<a name="line.40"></a> +<span class="sourceLineNo">041</span> * </p><a name="line.41"></a> +<span class="sourceLineNo">042</span> * <p><a name="line.42"></a> +<span class="sourceLineNo">043</span> * The argument can be any of the following types:<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <ul class='spaced-list'><a name="line.44"></a> +<span class="sourceLineNo">045</span> * <li><code>NameValuePairs</code> - Individual name-value pairs.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <li>Any serializable POJO - Converted to text using {@link UrlEncodingSerializer#serialize(PartType,Object)}.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <li><code>Map&lt;String,Object&gt;</code> - Individual name-value pairs.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * Values are converted to text using {@link UrlEncodingSerializer#serialize(PartType,Object)}.<a name="line.48"></a> +<span class="sourceLineNo">049</span> * <li>A bean - Individual name-value pairs.<a name="line.49"></a> +<span class="sourceLineNo">050</span> * Values are converted to text using {@link UrlEncodingSerializer#serialize(PartType,Object)}.<a name="line.50"></a> +<span class="sourceLineNo">051</span> * <li>{@link String} - Treated as a query string.<a name="line.51"></a> +<span class="sourceLineNo">052</span> * </ul><a name="line.52"></a> +<span class="sourceLineNo">053</span> * <p><a name="line.53"></a> +<span class="sourceLineNo">054</span> * The annotation can also be applied to a bean property field or getter when the argument is annotated with<a name="line.54"></a> +<span class="sourceLineNo">055</span> * {@link RequestBean @RequestBean}:<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p><a name="line.56"></a> +<span class="sourceLineNo">057</span> * <h5 class='section'>Example:</h5><a name="line.57"></a> +<span class="sourceLineNo">058</span> * <p class='bcode'><a name="line.58"></a> +<span class="sourceLineNo">059</span> * <ja>@Remoteable</ja>(path=<js>"/myproxy"</js>)<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <jk>public interface</jk> MyProxy {<a name="line.60"></a> +<span class="sourceLineNo">061</span> *<a name="line.61"></a> +<span class="sourceLineNo">062</span> * <ja>@RemoteMethod</ja>(path=<js>"/mymethod"</js>)<a name="line.62"></a> +<span class="sourceLineNo">063</span> * String myProxyMethod(<ja>@RequestBean</ja> MyRequestBean bean);<a name="line.63"></a> +<span class="sourceLineNo">064</span> * }<a name="line.64"></a> +<span class="sourceLineNo">065</span> *<a name="line.65"></a> +<span class="sourceLineNo">066</span> * <jk>public interface</jk> MyRequestBean {<a name="line.66"></a> +<span class="sourceLineNo">067</span> * <ja>@Query</ja><a name="line.67"></a> +<span class="sourceLineNo">068</span> * String getFoo();<a name="line.68"></a> +<span class="sourceLineNo">069</span> *<a name="line.69"></a> +<span class="sourceLineNo">070</span> * <ja>@Query</ja><a name="line.70"></a> +<span class="sourceLineNo">071</span> * MyPojo getBar();<a name="line.71"></a> +<span class="sourceLineNo">072</span> * }<a name="line.72"></a> +<span class="sourceLineNo">073</span> * </p><a name="line.73"></a> +<span class="sourceLineNo">074</span> * <p><a name="line.74"></a> +<span class="sourceLineNo">075</span> * When used in a request bean, the {@link #value()} can be used to override the query parameter name.<a name="line.75"></a> +<span class="sourceLineNo">076</span> * It can also be overridden via the {@link BeanProperty#name @BeanProperty.name()} annotation.<a name="line.76"></a> +<span class="sourceLineNo">077</span> * A name of <js>"*"</js> where the bean property value is a map or bean will cause the individual entries in the<a name="line.77"></a> +<span class="sourceLineNo">078</span> * map or bean to be expanded to query parameters.<a name="line.78"></a> +<span class="sourceLineNo">079</span> */<a name="line.79"></a> +<span class="sourceLineNo">080</span>@Documented<a name="line.80"></a> +<span class="sourceLineNo">081</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.81"></a> +<span class="sourceLineNo">082</span>@Retention(RUNTIME)<a name="line.82"></a> +<span class="sourceLineNo">083</span>@Inherited<a name="line.83"></a> +<span class="sourceLineNo">084</span>public @interface Query {<a name="line.84"></a> +<span class="sourceLineNo">085</span><a name="line.85"></a> +<span class="sourceLineNo">086</span> /**<a name="line.86"></a> +<span class="sourceLineNo">087</span> * The query parameter name.<a name="line.87"></a> +<span class="sourceLineNo">088</span> * <p><a name="line.88"></a> +<span class="sourceLineNo">089</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.89"></a> +<span class="sourceLineNo">090</span> * for the following data types:<a name="line.90"></a> +<span class="sourceLineNo">091</span> * <ul><a name="line.91"></a> +<span class="sourceLineNo">092</span> * <li><code>String</code> - A complete query string.<a name="line.92"></a> +<span class="sourceLineNo">093</span> * <li><code>NameValuePairs</code><a name="line.93"></a> +<span class="sourceLineNo">094</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.94"></a> +<span class="sourceLineNo">095</span> * <li>A bean<a name="line.95"></a> +<span class="sourceLineNo">096</span> * </ul><a name="line.96"></a> +<span class="sourceLineNo">097</span> */<a name="line.97"></a> +<span class="sourceLineNo">098</span> String value() default "*";<a name="line.98"></a> +<span class="sourceLineNo">099</span><a name="line.99"></a> +<span class="sourceLineNo">100</span> /**<a name="line.100"></a> +<span class="sourceLineNo">101</span> * Specifies the {@link PartSerializer} class used for serializing values to strings.<a name="line.101"></a> +<span class="sourceLineNo">102</span> * <p><a name="line.102"></a> +<span class="sourceLineNo">103</span> * The default serializer converters values to UON notation.<a name="line.103"></a> +<span class="sourceLineNo">104</span> * <p><a name="line.104"></a> +<span class="sourceLineNo">105</span> * This annotation is provided to allow values to be custom serialized.<a name="line.105"></a> +<span class="sourceLineNo">106</span> */<a name="line.106"></a> +<span class="sourceLineNo">107</span> Class<? extends PartSerializer> serializer() default UrlEncodingSerializer.class;<a name="line.107"></a> +<span class="sourceLineNo">108</span>}<a name="line.108"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2f6fc8b5/content/site/apidocs/src-html/org/apache/juneau/remoteable/QueryIfNE.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/QueryIfNE.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/QueryIfNE.html index 16c42bf..e19965a 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/remoteable/QueryIfNE.html +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/QueryIfNE.html @@ -25,29 +25,41 @@ <span class="sourceLineNo">017</span><a name="line.17"></a> <span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> -<span class="sourceLineNo">020</span>/**<a name="line.20"></a> -<span class="sourceLineNo">021</span> * Identical to {@link Query @Query} except skips values if they're null/blank.<a name="line.21"></a> -<span class="sourceLineNo">022</span> */<a name="line.22"></a> -<span class="sourceLineNo">023</span>@Documented<a name="line.23"></a> -<span class="sourceLineNo">024</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.24"></a> -<span class="sourceLineNo">025</span>@Retention(RUNTIME)<a name="line.25"></a> -<span class="sourceLineNo">026</span>@Inherited<a name="line.26"></a> -<span class="sourceLineNo">027</span>public @interface QueryIfNE {<a name="line.27"></a> -<span class="sourceLineNo">028</span><a name="line.28"></a> -<span class="sourceLineNo">029</span> /**<a name="line.29"></a> -<span class="sourceLineNo">030</span> * The query parameter name.<a name="line.30"></a> -<span class="sourceLineNo">031</span> * <p><a name="line.31"></a> -<span class="sourceLineNo">032</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.32"></a> -<span class="sourceLineNo">033</span> * for the following data types:<a name="line.33"></a> -<span class="sourceLineNo">034</span> * <ul><a name="line.34"></a> -<span class="sourceLineNo">035</span> * <li><code>String</code> - A complete query string.<a name="line.35"></a> -<span class="sourceLineNo">036</span> * <li><code>NameValuePairs</code><a name="line.36"></a> -<span class="sourceLineNo">037</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.37"></a> -<span class="sourceLineNo">038</span> * <li>A bean<a name="line.38"></a> -<span class="sourceLineNo">039</span> * </ul><a name="line.39"></a> -<span class="sourceLineNo">040</span> */<a name="line.40"></a> -<span class="sourceLineNo">041</span> String value() default "*";<a name="line.41"></a> -<span class="sourceLineNo">042</span>}<a name="line.42"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.serializer.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.urlencoding.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>/**<a name="line.23"></a> +<span class="sourceLineNo">024</span> * Identical to {@link Query @Query} except skips values if they're null/blank.<a name="line.24"></a> +<span class="sourceLineNo">025</span> */<a name="line.25"></a> +<span class="sourceLineNo">026</span>@Documented<a name="line.26"></a> +<span class="sourceLineNo">027</span>@Target({PARAMETER,FIELD,METHOD})<a name="line.27"></a> +<span class="sourceLineNo">028</span>@Retention(RUNTIME)<a name="line.28"></a> +<span class="sourceLineNo">029</span>@Inherited<a name="line.29"></a> +<span class="sourceLineNo">030</span>public @interface QueryIfNE {<a name="line.30"></a> +<span class="sourceLineNo">031</span><a name="line.31"></a> +<span class="sourceLineNo">032</span> /**<a name="line.32"></a> +<span class="sourceLineNo">033</span> * The query parameter name.<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <p><a name="line.34"></a> +<span class="sourceLineNo">035</span> * A value of <js>"*"</js> indicates the value should be serialized as name/value pairs and is applicable<a name="line.35"></a> +<span class="sourceLineNo">036</span> * for the following data types:<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <ul><a name="line.37"></a> +<span class="sourceLineNo">038</span> * <li><code>String</code> - A complete query string.<a name="line.38"></a> +<span class="sourceLineNo">039</span> * <li><code>NameValuePairs</code><a name="line.39"></a> +<span class="sourceLineNo">040</span> * <li><code>Map&lt;String,Object&gt;</code><a name="line.40"></a> +<span class="sourceLineNo">041</span> * <li>A bean<a name="line.41"></a> +<span class="sourceLineNo">042</span> * </ul><a name="line.42"></a> +<span class="sourceLineNo">043</span> */<a name="line.43"></a> +<span class="sourceLineNo">044</span> String value() default "*";<a name="line.44"></a> +<span class="sourceLineNo">045</span><a name="line.45"></a> +<span class="sourceLineNo">046</span> /**<a name="line.46"></a> +<span class="sourceLineNo">047</span> * Specifies the {@link PartSerializer} class used for serializing values to strings.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * <p><a name="line.48"></a> +<span class="sourceLineNo">049</span> * The default serializer converters values to UON notation.<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <p><a name="line.50"></a> +<span class="sourceLineNo">051</span> * This annotation is provided to allow values to be custom serialized.<a name="line.51"></a> +<span class="sourceLineNo">052</span> */<a name="line.52"></a> +<span class="sourceLineNo">053</span> Class<? extends PartSerializer> serializer() default UrlEncodingSerializer.class;<a name="line.53"></a> +<span class="sourceLineNo">054</span>}<a name="line.54"></a>
