| <!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.rest.arg;<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.CollectionUtils.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span>import static org.apache.juneau.internal.StringUtils.*;<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import static org.apache.juneau.http.annotation.QueryAnnotation.*;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><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.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.juneau.annotation.*;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.juneau.collections.*;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.juneau.http.annotation.*;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.juneau.httppart.*;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.juneau.internal.*;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.juneau.reflect.*;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.juneau.rest.*;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.juneau.rest.annotation.*;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.juneau.rest.httppart.*;<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> * Resolves method parameters and parameter types annotated with {@link Query} on {@link RestOp}-annotated Java methods.<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> * The parameter value is resolved using:<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <p class='bjava'><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <jv>opSession</jv><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * .{@link RestOpSession#getRequest() getRequest}()<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * .{@link RestRequest#getQueryParams() getQueryParams}()<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * .{@link RequestQueryParams#get(String) get}(<jv>name</jv>)<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * .{@link RequestQueryParam#as(Class) as}(<jv>type</jv>);<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * </p><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> *<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <p><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * {@link HttpPartSchema schema} is derived from the {@link Query} annotation.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <p><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * If the {@link Schema#collectionFormat()} value is {@link HttpPartCollectionFormat#MULTI}, then the data type can be a {@link Collection} or array.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> *<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <ul class='seealso'><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <li class='link'>{@doc jrs.JavaMethodParameters}<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <li class='extlink'>{@source}<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * </ul><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> */<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>public class QueryArg implements RestOpArg {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> private final boolean multi;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> private final HttpPartParser partParser;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private final HttpPartSchema schema;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private final String name, def;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private final ClassInfo type;<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> * Static creator.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> *<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param paramInfo The Java method parameter being resolved.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @param annotations The annotations to apply to any new part parsers.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @return A new {@link QueryArg}, or <jk>null</jk> if the parameter is not annotated with {@link Query}.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> public static QueryArg create(ParamInfo paramInfo, AnnotationWorkList annotations) {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> if (paramInfo.hasAnnotation(Query.class) || paramInfo.getParameterType().hasAnnotation(Query.class))<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> return new QueryArg(paramInfo, annotations);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> return null;<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> /**<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * Constructor.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> *<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @param pi The Java method parameter being resolved.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @param annotations The annotations to apply to any new part parsers.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> */<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> protected QueryArg(ParamInfo pi, AnnotationWorkList annotations) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> this.name = findName(pi).orElseThrow(() -> new ArgException(pi, "@Query used without name or value"));<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> this.def = findDef(pi).orElse(null);<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> this.type = pi.getParameterType();<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> this.schema = HttpPartSchema.create(Query.class, pi);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> Class<? extends HttpPartParser> pp = schema.getParser();<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> this.partParser = pp != null ? HttpPartParser.creator().type(pp).apply(annotations).create() : null;<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> this.multi = schema.getCollectionFormat() == HttpPartCollectionFormat.MULTI;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> if (multi && ! type.isCollectionOrArray())<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> throw new ArgException(pi, "Use of multipart flag on @Query parameter that is not an array or Collection");<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> }<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> @SuppressWarnings({ "rawtypes", "unchecked" })<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> @Override /* RestOpArg */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> public Object resolve(RestOpSession opSession) throws Exception {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> RestRequest req = opSession.getRequest();<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> HttpPartParserSession ps = partParser == null ? req.getPartParserSession() : partParser.getPartSession();<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> RequestQueryParams rh = req.getQueryParams();<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> BeanSession bs = req.getBeanSession();<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> ClassMeta<?> cm = bs.getClassMeta(type.innerType());<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> if (multi) {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> Collection c = cm.isArray() ? list() : (Collection)(cm.canCreateNewInstance() ? cm.newInstance() : new JsonList());<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> rh.getAll(name).stream().map(x -> x.parser(ps).schema(schema).as(cm.getElementType()).orElse(null)).forEach(x -> c.add(x));<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return cm.isArray() ? ArrayUtils.toArray(c, cm.getElementType().getInnerClass()) : c;<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> if (cm.isMapOrBean() && isOneOf(name, "*", "")) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> JsonMap m = new JsonMap();<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> for (RequestQueryParam e : rh.getAll())<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> m.put(e.getName(), e.parser(ps).schema(schema == null ? null : schema.getProperty(e.getName())).as(cm.getValueType()).orElse(null));<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> return req.getBeanSession().convertToType(m, cm);<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> return rh.getLast(name).parser(ps).schema(schema).def(def).as(type.innerType()).orElse(null);<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> }<a name="line.118"></a> |
| <span class="sourceLineNo">119</span>}<a name="line.119"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
