http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/content/site/apidocs/src-html/org/apache/juneau/rest/RestServletDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestServletDefault.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestServletDefault.html index 8045c44..ee0cb53 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/RestServletDefault.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestServletDefault.html @@ -20,206 +20,199 @@ <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.html.HtmlDocSerializerContext.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span>import static org.apache.juneau.rest.RestContext.*;<a name="line.16"></a> -<span class="sourceLineNo">017</span><a name="line.17"></a> -<span class="sourceLineNo">018</span>import org.apache.juneau.dto.swagger.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span>import org.apache.juneau.html.*;<a name="line.19"></a> -<span class="sourceLineNo">020</span>import org.apache.juneau.jso.*;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.json.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.juneau.msgpack.*;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.juneau.plaintext.*;<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.soap.*;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.juneau.uon.*;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.juneau.urlencoding.*;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.juneau.xml.*;<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> * Subclass of {@link RestServlet} with default serializers and parsers defined.<a name="line.31"></a> -<span class="sourceLineNo">032</span> * <p><a name="line.32"></a> -<span class="sourceLineNo">033</span> * Supports the following request <code>Accept</code> header values with the resulting response <code>Content-Type</code>:<a name="line.33"></a> -<span class="sourceLineNo">034</span> * </p><a name="line.34"></a> -<span class="sourceLineNo">035</span> * <table class='styled'><a name="line.35"></a> -<span class="sourceLineNo">036</span> * <tr><a name="line.36"></a> -<span class="sourceLineNo">037</span> * <th>Accept</th><a name="line.37"></a> -<span class="sourceLineNo">038</span> * <th>Content-Type</th><a name="line.38"></a> -<span class="sourceLineNo">039</span> * <th>Serializer</th><a name="line.39"></a> -<span class="sourceLineNo">040</span> * </tr><a name="line.40"></a> -<span class="sourceLineNo">041</span> * <tr><a name="line.41"></a> -<span class="sourceLineNo">042</span> * <td class='code'>application/json<br>text/json</td><a name="line.42"></a> -<span class="sourceLineNo">043</span> * <td class='code'>application/json</td><a name="line.43"></a> -<span class="sourceLineNo">044</span> * <td>{@link JsonSerializer}</td><a name="line.44"></a> -<span class="sourceLineNo">045</span> * </tr><a name="line.45"></a> -<span class="sourceLineNo">046</span> * <tr><a name="line.46"></a> -<span class="sourceLineNo">047</span> * <td class='code'>application/json+simple<br>text/json+simple</td><a name="line.47"></a> -<span class="sourceLineNo">048</span> * <td class='code'>application/json</td><a name="line.48"></a> -<span class="sourceLineNo">049</span> * <td>{@link org.apache.juneau.json.JsonSerializer.Simple}</td><a name="line.49"></a> -<span class="sourceLineNo">050</span> * </tr><a name="line.50"></a> -<span class="sourceLineNo">051</span> * <tr><a name="line.51"></a> -<span class="sourceLineNo">052</span> * <td class='code'>application/json+schema<br>text/json+schema</td><a name="line.52"></a> -<span class="sourceLineNo">053</span> * <td class='code'>application/json</td><a name="line.53"></a> -<span class="sourceLineNo">054</span> * <td>{@link JsonSchemaSerializer}</td><a name="line.54"></a> -<span class="sourceLineNo">055</span> * </tr><a name="line.55"></a> -<span class="sourceLineNo">056</span> * <tr><a name="line.56"></a> +<span class="sourceLineNo">015</span>import static org.apache.juneau.rest.RestContext.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span><a name="line.16"></a> +<span class="sourceLineNo">017</span>import org.apache.juneau.dto.swagger.*;<a name="line.17"></a> +<span class="sourceLineNo">018</span>import org.apache.juneau.html.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.jso.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.json.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.juneau.msgpack.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.plaintext.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.juneau.rest.annotation.*;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.juneau.soap.*;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.juneau.uon.*;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.juneau.urlencoding.*;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.juneau.xml.*;<a name="line.27"></a> +<span class="sourceLineNo">028</span><a name="line.28"></a> +<span class="sourceLineNo">029</span>/**<a name="line.29"></a> +<span class="sourceLineNo">030</span> * Subclass of {@link RestServlet} with default serializers and parsers defined.<a name="line.30"></a> +<span class="sourceLineNo">031</span> * <p><a name="line.31"></a> +<span class="sourceLineNo">032</span> * Supports the following request <code>Accept</code> header values with the resulting response <code>Content-Type</code>:<a name="line.32"></a> +<span class="sourceLineNo">033</span> * </p><a name="line.33"></a> +<span class="sourceLineNo">034</span> * <table class='styled'><a name="line.34"></a> +<span class="sourceLineNo">035</span> * <tr><a name="line.35"></a> +<span class="sourceLineNo">036</span> * <th>Accept</th><a name="line.36"></a> +<span class="sourceLineNo">037</span> * <th>Content-Type</th><a name="line.37"></a> +<span class="sourceLineNo">038</span> * <th>Serializer</th><a name="line.38"></a> +<span class="sourceLineNo">039</span> * </tr><a name="line.39"></a> +<span class="sourceLineNo">040</span> * <tr><a name="line.40"></a> +<span class="sourceLineNo">041</span> * <td class='code'>application/json<br>text/json</td><a name="line.41"></a> +<span class="sourceLineNo">042</span> * <td class='code'>application/json</td><a name="line.42"></a> +<span class="sourceLineNo">043</span> * <td>{@link JsonSerializer}</td><a name="line.43"></a> +<span class="sourceLineNo">044</span> * </tr><a name="line.44"></a> +<span class="sourceLineNo">045</span> * <tr><a name="line.45"></a> +<span class="sourceLineNo">046</span> * <td class='code'>application/json+simple<br>text/json+simple</td><a name="line.46"></a> +<span class="sourceLineNo">047</span> * <td class='code'>application/json</td><a name="line.47"></a> +<span class="sourceLineNo">048</span> * <td>{@link org.apache.juneau.json.JsonSerializer.Simple}</td><a name="line.48"></a> +<span class="sourceLineNo">049</span> * </tr><a name="line.49"></a> +<span class="sourceLineNo">050</span> * <tr><a name="line.50"></a> +<span class="sourceLineNo">051</span> * <td class='code'>application/json+schema<br>text/json+schema</td><a name="line.51"></a> +<span class="sourceLineNo">052</span> * <td class='code'>application/json</td><a name="line.52"></a> +<span class="sourceLineNo">053</span> * <td>{@link JsonSchemaSerializer}</td><a name="line.53"></a> +<span class="sourceLineNo">054</span> * </tr><a name="line.54"></a> +<span class="sourceLineNo">055</span> * <tr><a name="line.55"></a> +<span class="sourceLineNo">056</span> * <td class='code'>text/xml</td><a name="line.56"></a> <span class="sourceLineNo">057</span> * <td class='code'>text/xml</td><a name="line.57"></a> -<span class="sourceLineNo">058</span> * <td class='code'>text/xml</td><a name="line.58"></a> -<span class="sourceLineNo">059</span> * <td>{@link XmlDocSerializer}</td><a name="line.59"></a> -<span class="sourceLineNo">060</span> * </tr><a name="line.60"></a> -<span class="sourceLineNo">061</span> * <tr><a name="line.61"></a> -<span class="sourceLineNo">062</span> * <td class='code'>text/xml+schema</td><a name="line.62"></a> -<span class="sourceLineNo">063</span> * <td class='code'>text/xml</td><a name="line.63"></a> -<span class="sourceLineNo">064</span> * <td>{@link XmlSchemaDocSerializer}</td><a name="line.64"></a> -<span class="sourceLineNo">065</span> * </tr><a name="line.65"></a> -<span class="sourceLineNo">066</span> * <tr><a name="line.66"></a> +<span class="sourceLineNo">058</span> * <td>{@link XmlDocSerializer}</td><a name="line.58"></a> +<span class="sourceLineNo">059</span> * </tr><a name="line.59"></a> +<span class="sourceLineNo">060</span> * <tr><a name="line.60"></a> +<span class="sourceLineNo">061</span> * <td class='code'>text/xml+schema</td><a name="line.61"></a> +<span class="sourceLineNo">062</span> * <td class='code'>text/xml</td><a name="line.62"></a> +<span class="sourceLineNo">063</span> * <td>{@link XmlSchemaDocSerializer}</td><a name="line.63"></a> +<span class="sourceLineNo">064</span> * </tr><a name="line.64"></a> +<span class="sourceLineNo">065</span> * <tr><a name="line.65"></a> +<span class="sourceLineNo">066</span> * <td class='code'>text/html</td><a name="line.66"></a> <span class="sourceLineNo">067</span> * <td class='code'>text/html</td><a name="line.67"></a> -<span class="sourceLineNo">068</span> * <td class='code'>text/html</td><a name="line.68"></a> -<span class="sourceLineNo">069</span> * <td>{@link HtmlDocSerializer}</td><a name="line.69"></a> -<span class="sourceLineNo">070</span> * </tr><a name="line.70"></a> -<span class="sourceLineNo">071</span> * <tr><a name="line.71"></a> -<span class="sourceLineNo">072</span> * <td class='code'>text/html+stripped</td><a name="line.72"></a> -<span class="sourceLineNo">073</span> * <td class='code'>text/html</td><a name="line.73"></a> -<span class="sourceLineNo">074</span> * <td>{@link HtmlStrippedDocSerializer}</td><a name="line.74"></a> -<span class="sourceLineNo">075</span> * </tr><a name="line.75"></a> -<span class="sourceLineNo">076</span> * <tr><a name="line.76"></a> +<span class="sourceLineNo">068</span> * <td>{@link HtmlDocSerializer}</td><a name="line.68"></a> +<span class="sourceLineNo">069</span> * </tr><a name="line.69"></a> +<span class="sourceLineNo">070</span> * <tr><a name="line.70"></a> +<span class="sourceLineNo">071</span> * <td class='code'>text/html+stripped</td><a name="line.71"></a> +<span class="sourceLineNo">072</span> * <td class='code'>text/html</td><a name="line.72"></a> +<span class="sourceLineNo">073</span> * <td>{@link HtmlStrippedDocSerializer}</td><a name="line.73"></a> +<span class="sourceLineNo">074</span> * </tr><a name="line.74"></a> +<span class="sourceLineNo">075</span> * <tr><a name="line.75"></a> +<span class="sourceLineNo">076</span> * <td class='code'>text/uon</td><a name="line.76"></a> <span class="sourceLineNo">077</span> * <td class='code'>text/uon</td><a name="line.77"></a> -<span class="sourceLineNo">078</span> * <td class='code'>text/uon</td><a name="line.78"></a> -<span class="sourceLineNo">079</span> * <td>{@link UonSerializer}</td><a name="line.79"></a> -<span class="sourceLineNo">080</span> * </tr><a name="line.80"></a> -<span class="sourceLineNo">081</span> * <tr><a name="line.81"></a> +<span class="sourceLineNo">078</span> * <td>{@link UonSerializer}</td><a name="line.78"></a> +<span class="sourceLineNo">079</span> * </tr><a name="line.79"></a> +<span class="sourceLineNo">080</span> * <tr><a name="line.80"></a> +<span class="sourceLineNo">081</span> * <td class='code'>application/x-www-form-urlencoded</td><a name="line.81"></a> <span class="sourceLineNo">082</span> * <td class='code'>application/x-www-form-urlencoded</td><a name="line.82"></a> -<span class="sourceLineNo">083</span> * <td class='code'>application/x-www-form-urlencoded</td><a name="line.83"></a> -<span class="sourceLineNo">084</span> * <td>{@link UrlEncodingSerializer}</td><a name="line.84"></a> -<span class="sourceLineNo">085</span> * </tr><a name="line.85"></a> -<span class="sourceLineNo">086</span> * <tr><a name="line.86"></a> -<span class="sourceLineNo">087</span> * <td class='code'>text/xml+soap</td><a name="line.87"></a> -<span class="sourceLineNo">088</span> * <td class='code'>text/xml</td><a name="line.88"></a> -<span class="sourceLineNo">089</span> * <td>{@link SoapXmlSerializer}</td><a name="line.89"></a> -<span class="sourceLineNo">090</span> * </tr><a name="line.90"></a> -<span class="sourceLineNo">091</span> * <tr><a name="line.91"></a> +<span class="sourceLineNo">083</span> * <td>{@link UrlEncodingSerializer}</td><a name="line.83"></a> +<span class="sourceLineNo">084</span> * </tr><a name="line.84"></a> +<span class="sourceLineNo">085</span> * <tr><a name="line.85"></a> +<span class="sourceLineNo">086</span> * <td class='code'>text/xml+soap</td><a name="line.86"></a> +<span class="sourceLineNo">087</span> * <td class='code'>text/xml</td><a name="line.87"></a> +<span class="sourceLineNo">088</span> * <td>{@link SoapXmlSerializer}</td><a name="line.88"></a> +<span class="sourceLineNo">089</span> * </tr><a name="line.89"></a> +<span class="sourceLineNo">090</span> * <tr><a name="line.90"></a> +<span class="sourceLineNo">091</span> * <td class='code'>text/plain</td><a name="line.91"></a> <span class="sourceLineNo">092</span> * <td class='code'>text/plain</td><a name="line.92"></a> -<span class="sourceLineNo">093</span> * <td class='code'>text/plain</td><a name="line.93"></a> -<span class="sourceLineNo">094</span> * <td>{@link PlainTextSerializer}</td><a name="line.94"></a> -<span class="sourceLineNo">095</span> * </tr><a name="line.95"></a> -<span class="sourceLineNo">096</span> * <tr><a name="line.96"></a> +<span class="sourceLineNo">093</span> * <td>{@link PlainTextSerializer}</td><a name="line.93"></a> +<span class="sourceLineNo">094</span> * </tr><a name="line.94"></a> +<span class="sourceLineNo">095</span> * <tr><a name="line.95"></a> +<span class="sourceLineNo">096</span> * <td class='code'>application/x-java-serialized-object</td><a name="line.96"></a> <span class="sourceLineNo">097</span> * <td class='code'>application/x-java-serialized-object</td><a name="line.97"></a> -<span class="sourceLineNo">098</span> * <td class='code'>application/x-java-serialized-object</td><a name="line.98"></a> -<span class="sourceLineNo">099</span> * <td>{@link JsoSerializer}</td><a name="line.99"></a> -<span class="sourceLineNo">100</span> * </tr><a name="line.100"></a> -<span class="sourceLineNo">101</span> * </table><a name="line.101"></a> -<span class="sourceLineNo">102</span> * <p><a name="line.102"></a> -<span class="sourceLineNo">103</span> * Supports the following request <code>Content-Type</code> header values:<a name="line.103"></a> -<span class="sourceLineNo">104</span> * </p><a name="line.104"></a> -<span class="sourceLineNo">105</span> * <table class='styled'><a name="line.105"></a> -<span class="sourceLineNo">106</span> * <tr><a name="line.106"></a> -<span class="sourceLineNo">107</span> * <th>Content-Type</th><a name="line.107"></a> -<span class="sourceLineNo">108</span> * <th>Parser</th><a name="line.108"></a> -<span class="sourceLineNo">109</span> * </tr><a name="line.109"></a> -<span class="sourceLineNo">110</span> * <tr><a name="line.110"></a> -<span class="sourceLineNo">111</span> * <td class='code'>application/json<br>text/json</td><a name="line.111"></a> -<span class="sourceLineNo">112</span> * <td>{@link JsonParser}</td><a name="line.112"></a> -<span class="sourceLineNo">113</span> * </tr><a name="line.113"></a> -<span class="sourceLineNo">114</span> * <tr><a name="line.114"></a> -<span class="sourceLineNo">115</span> * <td class='code'>text/xml<br>application/xml</td><a name="line.115"></a> -<span class="sourceLineNo">116</span> * <td>{@link XmlParser}</td><a name="line.116"></a> -<span class="sourceLineNo">117</span> * </tr><a name="line.117"></a> -<span class="sourceLineNo">118</span> * <tr><a name="line.118"></a> -<span class="sourceLineNo">119</span> * <td class='code'>text/html<br>text/html+stripped</td><a name="line.119"></a> -<span class="sourceLineNo">120</span> * <td>{@link HtmlParser}</td><a name="line.120"></a> -<span class="sourceLineNo">121</span> * </tr><a name="line.121"></a> -<span class="sourceLineNo">122</span> * <tr><a name="line.122"></a> -<span class="sourceLineNo">123</span> * <td class='code'>text/uon</td><a name="line.123"></a> -<span class="sourceLineNo">124</span> * <td>{@link UonParser}</td><a name="line.124"></a> -<span class="sourceLineNo">125</span> * </tr><a name="line.125"></a> -<span class="sourceLineNo">126</span> * <tr><a name="line.126"></a> -<span class="sourceLineNo">127</span> * <td class='code'>application/x-www-form-urlencoded</td><a name="line.127"></a> -<span class="sourceLineNo">128</span> * <td>{@link UrlEncodingParser}</td><a name="line.128"></a> -<span class="sourceLineNo">129</span> * </tr><a name="line.129"></a> -<span class="sourceLineNo">130</span> * <tr><a name="line.130"></a> -<span class="sourceLineNo">131</span> * <td class='code'>text/plain</td><a name="line.131"></a> -<span class="sourceLineNo">132</span> * <td>{@link PlainTextParser}</td><a name="line.132"></a> -<span class="sourceLineNo">133</span> * </tr><a name="line.133"></a> -<span class="sourceLineNo">134</span> * </table><a name="line.134"></a> -<span class="sourceLineNo">135</span> * <p><a name="line.135"></a> -<span class="sourceLineNo">136</span> * It should be noted that we do NOT add {@link JsoParser} to the list of parsers since this could<a name="line.136"></a> -<span class="sourceLineNo">137</span> * cause security issues. Use caution when using this particular parser as it could inadvertantly cause<a name="line.137"></a> -<span class="sourceLineNo">138</span> * code execution security holes.<a name="line.138"></a> -<span class="sourceLineNo">139</span> * <p><a name="line.139"></a> -<span class="sourceLineNo">140</span> * The list of serializers and parsers can be appended to using the {@link RestResource#serializers() @RestResource.serializers()}<a name="line.140"></a> -<span class="sourceLineNo">141</span> * and {@link RestResource#parsers() @RestResource.parsers()} annotations on subclasses.<a name="line.141"></a> -<span class="sourceLineNo">142</span> * <p><a name="line.142"></a> -<span class="sourceLineNo">143</span> * This subclass also provides a default OPTIONS page by implementing a {@link #getOptions(RestRequest)} that returns a POJO consisting<a name="line.143"></a> -<span class="sourceLineNo">144</span> * of beans describing the class.<a name="line.144"></a> -<span class="sourceLineNo">145</span> * <img class='bordered' src='doc-files/OptionsPage.png'><a name="line.145"></a> -<span class="sourceLineNo">146</span> * <p><a name="line.146"></a> -<span class="sourceLineNo">147</span> * The OPTIONS page can be modified or augmented by overriding this method and providing your own data.<a name="line.147"></a> -<span class="sourceLineNo">148</span> *<a name="line.148"></a> -<span class="sourceLineNo">149</span> * <h6 class='topic'>Other Notes</h6><a name="line.149"></a> -<span class="sourceLineNo">150</span> * <ul class='spaced-list'><a name="line.150"></a> -<span class="sourceLineNo">151</span> * <li>Provides a default HTML stylesheet by setting {@link RestResource#stylesheet() @RestResource.stylesheet()} to <js>"styles/juneau.css"</js>.<a name="line.151"></a> -<span class="sourceLineNo">152</span> * <li>Provides a default favicon by setting {@link RestResource#favicon() @RestResource.favicon()} to <js>"juneau.ico"</js>.<a name="line.152"></a> -<span class="sourceLineNo">153</span> * <li>Provides a default classpath entry "htdocs" by setting {@link RestResource#staticFiles() @RestResource.staticFiles()} to <js>"{htdocs:'htdocs'}"</js>.<a name="line.153"></a> -<span class="sourceLineNo">154</span> * This allows files inside the <code>[servletPackage].htdocs</code> package to be served up under the URL <code>/servletPath/htdocs</code>.<a name="line.154"></a> -<span class="sourceLineNo">155</span> * </ul><a name="line.155"></a> -<span class="sourceLineNo">156</span> */<a name="line.156"></a> -<span class="sourceLineNo">157</span>@RestResource(<a name="line.157"></a> -<span class="sourceLineNo">158</span> serializers={<a name="line.158"></a> -<span class="sourceLineNo">159</span> HtmlDocSerializer.class, // HTML must be listed first because Internet Explore does not include text/html in their Accept header.<a name="line.159"></a> -<span class="sourceLineNo">160</span> HtmlStrippedDocSerializer.class,<a name="line.160"></a> -<span class="sourceLineNo">161</span> HtmlSchemaDocSerializer.class,<a name="line.161"></a> -<span class="sourceLineNo">162</span> JsonSerializer.class,<a name="line.162"></a> -<span class="sourceLineNo">163</span> JsonSerializer.Simple.class,<a name="line.163"></a> -<span class="sourceLineNo">164</span> JsonSchemaSerializer.class,<a name="line.164"></a> -<span class="sourceLineNo">165</span> XmlDocSerializer.class,<a name="line.165"></a> -<span class="sourceLineNo">166</span> XmlSchemaDocSerializer.class,<a name="line.166"></a> -<span class="sourceLineNo">167</span> UonSerializer.class,<a name="line.167"></a> -<span class="sourceLineNo">168</span> UrlEncodingSerializer.class,<a name="line.168"></a> -<span class="sourceLineNo">169</span> MsgPackSerializer.class,<a name="line.169"></a> -<span class="sourceLineNo">170</span> SoapXmlSerializer.class,<a name="line.170"></a> -<span class="sourceLineNo">171</span> PlainTextSerializer.class,<a name="line.171"></a> -<span class="sourceLineNo">172</span> JsoSerializer.class<a name="line.172"></a> -<span class="sourceLineNo">173</span> },<a name="line.173"></a> -<span class="sourceLineNo">174</span> parsers={<a name="line.174"></a> -<span class="sourceLineNo">175</span> JsonParser.class,<a name="line.175"></a> -<span class="sourceLineNo">176</span> XmlParser.class,<a name="line.176"></a> -<span class="sourceLineNo">177</span> HtmlParser.class,<a name="line.177"></a> -<span class="sourceLineNo">178</span> UonParser.class,<a name="line.178"></a> -<span class="sourceLineNo">179</span> UrlEncodingParser.class,<a name="line.179"></a> -<span class="sourceLineNo">180</span> MsgPackParser.class,<a name="line.180"></a> -<span class="sourceLineNo">181</span> PlainTextParser.class<a name="line.181"></a> -<span class="sourceLineNo">182</span> },<a name="line.182"></a> -<span class="sourceLineNo">183</span> properties={<a name="line.183"></a> -<span class="sourceLineNo">184</span> // Allow &method parameter on safe HTTP methods.<a name="line.184"></a> -<span class="sourceLineNo">185</span> @Property(name=REST_allowMethodParam, value="OPTIONS"),<a name="line.185"></a> -<span class="sourceLineNo">186</span> // Provide a default title on HTML pages.<a name="line.186"></a> -<span class="sourceLineNo">187</span> @Property(name=HTMLDOC_title, value="$R{servletTitle}"),<a name="line.187"></a> -<span class="sourceLineNo">188</span> // Provide a default description on HTML pages.<a name="line.188"></a> -<span class="sourceLineNo">189</span> @Property(name=HTMLDOC_description, value="$R{servletDescription}")<a name="line.189"></a> -<span class="sourceLineNo">190</span> },<a name="line.190"></a> -<span class="sourceLineNo">191</span> stylesheet="styles/juneau.css",<a name="line.191"></a> -<span class="sourceLineNo">192</span> favicon="juneau.png",<a name="line.192"></a> -<span class="sourceLineNo">193</span> staticFiles="{htdocs:'htdocs'}"<a name="line.193"></a> -<span class="sourceLineNo">194</span>)<a name="line.194"></a> -<span class="sourceLineNo">195</span>public abstract class RestServletDefault extends RestServlet {<a name="line.195"></a> -<span class="sourceLineNo">196</span> private static final long serialVersionUID = 1L;<a name="line.196"></a> -<span class="sourceLineNo">197</span><a name="line.197"></a> -<span class="sourceLineNo">198</span> /**<a name="line.198"></a> -<span class="sourceLineNo">199</span> * [OPTIONS /*] - Show resource options.<a name="line.199"></a> -<span class="sourceLineNo">200</span> *<a name="line.200"></a> -<span class="sourceLineNo">201</span> * @param req The HTTP request.<a name="line.201"></a> -<span class="sourceLineNo">202</span> * @return A bean containing the contents for the OPTIONS page.<a name="line.202"></a> -<span class="sourceLineNo">203</span> */<a name="line.203"></a> -<span class="sourceLineNo">204</span> @RestMethod(name="OPTIONS", path="/*",<a name="line.204"></a> -<span class="sourceLineNo">205</span> properties={<a name="line.205"></a> -<span class="sourceLineNo">206</span> @Property(name=HTMLDOC_links, value="{back:'$R{servletURI}'}"),<a name="line.206"></a> -<span class="sourceLineNo">207</span> @Property(name=HTMLDOC_description, value="Resource options")<a name="line.207"></a> -<span class="sourceLineNo">208</span> },<a name="line.208"></a> -<span class="sourceLineNo">209</span> description="Resource options"<a name="line.209"></a> -<span class="sourceLineNo">210</span> )<a name="line.210"></a> -<span class="sourceLineNo">211</span> public Swagger getOptions(RestRequest req) {<a name="line.211"></a> -<span class="sourceLineNo">212</span> return req.getSwagger();<a name="line.212"></a> -<span class="sourceLineNo">213</span> }<a name="line.213"></a> -<span class="sourceLineNo">214</span>}<a name="line.214"></a> +<span class="sourceLineNo">098</span> * <td>{@link JsoSerializer}</td><a name="line.98"></a> +<span class="sourceLineNo">099</span> * </tr><a name="line.99"></a> +<span class="sourceLineNo">100</span> * </table><a name="line.100"></a> +<span class="sourceLineNo">101</span> * <p><a name="line.101"></a> +<span class="sourceLineNo">102</span> * Supports the following request <code>Content-Type</code> header values:<a name="line.102"></a> +<span class="sourceLineNo">103</span> * </p><a name="line.103"></a> +<span class="sourceLineNo">104</span> * <table class='styled'><a name="line.104"></a> +<span class="sourceLineNo">105</span> * <tr><a name="line.105"></a> +<span class="sourceLineNo">106</span> * <th>Content-Type</th><a name="line.106"></a> +<span class="sourceLineNo">107</span> * <th>Parser</th><a name="line.107"></a> +<span class="sourceLineNo">108</span> * </tr><a name="line.108"></a> +<span class="sourceLineNo">109</span> * <tr><a name="line.109"></a> +<span class="sourceLineNo">110</span> * <td class='code'>application/json<br>text/json</td><a name="line.110"></a> +<span class="sourceLineNo">111</span> * <td>{@link JsonParser}</td><a name="line.111"></a> +<span class="sourceLineNo">112</span> * </tr><a name="line.112"></a> +<span class="sourceLineNo">113</span> * <tr><a name="line.113"></a> +<span class="sourceLineNo">114</span> * <td class='code'>text/xml<br>application/xml</td><a name="line.114"></a> +<span class="sourceLineNo">115</span> * <td>{@link XmlParser}</td><a name="line.115"></a> +<span class="sourceLineNo">116</span> * </tr><a name="line.116"></a> +<span class="sourceLineNo">117</span> * <tr><a name="line.117"></a> +<span class="sourceLineNo">118</span> * <td class='code'>text/html<br>text/html+stripped</td><a name="line.118"></a> +<span class="sourceLineNo">119</span> * <td>{@link HtmlParser}</td><a name="line.119"></a> +<span class="sourceLineNo">120</span> * </tr><a name="line.120"></a> +<span class="sourceLineNo">121</span> * <tr><a name="line.121"></a> +<span class="sourceLineNo">122</span> * <td class='code'>text/uon</td><a name="line.122"></a> +<span class="sourceLineNo">123</span> * <td>{@link UonParser}</td><a name="line.123"></a> +<span class="sourceLineNo">124</span> * </tr><a name="line.124"></a> +<span class="sourceLineNo">125</span> * <tr><a name="line.125"></a> +<span class="sourceLineNo">126</span> * <td class='code'>application/x-www-form-urlencoded</td><a name="line.126"></a> +<span class="sourceLineNo">127</span> * <td>{@link UrlEncodingParser}</td><a name="line.127"></a> +<span class="sourceLineNo">128</span> * </tr><a name="line.128"></a> +<span class="sourceLineNo">129</span> * <tr><a name="line.129"></a> +<span class="sourceLineNo">130</span> * <td class='code'>text/plain</td><a name="line.130"></a> +<span class="sourceLineNo">131</span> * <td>{@link PlainTextParser}</td><a name="line.131"></a> +<span class="sourceLineNo">132</span> * </tr><a name="line.132"></a> +<span class="sourceLineNo">133</span> * </table><a name="line.133"></a> +<span class="sourceLineNo">134</span> * <p><a name="line.134"></a> +<span class="sourceLineNo">135</span> * It should be noted that we do NOT add {@link JsoParser} to the list of parsers since this could<a name="line.135"></a> +<span class="sourceLineNo">136</span> * cause security issues. Use caution when using this particular parser as it could inadvertantly cause<a name="line.136"></a> +<span class="sourceLineNo">137</span> * code execution security holes.<a name="line.137"></a> +<span class="sourceLineNo">138</span> * <p><a name="line.138"></a> +<span class="sourceLineNo">139</span> * The list of serializers and parsers can be appended to using the {@link RestResource#serializers() @RestResource.serializers()}<a name="line.139"></a> +<span class="sourceLineNo">140</span> * and {@link RestResource#parsers() @RestResource.parsers()} annotations on subclasses.<a name="line.140"></a> +<span class="sourceLineNo">141</span> * <p><a name="line.141"></a> +<span class="sourceLineNo">142</span> * This subclass also provides a default OPTIONS page by implementing a {@link #getOptions(RestRequest)} that returns a POJO consisting<a name="line.142"></a> +<span class="sourceLineNo">143</span> * of beans describing the class.<a name="line.143"></a> +<span class="sourceLineNo">144</span> * <img class='bordered' src='doc-files/OptionsPage.png'><a name="line.144"></a> +<span class="sourceLineNo">145</span> * <p><a name="line.145"></a> +<span class="sourceLineNo">146</span> * The OPTIONS page can be modified or augmented by overriding this method and providing your own data.<a name="line.146"></a> +<span class="sourceLineNo">147</span> *<a name="line.147"></a> +<span class="sourceLineNo">148</span> * <h6 class='topic'>Other Notes</h6><a name="line.148"></a> +<span class="sourceLineNo">149</span> * <ul class='spaced-list'><a name="line.149"></a> +<span class="sourceLineNo">150</span> * <li>Provides a default HTML stylesheet by setting {@link RestResource#stylesheet() @RestResource.stylesheet()} to <js>"styles/juneau.css"</js>.<a name="line.150"></a> +<span class="sourceLineNo">151</span> * <li>Provides a default favicon by setting {@link RestResource#favicon() @RestResource.favicon()} to <js>"juneau.ico"</js>.<a name="line.151"></a> +<span class="sourceLineNo">152</span> * <li>Provides a default classpath entry "htdocs" by setting {@link RestResource#staticFiles() @RestResource.staticFiles()} to <js>"{htdocs:'htdocs'}"</js>.<a name="line.152"></a> +<span class="sourceLineNo">153</span> * This allows files inside the <code>[servletPackage].htdocs</code> package to be served up under the URL <code>/servletPath/htdocs</code>.<a name="line.153"></a> +<span class="sourceLineNo">154</span> * </ul><a name="line.154"></a> +<span class="sourceLineNo">155</span> */<a name="line.155"></a> +<span class="sourceLineNo">156</span>@RestResource(<a name="line.156"></a> +<span class="sourceLineNo">157</span> serializers={<a name="line.157"></a> +<span class="sourceLineNo">158</span> HtmlDocSerializer.class, // HTML must be listed first because Internet Explore does not include text/html in their Accept header.<a name="line.158"></a> +<span class="sourceLineNo">159</span> HtmlStrippedDocSerializer.class,<a name="line.159"></a> +<span class="sourceLineNo">160</span> HtmlSchemaDocSerializer.class,<a name="line.160"></a> +<span class="sourceLineNo">161</span> JsonSerializer.class,<a name="line.161"></a> +<span class="sourceLineNo">162</span> JsonSerializer.Simple.class,<a name="line.162"></a> +<span class="sourceLineNo">163</span> JsonSchemaSerializer.class,<a name="line.163"></a> +<span class="sourceLineNo">164</span> XmlDocSerializer.class,<a name="line.164"></a> +<span class="sourceLineNo">165</span> XmlSchemaDocSerializer.class,<a name="line.165"></a> +<span class="sourceLineNo">166</span> UonSerializer.class,<a name="line.166"></a> +<span class="sourceLineNo">167</span> UrlEncodingSerializer.class,<a name="line.167"></a> +<span class="sourceLineNo">168</span> MsgPackSerializer.class,<a name="line.168"></a> +<span class="sourceLineNo">169</span> SoapXmlSerializer.class,<a name="line.169"></a> +<span class="sourceLineNo">170</span> PlainTextSerializer.class,<a name="line.170"></a> +<span class="sourceLineNo">171</span> JsoSerializer.class<a name="line.171"></a> +<span class="sourceLineNo">172</span> },<a name="line.172"></a> +<span class="sourceLineNo">173</span> parsers={<a name="line.173"></a> +<span class="sourceLineNo">174</span> JsonParser.class,<a name="line.174"></a> +<span class="sourceLineNo">175</span> XmlParser.class,<a name="line.175"></a> +<span class="sourceLineNo">176</span> HtmlParser.class,<a name="line.176"></a> +<span class="sourceLineNo">177</span> UonParser.class,<a name="line.177"></a> +<span class="sourceLineNo">178</span> UrlEncodingParser.class,<a name="line.178"></a> +<span class="sourceLineNo">179</span> MsgPackParser.class,<a name="line.179"></a> +<span class="sourceLineNo">180</span> PlainTextParser.class<a name="line.180"></a> +<span class="sourceLineNo">181</span> },<a name="line.181"></a> +<span class="sourceLineNo">182</span> properties={<a name="line.182"></a> +<span class="sourceLineNo">183</span> // Allow &method parameter on safe HTTP methods.<a name="line.183"></a> +<span class="sourceLineNo">184</span> @Property(name=REST_allowMethodParam, value="OPTIONS"),<a name="line.184"></a> +<span class="sourceLineNo">185</span> },<a name="line.185"></a> +<span class="sourceLineNo">186</span> stylesheet="styles/juneau.css",<a name="line.186"></a> +<span class="sourceLineNo">187</span> favicon="juneau.png",<a name="line.187"></a> +<span class="sourceLineNo">188</span> staticFiles="{htdocs:'htdocs'}"<a name="line.188"></a> +<span class="sourceLineNo">189</span>)<a name="line.189"></a> +<span class="sourceLineNo">190</span>public abstract class RestServletDefault extends RestServlet {<a name="line.190"></a> +<span class="sourceLineNo">191</span> private static final long serialVersionUID = 1L;<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> * [OPTIONS /*] - Show resource options.<a name="line.194"></a> +<span class="sourceLineNo">195</span> *<a name="line.195"></a> +<span class="sourceLineNo">196</span> * @param req The HTTP request.<a name="line.196"></a> +<span class="sourceLineNo">197</span> * @return A bean containing the contents for the OPTIONS page.<a name="line.197"></a> +<span class="sourceLineNo">198</span> */<a name="line.198"></a> +<span class="sourceLineNo">199</span> @RestMethod(name="OPTIONS", path="/*",<a name="line.199"></a> +<span class="sourceLineNo">200</span> pageLinks="{back:'$R{servletURI}'}",<a name="line.200"></a> +<span class="sourceLineNo">201</span> summary="Resource options",<a name="line.201"></a> +<span class="sourceLineNo">202</span> description="Description of this resource"<a name="line.202"></a> +<span class="sourceLineNo">203</span> )<a name="line.203"></a> +<span class="sourceLineNo">204</span> public Swagger getOptions(RestRequest req) {<a name="line.204"></a> +<span class="sourceLineNo">205</span> return req.getSwagger();<a name="line.205"></a> +<span class="sourceLineNo">206</span> }<a name="line.206"></a> +<span class="sourceLineNo">207</span>}<a name="line.207"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html index 615286d..1ea40ae 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestUtils.html @@ -27,61 +27,61 @@ <span class="sourceLineNo">019</span>import javax.servlet.http.*;<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> * Various reusable utility methods.<a name="line.24"></a> -<span class="sourceLineNo">025</span> */<a name="line.25"></a> -<span class="sourceLineNo">026</span>public final class RestUtils {<a name="line.26"></a> -<span class="sourceLineNo">027</span><a name="line.27"></a> -<span class="sourceLineNo">028</span> /**<a name="line.28"></a> -<span class="sourceLineNo">029</span> * Returns readable text for an HTTP response code.<a name="line.29"></a> -<span class="sourceLineNo">030</span> *<a name="line.30"></a> -<span class="sourceLineNo">031</span> * @param rc The HTTP response code.<a name="line.31"></a> -<span class="sourceLineNo">032</span> * @return Readable text for an HTTP response code, or <jk>null</jk> if it's an invalid code.<a name="line.32"></a> -<span class="sourceLineNo">033</span> */<a name="line.33"></a> -<span class="sourceLineNo">034</span> public static String getHttpResponseText(int rc) {<a name="line.34"></a> -<span class="sourceLineNo">035</span> return httpMsgs.get(rc);<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> @SuppressWarnings("serial")<a name="line.38"></a> -<span class="sourceLineNo">039</span> private static Map<Integer,String> httpMsgs = new HashMap<Integer,String>() {{<a name="line.39"></a> -<span class="sourceLineNo">040</span> put(200, "OK");<a name="line.40"></a> -<span class="sourceLineNo">041</span> put(201, "Created");<a name="line.41"></a> -<span class="sourceLineNo">042</span> put(202, "Accepted");<a name="line.42"></a> -<span class="sourceLineNo">043</span> put(203, "Non-Authoritative Information");<a name="line.43"></a> -<span class="sourceLineNo">044</span> put(204, "No Content");<a name="line.44"></a> -<span class="sourceLineNo">045</span> put(205, "Reset Content");<a name="line.45"></a> -<span class="sourceLineNo">046</span> put(206, "Partial Content");<a name="line.46"></a> -<span class="sourceLineNo">047</span> put(300, "Multiple Choices");<a name="line.47"></a> -<span class="sourceLineNo">048</span> put(301, "Moved Permanently");<a name="line.48"></a> -<span class="sourceLineNo">049</span> put(302, "Temporary Redirect");<a name="line.49"></a> -<span class="sourceLineNo">050</span> put(303, "See Other");<a name="line.50"></a> -<span class="sourceLineNo">051</span> put(304, "Not Modified");<a name="line.51"></a> -<span class="sourceLineNo">052</span> put(305, "Use Proxy");<a name="line.52"></a> -<span class="sourceLineNo">053</span> put(307, "Temporary Redirect");<a name="line.53"></a> -<span class="sourceLineNo">054</span> put(400, "Bad Request");<a name="line.54"></a> -<span class="sourceLineNo">055</span> put(401, "Unauthorized");<a name="line.55"></a> -<span class="sourceLineNo">056</span> put(402, "Payment Required");<a name="line.56"></a> -<span class="sourceLineNo">057</span> put(403, "Forbidden");<a name="line.57"></a> -<span class="sourceLineNo">058</span> put(404, "Not Found");<a name="line.58"></a> -<span class="sourceLineNo">059</span> put(405, "Method Not Allowed");<a name="line.59"></a> -<span class="sourceLineNo">060</span> put(406, "Not Acceptable");<a name="line.60"></a> -<span class="sourceLineNo">061</span> put(407, "Proxy Authentication Required");<a name="line.61"></a> -<span class="sourceLineNo">062</span> put(408, "Request Time-Out");<a name="line.62"></a> -<span class="sourceLineNo">063</span> put(409, "Conflict");<a name="line.63"></a> -<span class="sourceLineNo">064</span> put(410, "Gone");<a name="line.64"></a> -<span class="sourceLineNo">065</span> put(411, "Length Required");<a name="line.65"></a> -<span class="sourceLineNo">066</span> put(412, "Precondition Failed");<a name="line.66"></a> -<span class="sourceLineNo">067</span> put(413, "Request Entity Too Large");<a name="line.67"></a> -<span class="sourceLineNo">068</span> put(414, "Request-URI Too Large");<a name="line.68"></a> -<span class="sourceLineNo">069</span> put(415, "Unsupported Media Type");<a name="line.69"></a> -<span class="sourceLineNo">070</span> put(500, "Internal Server Error");<a name="line.70"></a> -<span class="sourceLineNo">071</span> put(501, "Not Implemented");<a name="line.71"></a> -<span class="sourceLineNo">072</span> put(502, "Bad Gateway");<a name="line.72"></a> -<span class="sourceLineNo">073</span> put(503, "Service Unavailable");<a name="line.73"></a> -<span class="sourceLineNo">074</span> put(504, "Gateway Timeout");<a name="line.74"></a> -<span class="sourceLineNo">075</span> put(505, "HTTP Version Not Supported");<a name="line.75"></a> -<span class="sourceLineNo">076</span> }};<a name="line.76"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.utils.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span><a name="line.23"></a> +<span class="sourceLineNo">024</span>/**<a name="line.24"></a> +<span class="sourceLineNo">025</span> * Various reusable utility methods.<a name="line.25"></a> +<span class="sourceLineNo">026</span> */<a name="line.26"></a> +<span class="sourceLineNo">027</span>public final class RestUtils {<a name="line.27"></a> +<span class="sourceLineNo">028</span><a name="line.28"></a> +<span class="sourceLineNo">029</span> /**<a name="line.29"></a> +<span class="sourceLineNo">030</span> * Returns readable text for an HTTP response code.<a name="line.30"></a> +<span class="sourceLineNo">031</span> *<a name="line.31"></a> +<span class="sourceLineNo">032</span> * @param rc The HTTP response code.<a name="line.32"></a> +<span class="sourceLineNo">033</span> * @return Readable text for an HTTP response code, or <jk>null</jk> if it's an invalid code.<a name="line.33"></a> +<span class="sourceLineNo">034</span> */<a name="line.34"></a> +<span class="sourceLineNo">035</span> public static String getHttpResponseText(int rc) {<a name="line.35"></a> +<span class="sourceLineNo">036</span> return httpMsgs.get(rc);<a name="line.36"></a> +<span class="sourceLineNo">037</span> }<a name="line.37"></a> +<span class="sourceLineNo">038</span><a name="line.38"></a> +<span class="sourceLineNo">039</span> private static Map<Integer,String> httpMsgs = new AMap<Integer,String>()<a name="line.39"></a> +<span class="sourceLineNo">040</span> .append(200, "OK")<a name="line.40"></a> +<span class="sourceLineNo">041</span> .append(201, "Created")<a name="line.41"></a> +<span class="sourceLineNo">042</span> .append(202, "Accepted")<a name="line.42"></a> +<span class="sourceLineNo">043</span> .append(203, "Non-Authoritative Information")<a name="line.43"></a> +<span class="sourceLineNo">044</span> .append(204, "No Content")<a name="line.44"></a> +<span class="sourceLineNo">045</span> .append(205, "Reset Content")<a name="line.45"></a> +<span class="sourceLineNo">046</span> .append(206, "Partial Content")<a name="line.46"></a> +<span class="sourceLineNo">047</span> .append(300, "Multiple Choices")<a name="line.47"></a> +<span class="sourceLineNo">048</span> .append(301, "Moved Permanently")<a name="line.48"></a> +<span class="sourceLineNo">049</span> .append(302, "Temporary Redirect")<a name="line.49"></a> +<span class="sourceLineNo">050</span> .append(303, "See Other")<a name="line.50"></a> +<span class="sourceLineNo">051</span> .append(304, "Not Modified")<a name="line.51"></a> +<span class="sourceLineNo">052</span> .append(305, "Use Proxy")<a name="line.52"></a> +<span class="sourceLineNo">053</span> .append(307, "Temporary Redirect")<a name="line.53"></a> +<span class="sourceLineNo">054</span> .append(400, "Bad Request")<a name="line.54"></a> +<span class="sourceLineNo">055</span> .append(401, "Unauthorized")<a name="line.55"></a> +<span class="sourceLineNo">056</span> .append(402, "Payment Required")<a name="line.56"></a> +<span class="sourceLineNo">057</span> .append(403, "Forbidden")<a name="line.57"></a> +<span class="sourceLineNo">058</span> .append(404, "Not Found")<a name="line.58"></a> +<span class="sourceLineNo">059</span> .append(405, "Method Not Allowed")<a name="line.59"></a> +<span class="sourceLineNo">060</span> .append(406, "Not Acceptable")<a name="line.60"></a> +<span class="sourceLineNo">061</span> .append(407, "Proxy Authentication Required")<a name="line.61"></a> +<span class="sourceLineNo">062</span> .append(408, "Request Time-Out")<a name="line.62"></a> +<span class="sourceLineNo">063</span> .append(409, "Conflict")<a name="line.63"></a> +<span class="sourceLineNo">064</span> .append(410, "Gone")<a name="line.64"></a> +<span class="sourceLineNo">065</span> .append(411, "Length Required")<a name="line.65"></a> +<span class="sourceLineNo">066</span> .append(412, "Precondition Failed")<a name="line.66"></a> +<span class="sourceLineNo">067</span> .append(413, "Request Entity Too Large")<a name="line.67"></a> +<span class="sourceLineNo">068</span> .append(414, "Request-URI Too Large")<a name="line.68"></a> +<span class="sourceLineNo">069</span> .append(415, "Unsupported Media Type")<a name="line.69"></a> +<span class="sourceLineNo">070</span> .append(500, "Internal Server Error")<a name="line.70"></a> +<span class="sourceLineNo">071</span> .append(501, "Not Implemented")<a name="line.71"></a> +<span class="sourceLineNo">072</span> .append(502, "Bad Gateway")<a name="line.72"></a> +<span class="sourceLineNo">073</span> .append(503, "Service Unavailable")<a name="line.73"></a> +<span class="sourceLineNo">074</span> .append(504, "Gateway Timeout")<a name="line.74"></a> +<span class="sourceLineNo">075</span> .append(505, "HTTP Version Not Supported")<a name="line.75"></a> +<span class="sourceLineNo">076</span> ;<a name="line.76"></a> <span class="sourceLineNo">077</span><a name="line.77"></a> <span class="sourceLineNo">078</span> /**<a name="line.78"></a> <span class="sourceLineNo">079</span> * Trims <js>'/'</js> characters from both the start and end of the specified string.<a name="line.79"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/Path.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/Path.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/Path.html index 59a5549..80d5d4f 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/Path.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/Path.html @@ -64,20 +64,29 @@ <span class="sourceLineNo">056</span> * ...<a name="line.56"></a> <span class="sourceLineNo">057</span> * }<a name="line.57"></a> <span class="sourceLineNo">058</span> * </p><a name="line.58"></a> -<span class="sourceLineNo">059</span> */<a name="line.59"></a> -<span class="sourceLineNo">060</span>@Documented<a name="line.60"></a> -<span class="sourceLineNo">061</span>@Target(PARAMETER)<a name="line.61"></a> -<span class="sourceLineNo">062</span>@Retention(RUNTIME)<a name="line.62"></a> -<span class="sourceLineNo">063</span>@Inherited<a name="line.63"></a> -<span class="sourceLineNo">064</span>public @interface Path {<a name="line.64"></a> -<span class="sourceLineNo">065</span><a name="line.65"></a> -<span class="sourceLineNo">066</span> /**<a name="line.66"></a> -<span class="sourceLineNo">067</span> * URL variable name.<a name="line.67"></a> -<span class="sourceLineNo">068</span> * <p><a name="line.68"></a> -<span class="sourceLineNo">069</span> * Optional if the attributes are specified in the same order as in the URL path pattern.<a name="line.69"></a> -<span class="sourceLineNo">070</span> */<a name="line.70"></a> -<span class="sourceLineNo">071</span> String value() default "";<a name="line.71"></a> -<span class="sourceLineNo">072</span>}<a name="line.72"></a> +<span class="sourceLineNo">059</span> * You can also use <code>{#}</code> notation to specify path parameters without specifying names.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <p><a name="line.60"></a> +<span class="sourceLineNo">061</span> * <p class='bcode'><a name="line.61"></a> +<span class="sourceLineNo">062</span> * <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/myurl/{0}/{1}/{2}/*"</js>)<a name="line.62"></a> +<span class="sourceLineNo">063</span> * <jk>public void</jk> doGet(RestRequest req, RestResponse res,<a name="line.63"></a> +<span class="sourceLineNo">064</span> * <ja>@Path</ja> String foo, <ja>@Path</ja> <jk>int</jk> bar, <ja>@Path</ja> UUID baz) {<a name="line.64"></a> +<span class="sourceLineNo">065</span> * ...<a name="line.65"></a> +<span class="sourceLineNo">066</span> * }<a name="line.66"></a> +<span class="sourceLineNo">067</span> * </p><a name="line.67"></a> +<span class="sourceLineNo">068</span> */<a name="line.68"></a> +<span class="sourceLineNo">069</span>@Documented<a name="line.69"></a> +<span class="sourceLineNo">070</span>@Target(PARAMETER)<a name="line.70"></a> +<span class="sourceLineNo">071</span>@Retention(RUNTIME)<a name="line.71"></a> +<span class="sourceLineNo">072</span>@Inherited<a name="line.72"></a> +<span class="sourceLineNo">073</span>public @interface Path {<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> /**<a name="line.75"></a> +<span class="sourceLineNo">076</span> * URL variable name.<a name="line.76"></a> +<span class="sourceLineNo">077</span> * <p><a name="line.77"></a> +<span class="sourceLineNo">078</span> * Optional if the attributes are specified in the same order as in the URL path pattern.<a name="line.78"></a> +<span class="sourceLineNo">079</span> */<a name="line.79"></a> +<span class="sourceLineNo">080</span> String value() default "";<a name="line.80"></a> +<span class="sourceLineNo">081</span>}<a name="line.81"></a>
