Repository: incubator-juneau-website Updated Branches: refs/heads/asf-site 58c75a058 -> 84931d4db
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/84931d4d/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HookEvent.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HookEvent.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HookEvent.html new file mode 100644 index 0000000..54908bb --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/HookEvent.html @@ -0,0 +1,491 @@ +<!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.annotation;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import java.io.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import java.util.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span>import java.util.logging.*;<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>import javax.servlet.http.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.juneau.dto.swagger.*;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.juneau.http.*;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.juneau.ini.*;<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.rest.*;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.juneau.utils.*;<a name="line.28"></a> +<span class="sourceLineNo">029</span><a name="line.29"></a> +<span class="sourceLineNo">030</span>/**<a name="line.30"></a> +<span class="sourceLineNo">031</span> * Identifies servlet and REST call lifecycle events which cause {@link RestHook @RestHook}-annotated Java methods<a name="line.31"></a> +<span class="sourceLineNo">032</span> * to be called.<a name="line.32"></a> +<span class="sourceLineNo">033</span> */<a name="line.33"></a> +<span class="sourceLineNo">034</span>public enum HookEvent {<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> * Identifies a method that should be called immediately after the <code>HttpServlet.service(HttpServletRequest, HttpServletResponse)</code><a name="line.37"></a> +<span class="sourceLineNo">038</span> * method is called.<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> * Note that you only have access to the raw request and response objects at this point.<a name="line.41"></a> +<span class="sourceLineNo">042</span> *<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <p><a name="line.43"></a> +<span class="sourceLineNo">044</span> * The list of valid parameter types are as follows:<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <ul><a name="line.45"></a> +<span class="sourceLineNo">046</span> * <li>Servlet request/response objects:<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <ul><a name="line.47"></a> +<span class="sourceLineNo">048</span> * <li>{@link HttpServletRequest}<a name="line.48"></a> +<span class="sourceLineNo">049</span> * <li>{@link HttpServletResponse}<a name="line.49"></a> +<span class="sourceLineNo">050</span> * </ul><a name="line.50"></a> +<span class="sourceLineNo">051</span> * </ul><a name="line.51"></a> +<span class="sourceLineNo">052</span> *<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <h6 class='figure'>Example:</h6><a name="line.53"></a> +<span class="sourceLineNo">054</span> * <p class='bcode'><a name="line.54"></a> +<span class="sourceLineNo">055</span> * <ja>@RestResource</ja>(...)<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.56"></a> +<span class="sourceLineNo">057</span> *<a name="line.57"></a> +<span class="sourceLineNo">058</span> * <jc>// Add a request attribute to all incoming requests.</jc><a name="line.58"></a> +<span class="sourceLineNo">059</span> * <ja>@RestHook</ja>(<jsf>START_CALL</jsf>)<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <jk>public void</jk> onStartCall(HttpServletRequest req) {<a name="line.60"></a> +<span class="sourceLineNo">061</span> * req.setAttribute(<js>"foobar"</js>, <jk>new</jk> FooBar());<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> * </p><a name="line.64"></a> +<span class="sourceLineNo">065</span> *<a name="line.65"></a> +<span class="sourceLineNo">066</span> * <h5 class='section'>Notes:</h5><a name="line.66"></a> +<span class="sourceLineNo">067</span> * <ul class='spaced-list'><a name="line.67"></a> +<span class="sourceLineNo">068</span> * <li>If the method returns any value, it is ignored.<a name="line.68"></a> +<span class="sourceLineNo">069</span> * <li>Multiple START_CALL methods can be defined on a class.<a name="line.69"></a> +<span class="sourceLineNo">070</span> * <br>START_CALL methods on parent classes are invoked before START_CALL methods on child classes.<a name="line.70"></a> +<span class="sourceLineNo">071</span> * <br>The order of START_CALL method invocations within a class is alphabetical, then by parameter count, then by parameter types.<a name="line.71"></a> +<span class="sourceLineNo">072</span> * <li>The method can throw any exception.<a name="line.72"></a> +<span class="sourceLineNo">073</span> * <br>{@link RestException RestExceptions} can be thrown to cause a particular HTTP error status code.<a name="line.73"></a> +<span class="sourceLineNo">074</span> * <br>All other exceptions cause an HTTP 500 error status code.<a name="line.74"></a> +<span class="sourceLineNo">075</span> * <li>Note that if you override a parent method, you probably need to call <code><jk>super</jk>.parentMethod(...)</code>.<a name="line.75"></a> +<span class="sourceLineNo">076</span> * <br>The method is still considered part of the parent class for ordering purposes even though it's<a name="line.76"></a> +<span class="sourceLineNo">077</span> * overridden by the child class.<a name="line.77"></a> +<span class="sourceLineNo">078</span> * </ul><a name="line.78"></a> +<span class="sourceLineNo">079</span> */<a name="line.79"></a> +<span class="sourceLineNo">080</span> START_CALL,<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> * Identifies a method that gets called immediately before the <ja>@RestMethod</ja> annotated method gets called.<a name="line.83"></a> +<span class="sourceLineNo">084</span> *<a name="line.84"></a> +<span class="sourceLineNo">085</span> * <p><a name="line.85"></a> +<span class="sourceLineNo">086</span> * At this point, the {@link RestRequest} object has been fully initialized, and all {@link RestGuard} and<a name="line.86"></a> +<span class="sourceLineNo">087</span> * {@link RestMatcher} objects have been called.<a name="line.87"></a> +<span class="sourceLineNo">088</span> *<a name="line.88"></a> +<span class="sourceLineNo">089</span> * <p><a name="line.89"></a> +<span class="sourceLineNo">090</span> * The list of valid parameter types are as follows:<a name="line.90"></a> +<span class="sourceLineNo">091</span> * <ul><a name="line.91"></a> +<span class="sourceLineNo">092</span> * <li>Servlet request/response objects:<a name="line.92"></a> +<span class="sourceLineNo">093</span> * <ul><a name="line.93"></a> +<span class="sourceLineNo">094</span> * <li>{@link HttpServletRequest}<a name="line.94"></a> +<span class="sourceLineNo">095</span> * <li>{@link HttpServletResponse}<a name="line.95"></a> +<span class="sourceLineNo">096</span> * </ul><a name="line.96"></a> +<span class="sourceLineNo">097</span> * <li>Extended request/response objects:<a name="line.97"></a> +<span class="sourceLineNo">098</span> * <ul><a name="line.98"></a> +<span class="sourceLineNo">099</span> * <li>{@link RestRequest}<a name="line.99"></a> +<span class="sourceLineNo">100</span> * <li>{@link RestResponse}<a name="line.100"></a> +<span class="sourceLineNo">101</span> * </ul><a name="line.101"></a> +<span class="sourceLineNo">102</span> * <li>Header objects:<a name="line.102"></a> +<span class="sourceLineNo">103</span> * <ul><a name="line.103"></a> +<span class="sourceLineNo">104</span> * <li>{@link Accept}<a name="line.104"></a> +<span class="sourceLineNo">105</span> * <li>{@link AcceptCharset}<a name="line.105"></a> +<span class="sourceLineNo">106</span> * <li>{@link AcceptEncoding}<a name="line.106"></a> +<span class="sourceLineNo">107</span> * <li>{@link AcceptLanguage}<a name="line.107"></a> +<span class="sourceLineNo">108</span> * <li>{@link Authorization}<a name="line.108"></a> +<span class="sourceLineNo">109</span> * <li>{@link CacheControl}<a name="line.109"></a> +<span class="sourceLineNo">110</span> * <li>{@link Connection}<a name="line.110"></a> +<span class="sourceLineNo">111</span> * <li>{@link ContentLength}<a name="line.111"></a> +<span class="sourceLineNo">112</span> * <li>{@link ContentType}<a name="line.112"></a> +<span class="sourceLineNo">113</span> * <li>{@link org.apache.juneau.http.Date}<a name="line.113"></a> +<span class="sourceLineNo">114</span> * <li>{@link Expect}<a name="line.114"></a> +<span class="sourceLineNo">115</span> * <li>{@link From}<a name="line.115"></a> +<span class="sourceLineNo">116</span> * <li>{@link Host}<a name="line.116"></a> +<span class="sourceLineNo">117</span> * <li>{@link IfMatch}<a name="line.117"></a> +<span class="sourceLineNo">118</span> * <li>{@link IfModifiedSince}<a name="line.118"></a> +<span class="sourceLineNo">119</span> * <li>{@link IfNoneMatch}<a name="line.119"></a> +<span class="sourceLineNo">120</span> * <li>{@link IfRange}<a name="line.120"></a> +<span class="sourceLineNo">121</span> * <li>{@link IfUnmodifiedSince}<a name="line.121"></a> +<span class="sourceLineNo">122</span> * <li>{@link MaxForwards}<a name="line.122"></a> +<span class="sourceLineNo">123</span> * <li>{@link Pragma}<a name="line.123"></a> +<span class="sourceLineNo">124</span> * <li>{@link ProxyAuthorization}<a name="line.124"></a> +<span class="sourceLineNo">125</span> * <li>{@link Range}<a name="line.125"></a> +<span class="sourceLineNo">126</span> * <li>{@link Referer}<a name="line.126"></a> +<span class="sourceLineNo">127</span> * <li>{@link TE}<a name="line.127"></a> +<span class="sourceLineNo">128</span> * <li>{@link UserAgent}<a name="line.128"></a> +<span class="sourceLineNo">129</span> * <li>{@link Upgrade}<a name="line.129"></a> +<span class="sourceLineNo">130</span> * <li>{@link Via}<a name="line.130"></a> +<span class="sourceLineNo">131</span> * <li>{@link Warning}<a name="line.131"></a> +<span class="sourceLineNo">132</span> * <li>{@link TimeZone}<a name="line.132"></a> +<span class="sourceLineNo">133</span> * </ul><a name="line.133"></a> +<span class="sourceLineNo">134</span> * <li>Other objects:<a name="line.134"></a> +<span class="sourceLineNo">135</span> * <ul><a name="line.135"></a> +<span class="sourceLineNo">136</span> * <li>{@link ResourceBundle}<a name="line.136"></a> +<span class="sourceLineNo">137</span> * <li>{@link MessageBundle}<a name="line.137"></a> +<span class="sourceLineNo">138</span> * <li>{@link InputStream}<a name="line.138"></a> +<span class="sourceLineNo">139</span> * <li>{@link ServletInputStream}<a name="line.139"></a> +<span class="sourceLineNo">140</span> * <li>{@link Reader}<a name="line.140"></a> +<span class="sourceLineNo">141</span> * <li>{@link OutputStream}<a name="line.141"></a> +<span class="sourceLineNo">142</span> * <li>{@link ServletOutputStream}<a name="line.142"></a> +<span class="sourceLineNo">143</span> * <li>{@link Writer}<a name="line.143"></a> +<span class="sourceLineNo">144</span> * <li>{@link RequestHeaders}<a name="line.144"></a> +<span class="sourceLineNo">145</span> * <li>{@link RequestQuery}<a name="line.145"></a> +<span class="sourceLineNo">146</span> * <li>{@link RequestFormData}<a name="line.146"></a> +<span class="sourceLineNo">147</span> * <li>{@link HttpMethod}<a name="line.147"></a> +<span class="sourceLineNo">148</span> * <li>{@link Logger}<a name="line.148"></a> +<span class="sourceLineNo">149</span> * <li>{@link JuneauLogger}<a name="line.149"></a> +<span class="sourceLineNo">150</span> * <li>{@link RestContext}<a name="line.150"></a> +<span class="sourceLineNo">151</span> * <li>{@link org.apache.juneau.parser.Parser}<a name="line.151"></a> +<span class="sourceLineNo">152</span> * <li>{@link Locale}<a name="line.152"></a> +<span class="sourceLineNo">153</span> * <li>{@link Swagger}<a name="line.153"></a> +<span class="sourceLineNo">154</span> * <li>{@link RequestPathMatch}<a name="line.154"></a> +<span class="sourceLineNo">155</span> * <li>{@link RequestBody}<a name="line.155"></a> +<span class="sourceLineNo">156</span> * <li>{@link ConfigFile}<a name="line.156"></a> +<span class="sourceLineNo">157</span> * <li>{@link UriContext}<a name="line.157"></a> +<span class="sourceLineNo">158</span> * <li>{@link UriResolver}<a name="line.158"></a> +<span class="sourceLineNo">159</span> * </ul><a name="line.159"></a> +<span class="sourceLineNo">160</span> * </ul><a name="line.160"></a> +<span class="sourceLineNo">161</span> *<a name="line.161"></a> +<span class="sourceLineNo">162</span> * <h6 class='figure'>Example:</h6><a name="line.162"></a> +<span class="sourceLineNo">163</span> * <p class='bcode'><a name="line.163"></a> +<span class="sourceLineNo">164</span> * <ja>@RestResource</ja>(...)<a name="line.164"></a> +<span class="sourceLineNo">165</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.165"></a> +<span class="sourceLineNo">166</span> *<a name="line.166"></a> +<span class="sourceLineNo">167</span> * <jc>// Log the incoming request.</jc><a name="line.167"></a> +<span class="sourceLineNo">168</span> * <ja>@RestHook</ja>(<jsf>PRE_CALL</jsf>)<a name="line.168"></a> +<span class="sourceLineNo">169</span> * <jk>public void</jk> onPreCall(Accept accept, Logger logger) {<a name="line.169"></a> +<span class="sourceLineNo">170</span> * logger.fine(<js>"Accept {0} header found."</js>, accept);<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> * </p><a name="line.173"></a> +<span class="sourceLineNo">174</span> *<a name="line.174"></a> +<span class="sourceLineNo">175</span> * <h5 class='section'>Notes:</h5><a name="line.175"></a> +<span class="sourceLineNo">176</span> * <ul class='spaced-list'><a name="line.176"></a> +<span class="sourceLineNo">177</span> * <li>If the method returns any value, it is ignored.<a name="line.177"></a> +<span class="sourceLineNo">178</span> * <li>Multiple PRE_CALL methods can be defined on a class.<a name="line.178"></a> +<span class="sourceLineNo">179</span> * <br>PRE_CALL methods on parent classes are invoked before PRE_CALL methods on child classes.<a name="line.179"></a> +<span class="sourceLineNo">180</span> * <br>The order of PRE_CALL method invocations within a class is alphabetical, then by parameter count, then by parameter types.<a name="line.180"></a> +<span class="sourceLineNo">181</span> * <li>The method can throw any exception.<a name="line.181"></a> +<span class="sourceLineNo">182</span> * <br>{@link RestException RestExceptions} can be thrown to cause a particular HTTP error status code.<a name="line.182"></a> +<span class="sourceLineNo">183</span> * <br>All other exceptions cause an HTTP 500 error status code.<a name="line.183"></a> +<span class="sourceLineNo">184</span> * <li>Note that if you override a parent method, you probably need to call <code><jk>super</jk>.parentMethod(...)</code>.<a name="line.184"></a> +<span class="sourceLineNo">185</span> * <br>The method is still considered part of the parent class for ordering purposes even though it's<a name="line.185"></a> +<span class="sourceLineNo">186</span> * overridden by the child class.<a name="line.186"></a> +<span class="sourceLineNo">187</span> * <li>It's advisable not to mess around with the HTTP body itself since you may end up consuming the body<a name="line.187"></a> +<span class="sourceLineNo">188</span> * before the actual REST method has a chance to use it.<a name="line.188"></a> +<span class="sourceLineNo">189</span> * </ul><a name="line.189"></a> +<span class="sourceLineNo">190</span> */<a name="line.190"></a> +<span class="sourceLineNo">191</span> PRE_CALL,<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> * Identifies a method that gets called immediately after the <ja>@RestMethod</ja> annotated method gets called.<a name="line.194"></a> +<span class="sourceLineNo">195</span> *<a name="line.195"></a> +<span class="sourceLineNo">196</span> * <p><a name="line.196"></a> +<span class="sourceLineNo">197</span> * At this point, the output object returned by the method call has been set on the response, but<a name="line.197"></a> +<span class="sourceLineNo">198</span> * {@link RestConverter RestConverters} have not yet been executed and the response has not yet been written.<a name="line.198"></a> +<span class="sourceLineNo">199</span> *<a name="line.199"></a> +<span class="sourceLineNo">200</span> * <p><a name="line.200"></a> +<span class="sourceLineNo">201</span> * The list of valid parameter types are the same as {@link #PRE_CALL}.<a name="line.201"></a> +<span class="sourceLineNo">202</span> *<a name="line.202"></a> +<span class="sourceLineNo">203</span> * <h6 class='figure'>Example:</h6><a name="line.203"></a> +<span class="sourceLineNo">204</span> * <p class='bcode'><a name="line.204"></a> +<span class="sourceLineNo">205</span> * <ja>@RestResource</ja>(...)<a name="line.205"></a> +<span class="sourceLineNo">206</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.206"></a> +<span class="sourceLineNo">207</span> *<a name="line.207"></a> +<span class="sourceLineNo">208</span> * <jc>// Log the result of the request.</jc><a name="line.208"></a> +<span class="sourceLineNo">209</span> * <ja>@RestHook</ja>(<jsf>POST_CALL</jsf>)<a name="line.209"></a> +<span class="sourceLineNo">210</span> * <jk>public void</jk> onPostCall(RestResponse res, Logger logger) {<a name="line.210"></a> +<span class="sourceLineNo">211</span> * logger.fine(<js>Output {0} was set on the response."</js>, res.getOutput());<a name="line.211"></a> +<span class="sourceLineNo">212</span> * }<a name="line.212"></a> +<span class="sourceLineNo">213</span> * }<a name="line.213"></a> +<span class="sourceLineNo">214</span> * </p><a name="line.214"></a> +<span class="sourceLineNo">215</span> *<a name="line.215"></a> +<span class="sourceLineNo">216</span> * <h5 class='section'>Notes:</h5><a name="line.216"></a> +<span class="sourceLineNo">217</span> * <ul class='spaced-list'><a name="line.217"></a> +<span class="sourceLineNo">218</span> * <li>If the method returns any value, it is ignored.<a name="line.218"></a> +<span class="sourceLineNo">219</span> * <li>Multiple POST_CALL methods can be defined on a class.<a name="line.219"></a> +<span class="sourceLineNo">220</span> * <br>POST_CALL methods on parent classes are invoked before POST_CALL methods on child classes.<a name="line.220"></a> +<span class="sourceLineNo">221</span> * <br>The order of POST_CALL method invocations within a class is alphabetical, then by parameter count, then by parameter types.<a name="line.221"></a> +<span class="sourceLineNo">222</span> * <li>The method can throw any exception, although at this point it is too late to set an HTTP error status code.<a name="line.222"></a> +<span class="sourceLineNo">223</span> * <li>Note that if you override a parent method, you probably need to call <code><jk>super</jk>.parentMethod(...)</code>.<a name="line.223"></a> +<span class="sourceLineNo">224</span> * <br>The method is still considered part of the parent class for ordering purposes even though it's<a name="line.224"></a> +<span class="sourceLineNo">225</span> * overridden by the child class.<a name="line.225"></a> +<span class="sourceLineNo">226</span> * </ul><a name="line.226"></a> +<span class="sourceLineNo">227</span> */<a name="line.227"></a> +<span class="sourceLineNo">228</span> POST_CALL,<a name="line.228"></a> +<span class="sourceLineNo">229</span><a name="line.229"></a> +<span class="sourceLineNo">230</span> /**<a name="line.230"></a> +<span class="sourceLineNo">231</span> * Identifies a method that gets called right before we exit the servlet service method.<a name="line.231"></a> +<span class="sourceLineNo">232</span> *<a name="line.232"></a> +<span class="sourceLineNo">233</span> * <p><a name="line.233"></a> +<span class="sourceLineNo">234</span> * At this point, the output has been written and flushed.<a name="line.234"></a> +<span class="sourceLineNo">235</span> *<a name="line.235"></a> +<span class="sourceLineNo">236</span> * <p><a name="line.236"></a> +<span class="sourceLineNo">237</span> * The list of valid parameter types are as follows:<a name="line.237"></a> +<span class="sourceLineNo">238</span> * <ul><a name="line.238"></a> +<span class="sourceLineNo">239</span> * <li>Servlet request/response objects:<a name="line.239"></a> +<span class="sourceLineNo">240</span> * <ul><a name="line.240"></a> +<span class="sourceLineNo">241</span> * <li>{@link HttpServletRequest}<a name="line.241"></a> +<span class="sourceLineNo">242</span> * <li>{@link HttpServletResponse}<a name="line.242"></a> +<span class="sourceLineNo">243</span> * </ul><a name="line.243"></a> +<span class="sourceLineNo">244</span> * </ul><a name="line.244"></a> +<span class="sourceLineNo">245</span> *<a name="line.245"></a> +<span class="sourceLineNo">246</span> * <p><a name="line.246"></a> +<span class="sourceLineNo">247</span> * The following attributes are set on the {@link HttpServletRequest} object that can be useful for logging purposes:<a name="line.247"></a> +<span class="sourceLineNo">248</span> * <ul><a name="line.248"></a> +<span class="sourceLineNo">249</span> * <li><js>"Exception"</js> - Any exceptions thrown during the request.<a name="line.249"></a> +<span class="sourceLineNo">250</span> * <li><js>"ExecTime"</js> - Execution time of the request.<a name="line.250"></a> +<span class="sourceLineNo">251</span> * </ul><a name="line.251"></a> +<span class="sourceLineNo">252</span> *<a name="line.252"></a> +<span class="sourceLineNo">253</span> * <h6 class='figure'>Example:</h6><a name="line.253"></a> +<span class="sourceLineNo">254</span> * <p class='bcode'><a name="line.254"></a> +<span class="sourceLineNo">255</span> * <ja>@RestResource</ja>(...)<a name="line.255"></a> +<span class="sourceLineNo">256</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.256"></a> +<span class="sourceLineNo">257</span> *<a name="line.257"></a> +<span class="sourceLineNo">258</span> * <jc>// Log the time it took to execute the request.</jc><a name="line.258"></a> +<span class="sourceLineNo">259</span> * <ja>@RestHook</ja>(<jsf>END_CALL</jsf>)<a name="line.259"></a> +<span class="sourceLineNo">260</span> * <jk>public void</jk> onEndCall(RestRequest req, Logger logger) {<a name="line.260"></a> +<span class="sourceLineNo">261</span> * Exception e = (Exception)req.getAttribute(<js>"Exception"</js>);<a name="line.261"></a> +<span class="sourceLineNo">262</span> * Long execTime = (Long)req.getAttribute(<js>"ExecTime"</js>);<a name="line.262"></a> +<span class="sourceLineNo">263</span> * <jk>if</jk> (e != <jk>null</jk>)<a name="line.263"></a> +<span class="sourceLineNo">264</span> * logger.warn(e, <js>"Request failed in {0}ms."</js>, execTime);<a name="line.264"></a> +<span class="sourceLineNo">265</span> * <jk>else</jk><a name="line.265"></a> +<span class="sourceLineNo">266</span> * logger.fine(<js>"Request finished in {0}ms."</js>, execTime);<a name="line.266"></a> +<span class="sourceLineNo">267</span> * }<a name="line.267"></a> +<span class="sourceLineNo">268</span> * }<a name="line.268"></a> +<span class="sourceLineNo">269</span> * </p><a name="line.269"></a> +<span class="sourceLineNo">270</span> *<a name="line.270"></a> +<span class="sourceLineNo">271</span> * <h5 class='section'>Notes:</h5><a name="line.271"></a> +<span class="sourceLineNo">272</span> * <ul class='spaced-list'><a name="line.272"></a> +<span class="sourceLineNo">273</span> * <li>If the method returns any value, it is ignored.<a name="line.273"></a> +<span class="sourceLineNo">274</span> * <li>Multiple END_CALL methods can be defined on a class.<a name="line.274"></a> +<span class="sourceLineNo">275</span> * <br>END_CALL methods on parent classes are invoked before END_CALL methods on child classes.<a name="line.275"></a> +<span class="sourceLineNo">276</span> * <br>The order of END_CALL method invocations within a class is alphabetical, then by parameter count, then by parameter types.<a name="line.276"></a> +<span class="sourceLineNo">277</span> * <li>The method can throw any exception, although at this point it is too late to set an HTTP error status code.<a name="line.277"></a> +<span class="sourceLineNo">278</span> * <li>Note that if you override a parent method, you probably need to call <code><jk>super</jk>.parentMethod(...)</code>.<a name="line.278"></a> +<span class="sourceLineNo">279</span> * <br>The method is still considered part of the parent class for ordering purposes even though it's<a name="line.279"></a> +<span class="sourceLineNo">280</span> * overridden by the child class.<a name="line.280"></a> +<span class="sourceLineNo">281</span> * </ul><a name="line.281"></a> +<span class="sourceLineNo">282</span> */<a name="line.282"></a> +<span class="sourceLineNo">283</span> END_CALL,<a name="line.283"></a> +<span class="sourceLineNo">284</span><a name="line.284"></a> +<span class="sourceLineNo">285</span> /**<a name="line.285"></a> +<span class="sourceLineNo">286</span> * Identifies a method that gets called during servlet initialization.<a name="line.286"></a> +<span class="sourceLineNo">287</span> *<a name="line.287"></a> +<span class="sourceLineNo">288</span> * <p><a name="line.288"></a> +<span class="sourceLineNo">289</span> * This method is called from within the {@link Servlet#init(ServletConfig)} method after the {@link RestConfig}<a name="line.289"></a> +<span class="sourceLineNo">290</span> * object has been created and initialized with the annotations defined on the class, but before the<a name="line.290"></a> +<span class="sourceLineNo">291</span> * {@link RestContext} object has been created.<a name="line.291"></a> +<span class="sourceLineNo">292</span> *<a name="line.292"></a> +<span class="sourceLineNo">293</span> * <p><a name="line.293"></a> +<span class="sourceLineNo">294</span> * The only valid parameter type for this method is {@link RestConfig} which can be used to configure the servlet.<a name="line.294"></a> +<span class="sourceLineNo">295</span> *<a name="line.295"></a> +<span class="sourceLineNo">296</span> * <p><a name="line.296"></a> +<span class="sourceLineNo">297</span> * An example of this is the <code>PetStoreResource</code> class that uses an init method to perform initialization<a name="line.297"></a> +<span class="sourceLineNo">298</span> * of an internal data structure.<a name="line.298"></a> +<span class="sourceLineNo">299</span> *<a name="line.299"></a> +<span class="sourceLineNo">300</span> * <h6 class='figure'>Example:</h6><a name="line.300"></a> +<span class="sourceLineNo">301</span> * <p class='bcode'><a name="line.301"></a> +<span class="sourceLineNo">302</span> * <ja>@RestResource</ja>(...)<a name="line.302"></a> +<span class="sourceLineNo">303</span> * <jk>public class</jk> PetStoreResource <jk>extends</jk> ResourceJena {<a name="line.303"></a> +<span class="sourceLineNo">304</span> *<a name="line.304"></a> +<span class="sourceLineNo">305</span> * <jc>// Our database.</jc><a name="line.305"></a> +<span class="sourceLineNo">306</span> * <jk>private</jk> Map<Integer,Pet> <jf>petDB</jf>;<a name="line.306"></a> +<span class="sourceLineNo">307</span> *<a name="line.307"></a> +<span class="sourceLineNo">308</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.308"></a> +<span class="sourceLineNo">309</span> * <jk>public void</jk> onInit(RestConfig config) <jk>throws</jk> Exception {<a name="line.309"></a> +<span class="sourceLineNo">310</span> * <jc>// Load our database from a local JSON file.</jc><a name="line.310"></a> +<span class="sourceLineNo">311</span> * <jf>petDB</jf> = JsonParser.<jsf>DEFAULT</jsf>.parse(getClass().getResourceAsStream(<js>"PetStore.json"</js>), LinkedHashMap.<jk>class</jk>, Integer.<jk>class</jk>, Pet.<jk>class</jk>);<a name="line.311"></a> +<span class="sourceLineNo">312</span> * }<a name="line.312"></a> +<span class="sourceLineNo">313</span> * }<a name="line.313"></a> +<span class="sourceLineNo">314</span> * </p><a name="line.314"></a> +<span class="sourceLineNo">315</span> *<a name="line.315"></a> +<span class="sourceLineNo">316</span> * <h5 class='section'>Notes:</h5><a name="line.316"></a> +<span class="sourceLineNo">317</span> * <ul class='spaced-list'><a name="line.317"></a> +<span class="sourceLineNo">318</span> * <li>If the method returns any value, it is ignored.<a name="line.318"></a> +<span class="sourceLineNo">319</span> * <li>Multiple INIT methods can be defined on a class.<a name="line.319"></a> +<span class="sourceLineNo">320</span> * <br>INIT methods on parent classes are invoked before INIT methods on child classes.<a name="line.320"></a> +<span class="sourceLineNo">321</span> * <br>The order of INIT method invocations within a class is alphabetical, then by parameter count, then by parameter types.<a name="line.321"></a> +<span class="sourceLineNo">322</span> * <li>The method can throw any exception causing initialization of the servlet to fail.<a name="line.322"></a> +<span class="sourceLineNo">323</span> * <li>Note that if you override a parent method, you probably need to call <code><jk>super</jk>.parentMethod(...)</code>.<a name="line.323"></a> +<span class="sourceLineNo">324</span> * <br>The method is still considered part of the parent class for ordering purposes even though it's<a name="line.324"></a> +<span class="sourceLineNo">325</span> * overridden by the child class.<a name="line.325"></a> +<span class="sourceLineNo">326</span> * </ul><a name="line.326"></a> +<span class="sourceLineNo">327</span> */<a name="line.327"></a> +<span class="sourceLineNo">328</span> INIT,<a name="line.328"></a> +<span class="sourceLineNo">329</span><a name="line.329"></a> +<span class="sourceLineNo">330</span> /**<a name="line.330"></a> +<span class="sourceLineNo">331</span> * Identifies a method that gets called immediately after servlet initialization.<a name="line.331"></a> +<span class="sourceLineNo">332</span> *<a name="line.332"></a> +<span class="sourceLineNo">333</span> * <p><a name="line.333"></a> +<span class="sourceLineNo">334</span> * This method is called from within the {@link Servlet#init(ServletConfig)} method after the {@link RestContext}<a name="line.334"></a> +<span class="sourceLineNo">335</span> * object has been created.<a name="line.335"></a> +<span class="sourceLineNo">336</span> *<a name="line.336"></a> +<span class="sourceLineNo">337</span> * <p><a name="line.337"></a> +<span class="sourceLineNo">338</span> * The only valid parameter type for this method is {@link RestContext} which can be used to retrieve information<a name="line.338"></a> +<span class="sourceLineNo">339</span> * about the servlet.<a name="line.339"></a> +<span class="sourceLineNo">340</span> *<a name="line.340"></a> +<span class="sourceLineNo">341</span> * <h5 class='section'>Notes:</h5><a name="line.341"></a> +<span class="sourceLineNo">342</span> * <ul class='spaced-list'><a name="line.342"></a> +<span class="sourceLineNo">343</span> * <li>If the method returns any value, it is ignored.<a name="line.343"></a> +<span class="sourceLineNo">344</span> * <li>Multiple POST_INIT methods can be defined on a class.<a name="line.344"></a> +<span class="sourceLineNo">345</span> * <br>POST_INIT methods on parent classes are invoked before POST_INIT methods on child classes.<a name="line.345"></a> +<span class="sourceLineNo">346</span> * <br>The order of POST_INIT method invocations within a class is alphabetical, then by parameter count, then by parameter types.<a name="line.346"></a> +<span class="sourceLineNo">347</span> * <li>The method can throw any exception causing initialization of the servlet to fail.<a name="line.347"></a> +<span class="sourceLineNo">348</span> * <li>Note that if you override a parent method, you probably need to call <code><jk>super</jk>.parentMethod(...)</code>.<a name="line.348"></a> +<span class="sourceLineNo">349</span> * <br>The method is still considered part of the parent class for ordering purposes even though it's<a name="line.349"></a> +<span class="sourceLineNo">350</span> * overridden by the child class.<a name="line.350"></a> +<span class="sourceLineNo">351</span> * </ul><a name="line.351"></a> +<span class="sourceLineNo">352</span> */<a name="line.352"></a> +<span class="sourceLineNo">353</span> POST_INIT,<a name="line.353"></a> +<span class="sourceLineNo">354</span><a name="line.354"></a> +<span class="sourceLineNo">355</span> /**<a name="line.355"></a> +<span class="sourceLineNo">356</span> * Identical to {@link #POST_INIT} except the order of execution is child-resources first.<a name="line.356"></a> +<span class="sourceLineNo">357</span> *<a name="line.357"></a> +<span class="sourceLineNo">358</span> * <p><a name="line.358"></a> +<span class="sourceLineNo">359</span> * Use this annotation if you need to perform any kind of initialization on child resources before the parent resource.<a name="line.359"></a> +<span class="sourceLineNo">360</span> *<a name="line.360"></a> +<span class="sourceLineNo">361</span> * <p><a name="line.361"></a> +<span class="sourceLineNo">362</span> * This method is called from within the {@link Servlet#init(ServletConfig)} method after the {@link RestContext}<a name="line.362"></a> +<span class="sourceLineNo">363</span> * object has been created and after the {@link #POST_INIT} methods have been called.<a name="line.363"></a> +<span class="sourceLineNo">364</span> *<a name="line.364"></a> +<span class="sourceLineNo">365</span> * <p><a name="line.365"></a> +<span class="sourceLineNo">366</span> * The only valid parameter type for this method is {@link RestContext} which can be used to retrieve information<a name="line.366"></a> +<span class="sourceLineNo">367</span> * about the servlet.<a name="line.367"></a> +<span class="sourceLineNo">368</span> *<a name="line.368"></a> +<span class="sourceLineNo">369</span> * <h5 class='section'>Notes:</h5><a name="line.369"></a> +<span class="sourceLineNo">370</span> * <ul class='spaced-list'><a name="line.370"></a> +<span class="sourceLineNo">371</span> * <li>If the method returns any value, it is ignored.<a name="line.371"></a> +<span class="sourceLineNo">372</span> * <li>Multiple POST_INIT_CHILD_FIRST methods can be defined on a class.<a name="line.372"></a> +<span class="sourceLineNo">373</span> * <br>POST_INIT_CHILD_FIRST methods on parent classes are invoked before POST_INIT_CHILD_FIRST methods on child classes.<a name="line.373"></a> +<span class="sourceLineNo">374</span> * <br>The order of POST_INIT_CHILD_FIRST method invocations within a class is alphabetical, then by parameter count, then by parameter types.<a name="line.374"></a> +<span class="sourceLineNo">375</span> * <li>The method can throw any exception causing initialization of the servlet to fail.<a name="line.375"></a> +<span class="sourceLineNo">376</span> * </ul><a name="line.376"></a> +<span class="sourceLineNo">377</span> */<a name="line.377"></a> +<span class="sourceLineNo">378</span> POST_INIT_CHILD_FIRST,<a name="line.378"></a> +<span class="sourceLineNo">379</span><a name="line.379"></a> +<span class="sourceLineNo">380</span> /**<a name="line.380"></a> +<span class="sourceLineNo">381</span> * Identifies a method that gets called during servlet destroy.<a name="line.381"></a> +<span class="sourceLineNo">382</span> *<a name="line.382"></a> +<span class="sourceLineNo">383</span> * <p><a name="line.383"></a> +<span class="sourceLineNo">384</span> * This method is called from within the {@link Servlet#destroy()}.<a name="line.384"></a> +<span class="sourceLineNo">385</span> *<a name="line.385"></a> +<span class="sourceLineNo">386</span> * <p><a name="line.386"></a> +<span class="sourceLineNo">387</span> * The only valid parameter type for this method is {@link RestContext}, although typically no arguments will<a name="line.387"></a> +<span class="sourceLineNo">388</span> * be specified.<a name="line.388"></a> +<span class="sourceLineNo">389</span> *<a name="line.389"></a> +<span class="sourceLineNo">390</span> * <h6 class='figure'>Example:</h6><a name="line.390"></a> +<span class="sourceLineNo">391</span> * <p class='bcode'><a name="line.391"></a> +<span class="sourceLineNo">392</span> * <ja>@RestResource</ja>(...)<a name="line.392"></a> +<span class="sourceLineNo">393</span> * <jk>public class</jk> PetStoreResource <jk>extends</jk> ResourceJena {<a name="line.393"></a> +<span class="sourceLineNo">394</span> *<a name="line.394"></a> +<span class="sourceLineNo">395</span> * <jc>// Our database.</jc><a name="line.395"></a> +<span class="sourceLineNo">396</span> * <jk>private</jk> Map<Integer,Pet> <jf>petDB</jf>;<a name="line.396"></a> +<span class="sourceLineNo">397</span> *<a name="line.397"></a> +<span class="sourceLineNo">398</span> * <ja>@RestHook</ja>(<jsf>DESTROY</jsf>)<a name="line.398"></a> +<span class="sourceLineNo">399</span> * <jk>public void</jk> onDestroy() {<a name="line.399"></a> +<span class="sourceLineNo">400</span> * <jf>petDB</jf> = <jk>null</jk>;<a name="line.400"></a> +<span class="sourceLineNo">401</span> * }<a name="line.401"></a> +<span class="sourceLineNo">402</span> * }<a name="line.402"></a> +<span class="sourceLineNo">403</span> * </p><a name="line.403"></a> +<span class="sourceLineNo">404</span> *<a name="line.404"></a> +<span class="sourceLineNo">405</span> * <h5 class='section'>Notes:</h5><a name="line.405"></a> +<span class="sourceLineNo">406</span> * <ul class='spaced-list'><a name="line.406"></a> +<span class="sourceLineNo">407</span> * <li>If the method returns any value, it is ignored.<a name="line.407"></a> +<span class="sourceLineNo">408</span> * <li>Multiple DESTROY methods can be defined on a class.<a name="line.408"></a> +<span class="sourceLineNo">409</span> * <br>DESTROY methods on child classes are invoked before DESTROY methods on parent classes.<a name="line.409"></a> +<span class="sourceLineNo">410</span> * <br>The order of DESTROY method invocations within a class is alphabetical, then by parameter count, then by parameter types.<a name="line.410"></a> +<span class="sourceLineNo">411</span> * <li>In general, destroy methods should not throw any exceptions, although if any are thrown, the stack trace will be<a name="line.411"></a> +<span class="sourceLineNo">412</span> * printed to <code>System.err</code>.<a name="line.412"></a> +<span class="sourceLineNo">413</span> * <li>Note that if you override a parent method, you probably need to call <code><jk>super</jk>.parentMethod(...)</code>.<a name="line.413"></a> +<span class="sourceLineNo">414</span> * <br>The method is still considered part of the parent class for ordering purposes even though it's<a name="line.414"></a> +<span class="sourceLineNo">415</span> * overridden by the child class.<a name="line.415"></a> +<span class="sourceLineNo">416</span> * </ul><a name="line.416"></a> +<span class="sourceLineNo">417</span> */<a name="line.417"></a> +<span class="sourceLineNo">418</span> DESTROY<a name="line.418"></a> +<span class="sourceLineNo">419</span>}<a name="line.419"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/84931d4d/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestHook.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestHook.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestHook.html new file mode 100644 index 0000000..5d8409d --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestHook.html @@ -0,0 +1,158 @@ +<!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.annotation;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import static java.lang.annotation.ElementType.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import static java.lang.annotation.RetentionPolicy.*;<a name="line.16"></a> +<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> * Identifies Java methods on a resource/servlet class that get invoked during particular lifecycle events of<a name="line.21"></a> +<span class="sourceLineNo">022</span> * the servlet or REST call.<a name="line.22"></a> +<span class="sourceLineNo">023</span> *<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> +<span class="sourceLineNo">025</span> * For example, if you want to add an initialization method to your resource:<a name="line.25"></a> +<span class="sourceLineNo">026</span> * <p class='bcode'><a name="line.26"></a> +<span class="sourceLineNo">027</span> * <ja>@RestResource</ja>(...)<a name="line.27"></a> +<span class="sourceLineNo">028</span> * <jk>public class</jk> MyResource {<a name="line.28"></a> +<span class="sourceLineNo">029</span> *<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <jc>// Our database.</jc><a name="line.30"></a> +<span class="sourceLineNo">031</span> * <jk>private</jk> Map&lt;Integer,Object&gt; <jf>myDatabase</jf>;<a name="line.31"></a> +<span class="sourceLineNo">032</span> *<a name="line.32"></a> +<span class="sourceLineNo">033</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.33"></a> +<span class="sourceLineNo">034</span> * <jk>public void</jk> initMyDatabase(RestConfig config) <jk>throws</jk> Exception {<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <jf>myDatabase</jf> = <jk>new</jk> LinkedHashMap&lt;&gt;();<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> * </p><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> * Or if you want to intercept REST calls:<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <p class='bcode'><a name="line.42"></a> +<span class="sourceLineNo">043</span> * <ja>@RestResource</ja>(...)<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <jk>public class</jk> MyResource {<a name="line.44"></a> +<span class="sourceLineNo">045</span> *<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <jc>// Add a request attribute to all incoming requests.</jc><a name="line.46"></a> +<span class="sourceLineNo">047</span> * <ja>@RestHook</ja>(<jsf>PRE_CALL</jsf>)<a name="line.47"></a> +<span class="sourceLineNo">048</span> * <jk>public void</jk> onPreCall(RestRequest req) {<a name="line.48"></a> +<span class="sourceLineNo">049</span> * req.setAttribute(<js>"foo"</js>, <js>"bar"</js>);<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> * </p><a name="line.52"></a> +<span class="sourceLineNo">053</span> *<a name="line.53"></a> +<span class="sourceLineNo">054</span> * <p><a name="line.54"></a> +<span class="sourceLineNo">055</span> * The hook events can be broken down into two categories:<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <ul class='spaced-list'><a name="line.56"></a> +<span class="sourceLineNo">057</span> * <li>Resource lifecycle events:<a name="line.57"></a> +<span class="sourceLineNo">058</span> * <ul><a name="line.58"></a> +<span class="sourceLineNo">059</span> * <li>{@link HookEvent#INIT INIT} - Right before initialization.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <li>{@link HookEvent#POST_INIT POST_INIT} - Right after initialization.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * <li>{@link HookEvent#POST_INIT_CHILD_FIRST POST_INIT_CHILD_FIRST} - Right after initialization, but run child methods first.<a name="line.61"></a> +<span class="sourceLineNo">062</span> * <li>{@link HookEvent#DESTROY DESTROY} - Right before servlet destroy.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * </ul><a name="line.63"></a> +<span class="sourceLineNo">064</span> * <li>REST call lifecycle events:<a name="line.64"></a> +<span class="sourceLineNo">065</span> * <ul><a name="line.65"></a> +<span class="sourceLineNo">066</span> * <li>{@link HookEvent#START_CALL START_CALL} - At the beginning of a REST call.<a name="line.66"></a> +<span class="sourceLineNo">067</span> * <li>{@link HookEvent#PRE_CALL PRE_CALL} - Right before the <ja>@RestMethod</ja> method is invoked.<a name="line.67"></a> +<span class="sourceLineNo">068</span> * <li>{@link HookEvent#POST_CALL POST_CALL} - Right after the <ja>@RestMethod</ja> method is invoked.<a name="line.68"></a> +<span class="sourceLineNo">069</span> * <li>{@link HookEvent#END_CALL END_CALL} - At the end of the REST call after the response has been flushed.<a name="line.69"></a> +<span class="sourceLineNo">070</span> * </ul><a name="line.70"></a> +<span class="sourceLineNo">071</span> * </ul><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> * See the {@link HookEvent} class for information about individual event types.<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(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 RestHook {<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 lifecycle event.<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> HookEvent value();<a name="line.85"></a> +<span class="sourceLineNo">086</span>}<a name="line.86"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/84931d4d/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html b/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html index 0da3e55..4a00f88 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/jena/RestServletJenaDefault.html @@ -258,7 +258,7 @@ <span class="sourceLineNo">250</span> "<h2>$R{methodSummary,$R{servletDescription}}</h2>",<a name="line.250"></a> <span class="sourceLineNo">251</span> "<a href='http://juneau.apache.org'><img src='$U{servlet:/htdocs/juneau.png}' style='position:absolute;top:5;right:5;background-color:transparent;height:30px'/></a>"<a name="line.251"></a> <span class="sourceLineNo">252</span> },<a name="line.252"></a> -<span class="sourceLineNo">253</span> stylesheet="servlet:/styles/devops.css"<a name="line.253"></a> +<span class="sourceLineNo">253</span> stylesheet="servlet:/styles/light.css"<a name="line.253"></a> <span class="sourceLineNo">254</span> ),<a name="line.254"></a> <span class="sourceLineNo">255</span> favicon="htdocs/juneau.png",<a name="line.255"></a> <span class="sourceLineNo">256</span> staticFiles="{htdocs:'htdocs',styles:'styles'}"<a name="line.256"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/84931d4d/content/site/apidocs/src-html/org/apache/juneau/rest/widget/StyleMenuItem.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/StyleMenuItem.html b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/StyleMenuItem.html index 7d1ebb0..1c7ca2e 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/widget/StyleMenuItem.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/widget/StyleMenuItem.html @@ -58,7 +58,7 @@ <span class="sourceLineNo">050</span> */<a name="line.50"></a> <span class="sourceLineNo">051</span>public class StyleMenuItem extends MenuItemWidget {<a name="line.51"></a> <span class="sourceLineNo">052</span><a name="line.52"></a> -<span class="sourceLineNo">053</span> private static final String[] BUILT_IN_STYLES = {"devops", "light", "original"};<a name="line.53"></a> +<span class="sourceLineNo">053</span> private static final String[] BUILT_IN_STYLES = {"devops", "light", "original", "dark"};<a name="line.53"></a> <span class="sourceLineNo">054</span><a name="line.54"></a> <span class="sourceLineNo">055</span> @Override /* MenuItemWidget */<a name="line.55"></a> <span class="sourceLineNo">056</span> public String getLabel(RestRequest req) {<a name="line.56"></a>
