http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/content/site/apidocs/src-html/org/apache/juneau/remoteable/RemoteableMethodMeta.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/remoteable/RemoteableMethodMeta.html b/content/site/apidocs/src-html/org/apache/juneau/remoteable/RemoteableMethodMeta.html new file mode 100644 index 0000000..5bb6b3f --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/remoteable/RemoteableMethodMeta.html @@ -0,0 +1,249 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> +<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> +<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> +<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> +<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> +<span class="sourceLineNo">006</span>// * *<a name="line.6"></a> +<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> +<span class="sourceLineNo">008</span>// * *<a name="line.8"></a> +<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> +<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> +<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> +<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> +<span class="sourceLineNo">013</span>package org.apache.juneau.remoteable;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import static org.apache.juneau.internal.StringUtils.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span><a name="line.16"></a> +<span class="sourceLineNo">017</span>import java.lang.annotation.*;<a name="line.17"></a> +<span class="sourceLineNo">018</span>import java.lang.reflect.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.util.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span><a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.internal.*;<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> * Contains the meta-data about a Java method on a remoteable interface.<a name="line.24"></a> +<span class="sourceLineNo">025</span> * <p><a name="line.25"></a> +<span class="sourceLineNo">026</span> * Captures the information in {@link RemoteMethod @RemoteMethod} annotations for caching and reuse.<a name="line.26"></a> +<span class="sourceLineNo">027</span> */<a name="line.27"></a> +<span class="sourceLineNo">028</span>public class RemoteableMethodMeta {<a name="line.28"></a> +<span class="sourceLineNo">029</span><a name="line.29"></a> +<span class="sourceLineNo">030</span> private final String httpMethod;<a name="line.30"></a> +<span class="sourceLineNo">031</span> private final String url;<a name="line.31"></a> +<span class="sourceLineNo">032</span> private final RemoteMethodArg[] queryArgs, headerArgs, formDataArgs;<a name="line.32"></a> +<span class="sourceLineNo">033</span> private final Integer[] otherArgs;<a name="line.33"></a> +<span class="sourceLineNo">034</span> private final Integer bodyArg;<a name="line.34"></a> +<span class="sourceLineNo">035</span><a name="line.35"></a> +<span class="sourceLineNo">036</span> /**<a name="line.36"></a> +<span class="sourceLineNo">037</span> * Constructor.<a name="line.37"></a> +<span class="sourceLineNo">038</span> *<a name="line.38"></a> +<span class="sourceLineNo">039</span> * @param restUrl The absolute URL of the REST interface backing the interface proxy.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * @param m The Java method.<a name="line.40"></a> +<span class="sourceLineNo">041</span> */<a name="line.41"></a> +<span class="sourceLineNo">042</span> public RemoteableMethodMeta(final String restUrl, Method m) {<a name="line.42"></a> +<span class="sourceLineNo">043</span> Builder b = new Builder(restUrl, m);<a name="line.43"></a> +<span class="sourceLineNo">044</span> this.httpMethod = b.httpMethod;<a name="line.44"></a> +<span class="sourceLineNo">045</span> this.url = b.url;<a name="line.45"></a> +<span class="sourceLineNo">046</span> this.queryArgs = b.queryArgs.toArray(new RemoteMethodArg[b.queryArgs.size()]);<a name="line.46"></a> +<span class="sourceLineNo">047</span> this.formDataArgs = b.formDataArgs.toArray(new RemoteMethodArg[b.formDataArgs.size()]);<a name="line.47"></a> +<span class="sourceLineNo">048</span> this.headerArgs = b.headerArgs.toArray(new RemoteMethodArg[b.headerArgs.size()]);<a name="line.48"></a> +<span class="sourceLineNo">049</span> this.otherArgs = b.otherArgs.toArray(new Integer[b.otherArgs.size()]);<a name="line.49"></a> +<span class="sourceLineNo">050</span> this.bodyArg = b.bodyArg;<a name="line.50"></a> +<span class="sourceLineNo">051</span> }<a name="line.51"></a> +<span class="sourceLineNo">052</span><a name="line.52"></a> +<span class="sourceLineNo">053</span> private static class Builder {<a name="line.53"></a> +<span class="sourceLineNo">054</span> private String httpMethod, url;<a name="line.54"></a> +<span class="sourceLineNo">055</span> private List<RemoteMethodArg><a name="line.55"></a> +<span class="sourceLineNo">056</span> queryArgs = new LinkedList<RemoteMethodArg>(),<a name="line.56"></a> +<span class="sourceLineNo">057</span> headerArgs = new LinkedList<RemoteMethodArg>(),<a name="line.57"></a> +<span class="sourceLineNo">058</span> formDataArgs = new LinkedList<RemoteMethodArg>();<a name="line.58"></a> +<span class="sourceLineNo">059</span> private List<Integer> otherArgs = new LinkedList<Integer>();<a name="line.59"></a> +<span class="sourceLineNo">060</span> private Integer bodyArg;<a name="line.60"></a> +<span class="sourceLineNo">061</span><a name="line.61"></a> +<span class="sourceLineNo">062</span> private Builder(String restUrl, Method m) {<a name="line.62"></a> +<span class="sourceLineNo">063</span> Remoteable r = m.getDeclaringClass().getAnnotation(Remoteable.class);<a name="line.63"></a> +<span class="sourceLineNo">064</span> RemoteMethod rm = m.getAnnotation(RemoteMethod.class);<a name="line.64"></a> +<span class="sourceLineNo">065</span><a name="line.65"></a> +<span class="sourceLineNo">066</span> httpMethod = rm == null ? "POST" : rm.httpMethod();<a name="line.66"></a> +<span class="sourceLineNo">067</span> if (! isOneOf(httpMethod, "GET", "POST"))<a name="line.67"></a> +<span class="sourceLineNo">068</span> throw new RemoteableMetadataException(m, "Invalid value specified for @RemoteMethod.httpMethod() annotation. Valid values are [GET,POST].");<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span> String path = rm == null || rm.path().isEmpty() ? null : rm.path();<a name="line.70"></a> +<span class="sourceLineNo">071</span> String methodPaths = r == null ? "NAME" : r.methodPaths();<a name="line.71"></a> +<span class="sourceLineNo">072</span><a name="line.72"></a> +<span class="sourceLineNo">073</span> if (! isOneOf(methodPaths, "NAME", "SIGNATURE"))<a name="line.73"></a> +<span class="sourceLineNo">074</span> throw new RemoteableMetadataException(m, "Invalid value specified for @Remoteable.methodPaths() annotation. Valid values are [NAME,SIGNATURE].");<a name="line.74"></a> +<span class="sourceLineNo">075</span><a name="line.75"></a> +<span class="sourceLineNo">076</span> url =<a name="line.76"></a> +<span class="sourceLineNo">077</span> trimSlashes(restUrl)<a name="line.77"></a> +<span class="sourceLineNo">078</span> + '/'<a name="line.78"></a> +<span class="sourceLineNo">079</span> + (path != null ? trimSlashes(path) : urlEncode("NAME".equals(methodPaths) ? m.getName() : ClassUtils.getMethodSignature(m)));<a name="line.79"></a> +<span class="sourceLineNo">080</span><a name="line.80"></a> +<span class="sourceLineNo">081</span> int index = 0;<a name="line.81"></a> +<span class="sourceLineNo">082</span> for (Annotation[] aa : m.getParameterAnnotations()) {<a name="line.82"></a> +<span class="sourceLineNo">083</span> boolean annotated = false;<a name="line.83"></a> +<span class="sourceLineNo">084</span> for (Annotation a : aa) {<a name="line.84"></a> +<span class="sourceLineNo">085</span> Class<?> ca = a.annotationType();<a name="line.85"></a> +<span class="sourceLineNo">086</span> if (ca == Query.class) {<a name="line.86"></a> +<span class="sourceLineNo">087</span> Query q = (Query)a;<a name="line.87"></a> +<span class="sourceLineNo">088</span> annotated = queryArgs.add(new RemoteMethodArg(q.value(), index, false));<a name="line.88"></a> +<span class="sourceLineNo">089</span> } else if (ca == QueryIfNE.class) {<a name="line.89"></a> +<span class="sourceLineNo">090</span> Query q = (Query)a;<a name="line.90"></a> +<span class="sourceLineNo">091</span> annotated = queryArgs.add(new RemoteMethodArg(q.value(), index, true));<a name="line.91"></a> +<span class="sourceLineNo">092</span> } else if (ca == FormData.class) {<a name="line.92"></a> +<span class="sourceLineNo">093</span> FormData f = (FormData)a;<a name="line.93"></a> +<span class="sourceLineNo">094</span> annotated = formDataArgs.add(new RemoteMethodArg(f.value(), index, false));<a name="line.94"></a> +<span class="sourceLineNo">095</span> } else if (ca == FormDataIfNE.class) {<a name="line.95"></a> +<span class="sourceLineNo">096</span> FormData f = (FormData)a;<a name="line.96"></a> +<span class="sourceLineNo">097</span> annotated = formDataArgs.add(new RemoteMethodArg(f.value(), index, true));<a name="line.97"></a> +<span class="sourceLineNo">098</span> } else if (ca == Header.class) {<a name="line.98"></a> +<span class="sourceLineNo">099</span> Header h = (Header)a;<a name="line.99"></a> +<span class="sourceLineNo">100</span> annotated = headerArgs.add(new RemoteMethodArg(h.value(), index, false));<a name="line.100"></a> +<span class="sourceLineNo">101</span> } else if (ca == HeaderIfNE.class) {<a name="line.101"></a> +<span class="sourceLineNo">102</span> Header h = (Header)a;<a name="line.102"></a> +<span class="sourceLineNo">103</span> annotated = headerArgs.add(new RemoteMethodArg(h.value(), index, true));<a name="line.103"></a> +<span class="sourceLineNo">104</span> } else if (ca == Body.class) {<a name="line.104"></a> +<span class="sourceLineNo">105</span> annotated = true;<a name="line.105"></a> +<span class="sourceLineNo">106</span> if (bodyArg == null)<a name="line.106"></a> +<span class="sourceLineNo">107</span> bodyArg = index;<a name="line.107"></a> +<span class="sourceLineNo">108</span> else<a name="line.108"></a> +<span class="sourceLineNo">109</span> throw new RemoteableMetadataException(m, "Multiple @Body parameters found. Only one can be specified per Java method.");<a name="line.109"></a> +<span class="sourceLineNo">110</span> }<a name="line.110"></a> +<span class="sourceLineNo">111</span> }<a name="line.111"></a> +<span class="sourceLineNo">112</span> if (! annotated)<a name="line.112"></a> +<span class="sourceLineNo">113</span> otherArgs.add(index);<a name="line.113"></a> +<span class="sourceLineNo">114</span> index++;<a name="line.114"></a> +<span class="sourceLineNo">115</span> }<a name="line.115"></a> +<span class="sourceLineNo">116</span><a name="line.116"></a> +<span class="sourceLineNo">117</span> if (bodyArg != null && otherArgs.size() > 0)<a name="line.117"></a> +<span class="sourceLineNo">118</span> throw new RemoteableMetadataException(m, "@Body and non-annotated parameters found together. Non-annotated parameters cannot be used when @Body is used.");<a name="line.118"></a> +<span class="sourceLineNo">119</span> }<a name="line.119"></a> +<span class="sourceLineNo">120</span> }<a name="line.120"></a> +<span class="sourceLineNo">121</span><a name="line.121"></a> +<span class="sourceLineNo">122</span> /**<a name="line.122"></a> +<span class="sourceLineNo">123</span> * Returns the value of the {@link RemoteMethod#httpMethod()} annotation on this Java method.<a name="line.123"></a> +<span class="sourceLineNo">124</span> * @return The value of the {@link RemoteMethod#httpMethod()} annotation, never <jk>null</jk>.<a name="line.124"></a> +<span class="sourceLineNo">125</span> */<a name="line.125"></a> +<span class="sourceLineNo">126</span> public String getHttpMethod() {<a name="line.126"></a> +<span class="sourceLineNo">127</span> return httpMethod;<a name="line.127"></a> +<span class="sourceLineNo">128</span> }<a name="line.128"></a> +<span class="sourceLineNo">129</span><a name="line.129"></a> +<span class="sourceLineNo">130</span> /**<a name="line.130"></a> +<span class="sourceLineNo">131</span> * Returns the absolute URL of the REST interface invoked by this Java method.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * @return The absolute URL of the REST interface, never <jk>null</jk>.<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> public String getUrl() {<a name="line.134"></a> +<span class="sourceLineNo">135</span> return url;<a name="line.135"></a> +<span class="sourceLineNo">136</span> }<a name="line.136"></a> +<span class="sourceLineNo">137</span><a name="line.137"></a> +<span class="sourceLineNo">138</span> /**<a name="line.138"></a> +<span class="sourceLineNo">139</span> * Returns the {@link Query @Query} annotated arguments on this Java method.<a name="line.139"></a> +<span class="sourceLineNo">140</span> * @return A map of {@link Query#value() @Query.value()} names to zero-indexed argument indices.<a name="line.140"></a> +<span class="sourceLineNo">141</span> */<a name="line.141"></a> +<span class="sourceLineNo">142</span> public RemoteMethodArg[] getQueryArgs() {<a name="line.142"></a> +<span class="sourceLineNo">143</span> return queryArgs;<a name="line.143"></a> +<span class="sourceLineNo">144</span> }<a name="line.144"></a> +<span class="sourceLineNo">145</span><a name="line.145"></a> +<span class="sourceLineNo">146</span> /**<a name="line.146"></a> +<span class="sourceLineNo">147</span> * Returns the {@link FormData @FormData} annotated arguments on this Java method.<a name="line.147"></a> +<span class="sourceLineNo">148</span> * @return A map of {@link FormData#value() @FormData.value()} names to zero-indexed argument indices.<a name="line.148"></a> +<span class="sourceLineNo">149</span> */<a name="line.149"></a> +<span class="sourceLineNo">150</span> public RemoteMethodArg[] getFormDataArgs() {<a name="line.150"></a> +<span class="sourceLineNo">151</span> return formDataArgs;<a name="line.151"></a> +<span class="sourceLineNo">152</span> }<a name="line.152"></a> +<span class="sourceLineNo">153</span><a name="line.153"></a> +<span class="sourceLineNo">154</span> /**<a name="line.154"></a> +<span class="sourceLineNo">155</span> * Returns the {@link Header @Header} annotated arguments on this Java method.<a name="line.155"></a> +<span class="sourceLineNo">156</span> * @return A map of {@link Header#value() @Header.value()} names to zero-indexed argument indices.<a name="line.156"></a> +<span class="sourceLineNo">157</span> */<a name="line.157"></a> +<span class="sourceLineNo">158</span> public RemoteMethodArg[] getHeaderArgs() {<a name="line.158"></a> +<span class="sourceLineNo">159</span> return headerArgs;<a name="line.159"></a> +<span class="sourceLineNo">160</span> }<a name="line.160"></a> +<span class="sourceLineNo">161</span><a name="line.161"></a> +<span class="sourceLineNo">162</span> /**<a name="line.162"></a> +<span class="sourceLineNo">163</span> * Returns the remaining non-annotated arguments on this Java method.<a name="line.163"></a> +<span class="sourceLineNo">164</span> * @return A list of zero-indexed argument indices.<a name="line.164"></a> +<span class="sourceLineNo">165</span> */<a name="line.165"></a> +<span class="sourceLineNo">166</span> public Integer[] getOtherArgs() {<a name="line.166"></a> +<span class="sourceLineNo">167</span> return otherArgs;<a name="line.167"></a> +<span class="sourceLineNo">168</span> }<a name="line.168"></a> +<span class="sourceLineNo">169</span><a name="line.169"></a> +<span class="sourceLineNo">170</span> /**<a name="line.170"></a> +<span class="sourceLineNo">171</span> * Returns the argument annotated with {@link Body @Body}.<a name="line.171"></a> +<span class="sourceLineNo">172</span> * @return A index of the argument with the {@link Body @Body} annotation, or <jk>null</jk> if no argument exists.<a name="line.172"></a> +<span class="sourceLineNo">173</span> */<a name="line.173"></a> +<span class="sourceLineNo">174</span> public Integer getBodyArg() {<a name="line.174"></a> +<span class="sourceLineNo">175</span> return bodyArg;<a name="line.175"></a> +<span class="sourceLineNo">176</span> }<a name="line.176"></a> +<span class="sourceLineNo">177</span>}<a name="line.177"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/content/site/apidocs/src-html/org/apache/juneau/rest/Redirect.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/Redirect.html b/content/site/apidocs/src-html/org/apache/juneau/rest/Redirect.html index 6f33406..67a7a32 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/Redirect.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/Redirect.html @@ -140,13 +140,13 @@ <span class="sourceLineNo">132</span> /**<a name="line.132"></a> <span class="sourceLineNo">133</span> * Calculates the URL to redirect to.<a name="line.133"></a> <span class="sourceLineNo">134</span> *<a name="line.134"></a> -<span class="sourceLineNo">135</span> * @param s Use this serializer to encode arguments using the {@link UrlEncodingSerializer#serializeUrlPart(Object)} method.<a name="line.135"></a> +<span class="sourceLineNo">135</span> * @param s Use this serializer to encode arguments using the {@link UrlEncodingSerializer#serializePart(Object,Boolean,Boolean)} method.<a name="line.135"></a> <span class="sourceLineNo">136</span> * @return The URL to redirect to.<a name="line.136"></a> <span class="sourceLineNo">137</span> */<a name="line.137"></a> <span class="sourceLineNo">138</span> public String toUrl(UrlEncodingSerializer s) {<a name="line.138"></a> <span class="sourceLineNo">139</span> if (url != null && args != null && args.length > 0) {<a name="line.139"></a> <span class="sourceLineNo">140</span> for (int i = 0; i < args.length; i++)<a name="line.140"></a> -<span class="sourceLineNo">141</span> args[i] = s.serializeUrlPart(args[i]);<a name="line.141"></a> +<span class="sourceLineNo">141</span> args[i] = s.serializePart(args[i], null, true);<a name="line.141"></a> <span class="sourceLineNo">142</span> return MessageFormat.format(url, args);<a name="line.142"></a> <span class="sourceLineNo">143</span> }<a name="line.143"></a> <span class="sourceLineNo">144</span> return url;<a name="line.144"></a>
