Google Git
Sign in
apache / juneau-website / f23d353f821cb79c2740022f2694d528c3c8303b / . / content / site / apidocs-9.0.0 / src-html / org / apache / juneau / rest / RestChildren.Builder.html
blob: 68fc00dcea1caeeb570f3409d94970446111aef3 [file] [log] [blame]
<!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;<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><a name="line.16"></a>
<span class="sourceLineNo">017</span>import java.util.*;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import javax.servlet.*;<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.cp.*;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.juneau.internal.*;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.juneau.rest.annotation.*;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.juneau.rest.util.*;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Implements the child resources of a {@link Rest}-annotated class.<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;ul class='seealso'&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;li class='link'&gt;{@doc jrs.AnnotatedClasses}<a name="line.31"></a>
<span class="sourceLineNo">032</span> * &lt;li class='extlink'&gt;{@source}<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;/ul&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>public class RestChildren {<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.37"></a>
<span class="sourceLineNo">038</span> // Static<a name="line.38"></a>
<span class="sourceLineNo">039</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Represents a null value for the {@link Rest#restChildrenClass()} annotation.<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span> @SuppressWarnings("javadoc")<a name="line.44"></a>
<span class="sourceLineNo">045</span> public final class Void extends RestChildren {<a name="line.45"></a>
<span class="sourceLineNo">046</span> public Void(Builder builder) throws Exception {<a name="line.46"></a>
<span class="sourceLineNo">047</span> super(builder);<a name="line.47"></a>
<span class="sourceLineNo">048</span> }<a name="line.48"></a>
<span class="sourceLineNo">049</span> }<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Static creator.<a name="line.52"></a>
<span class="sourceLineNo">053</span> *<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @param beanStore The bean store to use for creating beans.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @return A new builder for this object.<a name="line.55"></a>
<span class="sourceLineNo">056</span> */<a name="line.56"></a>
<span class="sourceLineNo">057</span> public static Builder create(BeanStore beanStore) {<a name="line.57"></a>
<span class="sourceLineNo">058</span> return new Builder(beanStore);<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> //-----------------------------------------------------------------------------------------------------------------<a name="line.61"></a>
<span class="sourceLineNo">062</span> // Builder<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> /**<a name="line.65"></a>
<span class="sourceLineNo">066</span> * Builder class.<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> @FluentSetters<a name="line.68"></a>
<span class="sourceLineNo">069</span> public static class Builder extends BeanBuilder&lt;RestChildren&gt; {<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> final List&lt;RestContext&gt; list;<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Constructor.<a name="line.74"></a>
<span class="sourceLineNo">075</span> *<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @param beanStore The bean store to use for creating beans.<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span> protected Builder(BeanStore beanStore) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> super(RestChildren.class, beanStore);<a name="line.79"></a>
<span class="sourceLineNo">080</span> list = list();<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> @Override /* BeanBuilder */<a name="line.83"></a>
<span class="sourceLineNo">084</span> protected RestChildren buildDefault() {<a name="line.84"></a>
<span class="sourceLineNo">085</span> return new RestChildren(this);<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> //-------------------------------------------------------------------------------------------------------------<a name="line.88"></a>
<span class="sourceLineNo">089</span> // Properties<a name="line.89"></a>
<span class="sourceLineNo">090</span> //-------------------------------------------------------------------------------------------------------------<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
<span class="sourceLineNo">093</span> * Adds a child resource to this builder.<a name="line.93"></a>
<span class="sourceLineNo">094</span> *<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @param value The REST context of the child resource.<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @return This object.<a name="line.96"></a>
<span class="sourceLineNo">097</span> */<a name="line.97"></a>
<span class="sourceLineNo">098</span> public Builder add(RestContext value) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> list.add(value);<a name="line.99"></a>
<span class="sourceLineNo">100</span> return this;<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> // &lt;FluentSetters&gt;<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> @Override /* GENERATED - org.apache.juneau.BeanBuilder */<a name="line.105"></a>
<span class="sourceLineNo">106</span> public Builder impl(Object value) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> super.impl(value);<a name="line.107"></a>
<span class="sourceLineNo">108</span> return this;<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> @Override /* GENERATED - org.apache.juneau.BeanBuilder */<a name="line.111"></a>
<span class="sourceLineNo">112</span> public Builder type(Class&lt;?&gt; value) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> super.type(value);<a name="line.113"></a>
<span class="sourceLineNo">114</span> return this;<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> // &lt;/FluentSetters&gt;<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>
<span class="sourceLineNo">120</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.120"></a>
<span class="sourceLineNo">121</span> // Instance<a name="line.121"></a>
<span class="sourceLineNo">122</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> private final Map&lt;String,RestContext&gt; children = synced(map());<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> /**<a name="line.126"></a>
<span class="sourceLineNo">127</span> * Constructor.<a name="line.127"></a>
<span class="sourceLineNo">128</span> *<a name="line.128"></a>
<span class="sourceLineNo">129</span> * @param builder The builder containing the settings for this object.<a name="line.129"></a>
<span class="sourceLineNo">130</span> */<a name="line.130"></a>
<span class="sourceLineNo">131</span> public RestChildren(Builder builder) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> for (RestContext rc : builder.list)<a name="line.132"></a>
<span class="sourceLineNo">133</span> children.put(rc.getPath(), rc);<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> /**<a name="line.136"></a>
<span class="sourceLineNo">137</span> * Looks through the registered children of this object and returns the best match.<a name="line.137"></a>
<span class="sourceLineNo">138</span> *<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @param builder The HTTP call builder.<a name="line.139"></a>
<span class="sourceLineNo">140</span> * @return The child that best matches the call, or an empty {@link Optional} if a match could not be made.<a name="line.140"></a>
<span class="sourceLineNo">141</span> */<a name="line.141"></a>
<span class="sourceLineNo">142</span> public Optional&lt;RestChildMatch&gt; findMatch(RestSession.Builder builder) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> String pi = builder.getPathInfoUndecoded();<a name="line.143"></a>
<span class="sourceLineNo">144</span> if ((! children.isEmpty()) &amp;&amp; pi != null &amp;&amp; ! pi.equals("/")) {<a name="line.144"></a>
<span class="sourceLineNo">145</span> for (RestContext rc : children.values()) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> UrlPathMatcher upp = rc.getPathMatcher();<a name="line.146"></a>
<span class="sourceLineNo">147</span> UrlPathMatch uppm = upp.match(builder.getUrlPath());<a name="line.147"></a>
<span class="sourceLineNo">148</span> if (uppm != null) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> return optional(RestChildMatch.create(uppm, rc));<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span> return empty();<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> /**<a name="line.156"></a>
<span class="sourceLineNo">157</span> * Returns the children in this object as a map.<a name="line.157"></a>
<span class="sourceLineNo">158</span> *<a name="line.158"></a>
<span class="sourceLineNo">159</span> * &lt;p&gt;<a name="line.159"></a>
<span class="sourceLineNo">160</span> * The keys are the {@link RestContext#getPath() paths} of the child contexts.<a name="line.160"></a>
<span class="sourceLineNo">161</span> *<a name="line.161"></a>
<span class="sourceLineNo">162</span> * @return The children as an unmodifiable map.<a name="line.162"></a>
<span class="sourceLineNo">163</span> */<a name="line.163"></a>
<span class="sourceLineNo">164</span> public Map&lt;String,RestContext&gt; asMap() {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return unmodifiable(children);<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><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> // Lifecycle methods.<a name="line.170"></a>
<span class="sourceLineNo">171</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> /**<a name="line.173"></a>
<span class="sourceLineNo">174</span> * Called during servlet initialization on all children to invoke all {@link HookEvent#POST_INIT} methods.<a name="line.174"></a>
<span class="sourceLineNo">175</span> *<a name="line.175"></a>
<span class="sourceLineNo">176</span> * @throws ServletException Error occurred.<a name="line.176"></a>
<span class="sourceLineNo">177</span> */<a name="line.177"></a>
<span class="sourceLineNo">178</span> public void postInit() throws ServletException {<a name="line.178"></a>
<span class="sourceLineNo">179</span> for (RestContext childContext : children.values())<a name="line.179"></a>
<span class="sourceLineNo">180</span> childContext.postInit();<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span> /**<a name="line.183"></a>
<span class="sourceLineNo">184</span> * Called during servlet initialization on all children to invoke all {@link HookEvent#POST_INIT_CHILD_FIRST} methods.<a name="line.184"></a>
<span class="sourceLineNo">185</span> *<a name="line.185"></a>
<span class="sourceLineNo">186</span> * @throws ServletException Error occurred.<a name="line.186"></a>
<span class="sourceLineNo">187</span> */<a name="line.187"></a>
<span class="sourceLineNo">188</span> public void postInitChildFirst() throws ServletException {<a name="line.188"></a>
<span class="sourceLineNo">189</span> for (RestContext childContext : children.values())<a name="line.189"></a>
<span class="sourceLineNo">190</span> childContext.postInitChildFirst();<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span><a name="line.192"></a>
<span class="sourceLineNo">193</span> /**<a name="line.193"></a>
<span class="sourceLineNo">194</span> * Called during servlet destruction on all children to invoke all {@link HookEvent#DESTROY} and {@link Servlet#destroy()} methods.<a name="line.194"></a>
<span class="sourceLineNo">195</span> */<a name="line.195"></a>
<span class="sourceLineNo">196</span> public void destroy() {<a name="line.196"></a>
<span class="sourceLineNo">197</span> for (RestContext r : children.values()) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> r.destroy();<a name="line.198"></a>
<span class="sourceLineNo">199</span> if (r.getResource() instanceof Servlet)<a name="line.199"></a>
<span class="sourceLineNo">200</span> ((Servlet)r.getResource()).destroy();<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span>}<a name="line.203"></a>
</pre>
</div>
</body>
</html>