| <!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.client;<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.httppart.HttpPartType.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span>import static org.apache.juneau.internal.ClassUtils.*;<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import static org.apache.juneau.internal.CollectionUtils.*;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>import static org.apache.juneau.internal.ThrowableUtils.*;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.lang.reflect.*;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.time.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.*;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.regex.*;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.http.*;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.juneau.*;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.juneau.assertions.*;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.juneau.http.header.*;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.juneau.httppart.*;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.juneau.oapi.*;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.juneau.parser.ParseException;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.juneau.reflect.*;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.juneau.rest.client.assertion.*;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>/**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Represents a single header on an HTTP response.<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> * An extension of an HttpClient {@link Header} that provides various support for converting the header to POJOs and<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * other convenience methods.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <ul class='seealso'><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <li class='link'>{@doc juneau-rest-client}<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <li class='extlink'>{@source}<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * </ul><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>public class ResponseHeader extends BasicHeader {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private static final long serialVersionUID = 1L;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> static final Header NULL_HEADER = new Header() {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> @Override /* Header */<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> public String getName() {<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> return null;<a name="line.55"></a> |
| <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> @Override /* Header */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> public String getValue() {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> return null;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> }<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> @Override /* Header */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> public HeaderElement[] getElements() throws org.apache.http.ParseException {<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> return new HeaderElement[0];<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> }<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> };<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> private final HeaderElement[] elements;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> private final RestRequest request;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> private final RestResponse response;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> private HttpPartParserSession parser;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private HttpPartSchema schema;<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> * Constructor.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @param name The header name.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param request The request object.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @param response The response object.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @param header The wrapped header. Can be <jk>null</jk>.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @throws IllegalArgumentException If name is <jk>null</jk> or empty.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> */<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> public ResponseHeader(String name, RestRequest request, RestResponse response, Header header) {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> super(name, header == null ? null : header.getValue());<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> this.request = request;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> this.response = response;<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> this.elements = header == null ? new HeaderElement[0] : header.getElements();<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> parser(null);<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> }<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> //------------------------------------------------------------------------------------------------------------------<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> // Setters<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> //------------------------------------------------------------------------------------------------------------------<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> /**<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * Specifies the part schema for this header.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> *<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * <p><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * Used by schema-based part parsers such as {@link OpenApiParser}.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> *<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @param value<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * The part schema.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @return This object.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public ResponseHeader schema(HttpPartSchema value) {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> this.schema = value;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return this;<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Specifies the part parser to use for this header.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> *<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * <p><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * If not specified, uses the part parser defined on the client by calling {@link RestClient.Builder#partParser(Class)}.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> *<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param value<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * The new part parser to use for this header.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * <br>If <jk>null</jk>, {@link SimplePartParser#DEFAULT} will be used.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @return This object.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> */<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> public ResponseHeader parser(HttpPartParserSession value) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> this.parser = value == null ? SimplePartParser.DEFAULT_SESSION : value;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> return this;<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> }<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> //------------------------------------------------------------------------------------------------------------------<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> // Retrievers<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> //------------------------------------------------------------------------------------------------------------------<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> /**<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * Returns the value of this header as an integer.<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> *<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @return The value of this header as an integer, or {@link Optional#empty()} if the header was not present.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> */<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> public Optional<Integer> asInteger() {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> return asIntegerHeader().asInteger();<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> /**<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * Returns the value of this header as a boolean.<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> *<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * @return The value of this header as a boolean, or {@link Optional#empty()} if the header was not present.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> public Optional<Boolean> asBoolean() {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> return asBooleanHeader().asBoolean();<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> }<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> /**<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * Returns the value of this header as a long.<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> *<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * @return The value of this header as a long, or {@link Optional#empty()} if the header was not present.<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> */<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> public Optional<Long> asLong() {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> return asLongHeader().asLong();<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> }<a name="line.155"></a> |
| <span class="sourceLineNo">156</span><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> /**<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * Returns the value of this header as a date.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> *<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * @return The value of this header as a date, or {@link Optional#empty()} if the header was not present.<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> */<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> public Optional<ZonedDateTime> asDate() {<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> return asDateHeader().asZonedDateTime();<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> /**<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * Returns the value of this header as a list from a comma-delimited string.<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> *<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @return The value of this header as a list from a comma-delimited string, or {@link Optional#empty()} if the header was not present.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> */<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> public Optional<String[]> asCsvArray() {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> return asCsvHeader().asArray();<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> /**<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * Returns the value of this header as a {@link BasicHeader}.<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> *<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * @param c The subclass of {@link BasicHeader} to instantiate.<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * @param <T> The subclass of {@link BasicHeader} to instantiate.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @return The value of this header as a string, never <jk>null</jk>.<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> */<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> public <T extends BasicHeader> T asHeader(Class<T> c) {<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> try {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> ClassInfo ci = ClassInfo.of(c);<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> ConstructorInfo cc = ci.getPublicConstructor(x -> x.hasParamTypes(String.class));<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> if (cc != null)<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> return cc.invoke(getValue());<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> cc = ci.getPublicConstructor(x -> x.hasParamTypes(String.class, String.class));<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> if (cc != null)<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> return cc.invoke(getName(), getValue());<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> } catch (Throwable e) {<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> if (e instanceof ExecutableException)<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> e = ((ExecutableException)e).getCause();<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> throw runtimeException(e);<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> throw runtimeException("Could not determine a method to construct type {0}", className(c));<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> /**<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * Returns the value of this header as a CSV array header.<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> *<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * @return The value of this header as a CSV array header, never <jk>null</jk>.<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> */<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> public BasicCsvHeader asCsvHeader() {<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> return new BasicCsvHeader(getName(), getValue());<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> |
| <span class="sourceLineNo">208</span> /**<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * Returns the value of this header as a date header.<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> *<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * @return The value of this header as a date header, never <jk>null</jk>.<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> */<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> public BasicDateHeader asDateHeader() {<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> return new BasicDateHeader(getName(), getValue());<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> }<a name="line.215"></a> |
| <span class="sourceLineNo">216</span><a name="line.216"></a> |
| <span class="sourceLineNo">217</span> /**<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * Returns the value of this header as an entity validator array header.<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> *<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * @return The value of this header as an entity validator array header, never <jk>null</jk>.<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> */<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> public BasicEntityTagsHeader asEntityTagsHeader() {<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> return new BasicEntityTagsHeader(getName(), getValue());<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> }<a name="line.224"></a> |
| <span class="sourceLineNo">225</span><a name="line.225"></a> |
| <span class="sourceLineNo">226</span> /**<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * Returns the value of this header as an entity validator header.<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> *<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * @return The value of this header as an entity validator array, never <jk>null</jk>.<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> */<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> public BasicEntityTagHeader asEntityTagHeader() {<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> return new BasicEntityTagHeader(getName(), getValue());<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> }<a name="line.233"></a> |
| <span class="sourceLineNo">234</span><a name="line.234"></a> |
| <span class="sourceLineNo">235</span> /**<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * Returns the value of this header as an integer header.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> *<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * @return The value of this header as an integer header, never <jk>null</jk>.<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> */<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> public BasicIntegerHeader asIntegerHeader() {<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> return new BasicIntegerHeader(getName(), getValue());<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> }<a name="line.242"></a> |
| <span class="sourceLineNo">243</span><a name="line.243"></a> |
| <span class="sourceLineNo">244</span> /**<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * Returns the value of this header as an boolean header.<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> *<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * @return The value of this header as an boolean header, never <jk>null</jk>.<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> */<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> public BasicBooleanHeader asBooleanHeader() {<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> return new BasicBooleanHeader(getName(), getValue());<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span><a name="line.252"></a> |
| <span class="sourceLineNo">253</span> /**<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * Returns the value of this header as a long header.<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> *<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * @return The value of this header as a long header, never <jk>null</jk>.<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> */<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> public BasicLongHeader asLongHeader() {<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> return new BasicLongHeader(getName(), getValue());<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> }<a name="line.260"></a> |
| <span class="sourceLineNo">261</span><a name="line.261"></a> |
| <span class="sourceLineNo">262</span> /**<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * Returns the value of this header as a range array header.<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> *<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * @return The value of this header as a range array header, never <jk>null</jk>.<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> */<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> public BasicStringRangesHeader asStringRangesHeader() {<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> return new BasicStringRangesHeader(getName(), getValue());<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> }<a name="line.269"></a> |
| <span class="sourceLineNo">270</span><a name="line.270"></a> |
| <span class="sourceLineNo">271</span> /**<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * Returns the value of this header as a string header.<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> *<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * @return The value of this header as a string header, never <jk>null</jk>.<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> */<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> public BasicStringHeader asStringHeader() {<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> return new BasicStringHeader(getName(), getValue());<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> }<a name="line.278"></a> |
| <span class="sourceLineNo">279</span><a name="line.279"></a> |
| <span class="sourceLineNo">280</span> /**<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * Returns the value of this header as a URI header.<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> *<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * @return The value of this header as a URI header, never <jk>null</jk>.<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> */<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> public BasicUriHeader asUriHeader() {<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> return new BasicUriHeader(getName(), getValue());<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> }<a name="line.287"></a> |
| <span class="sourceLineNo">288</span><a name="line.288"></a> |
| <span class="sourceLineNo">289</span> /**<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * Same as {@link #asString()} but sets the value in a mutable for fluent calls.<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> *<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * @param value The mutable to set the header value in.<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> * @return This object.<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> */<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> public RestResponse asString(Value<String> value) {<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> value.set(orElse(null));<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> return response;<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> }<a name="line.298"></a> |
| <span class="sourceLineNo">299</span><a name="line.299"></a> |
| <span class="sourceLineNo">300</span> /**<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * Converts this header to the specified type.<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> *<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * <p><a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * See {@doc jm.ComplexDataTypes Complex Data Types} for information on defining complex generic types of {@link Map Maps} and {@link Collection Collections}.<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> *<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * @param <T> The type to convert to.<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * @param type The type to convert to.<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * @param args The type parameters.<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * @return The converted type, or <jk>null</jk> if header is not present.<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> */<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> public <T> Optional<T> as(Type type, Type...args) {<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> return as(request.getClassMeta(type, args));<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> }<a name="line.313"></a> |
| <span class="sourceLineNo">314</span><a name="line.314"></a> |
| <span class="sourceLineNo">315</span> /**<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * Same as {@link #as(Type,Type...)} but sets the value in a mutable for fluent calls.<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> *<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * <p><a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * See {@doc jm.ComplexDataTypes Complex Data Types} for information on defining complex generic types of {@link Map Maps} and {@link Collection Collections}.<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> *<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * @param value The mutable to set the parsed header value in.<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * @param <T> The type to convert to.<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * @param type The type to convert to.<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * @param args The type parameters.<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * @return This object.<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> */<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> @SuppressWarnings("unchecked")<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> public <T> RestResponse as(Value<T> value, Type type, Type...args) {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> value.set((T)as(type, args).orElse(null));<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> return response;<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> }<a name="line.331"></a> |
| <span class="sourceLineNo">332</span><a name="line.332"></a> |
| <span class="sourceLineNo">333</span> /**<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * Converts this header to the specified type.<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> *<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * @param <T> The type to convert to.<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * @param type The type to convert to.<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * @return The converted type, or <jk>null</jk> if header is not present.<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> */<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> public <T> Optional<T> as(Class<T> type) {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> return as(request.getClassMeta(type));<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> }<a name="line.342"></a> |
| <span class="sourceLineNo">343</span><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> /**<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> * Same as {@link #as(Class)} but sets the value in a mutable for fluent calls.<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> *<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> * @param value The mutable to set the parsed header value in.<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> * @param <T> The type to convert to.<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> * @param type The type to convert to.<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * @return This object.<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> */<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> public <T> RestResponse as(Value<T> value, Class<T> type) {<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> value.set(as(type).orElse(null));<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> return response;<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> }<a name="line.355"></a> |
| <span class="sourceLineNo">356</span><a name="line.356"></a> |
| <span class="sourceLineNo">357</span> /**<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * Converts this header to the specified type.<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> *<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * @param <T> The type to convert to.<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> * @param type The type to convert to.<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> * @return The converted type, or <jk>null</jk> if header is not present.<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> */<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> public <T> Optional<T> as(ClassMeta<T> type) {<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> try {<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> return optional(parser.parse(HEADER, schema, getValue(), type));<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> } catch (ParseException e) {<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> throw BasicRuntimeException.create().causedBy(e).message("Could not parse response header {0}.", getName()).build();<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> }<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> }<a name="line.370"></a> |
| <span class="sourceLineNo">371</span><a name="line.371"></a> |
| <span class="sourceLineNo">372</span> /**<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> * Same as {@link #as(ClassMeta)} but sets the value in a mutable for fluent calls.<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> *<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> * @param value The mutable to set the parsed header value in.<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> * @param <T> The type to convert to.<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> * @param type The type to convert to.<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> * @return This object.<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> */<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> public <T> RestResponse as(Value<T> value, ClassMeta<T> type) {<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> value.set(as(type).orElse(null));<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> return response;<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> }<a name="line.383"></a> |
| <span class="sourceLineNo">384</span><a name="line.384"></a> |
| <span class="sourceLineNo">385</span> /**<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * Matches the specified pattern against this header value.<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> *<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> * <h5 class='section'>Example:</h5><a name="line.388"></a> |
| <span class="sourceLineNo">389</span> * <p class='bjava'><a name="line.389"></a> |
| <span class="sourceLineNo">390</span> * <jc>// Parse header using a regular expression.</jc><a name="line.390"></a> |
| <span class="sourceLineNo">391</span> * Matcher <jv>matcher</jv> = <jv>client</jv><a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * .get(<jsf>URI</jsf>)<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> * .run()<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> * .getResponseHeader(<js>"Content-Type"</js>).asMatcher(Pattern.<jsm>compile</jsm>(<js>"application/(.*)"</js>));<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> *<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> * <jk>if</jk> (<jv>matcher</jv>.matches()) {<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> * String <jv>mediaType</jv> = <jv>matcher</jv>.group(1);<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> * }<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * </p><a name="line.399"></a> |
| <span class="sourceLineNo">400</span> *<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> * @param pattern The regular expression pattern to match.<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> * @return The matcher.<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> */<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> public Matcher asMatcher(Pattern pattern) {<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> return pattern.matcher(orElse(""));<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> }<a name="line.406"></a> |
| <span class="sourceLineNo">407</span><a name="line.407"></a> |
| <span class="sourceLineNo">408</span> /**<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> * Matches the specified pattern against this header value.<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> *<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> * <h5 class='section'>Example:</h5><a name="line.411"></a> |
| <span class="sourceLineNo">412</span> * <p class='bjava'><a name="line.412"></a> |
| <span class="sourceLineNo">413</span> * <jc>// Parse header using a regular expression.</jc><a name="line.413"></a> |
| <span class="sourceLineNo">414</span> * Matcher <jv>matcher</jv> = <jv>client</jv><a name="line.414"></a> |
| <span class="sourceLineNo">415</span> * .get(<jsf>URI</jsf>)<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> * .run()<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> * .getHeader(<js>"Content-Type"</js>).asMatcher(<js>"application/(.*)"</js>);<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> *<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> * <jk>if</jk> (<jv>matcher</jv>.matches()) {<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> * String <jv>mediaType</jv> = <jv>matcher</jv>.group(1);<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> * }<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> * </p><a name="line.422"></a> |
| <span class="sourceLineNo">423</span> *<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> * @param regex The regular expression pattern to match.<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> * @return The matcher.<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> */<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> public Matcher asMatcher(String regex) {<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> return asMatcher(regex, 0);<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> }<a name="line.429"></a> |
| <span class="sourceLineNo">430</span><a name="line.430"></a> |
| <span class="sourceLineNo">431</span> /**<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> * Matches the specified pattern against this header value.<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> *<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> * <h5 class='section'>Example:</h5><a name="line.434"></a> |
| <span class="sourceLineNo">435</span> * <p class='bjava'><a name="line.435"></a> |
| <span class="sourceLineNo">436</span> * <jc>// Parse header using a regular expression.</jc><a name="line.436"></a> |
| <span class="sourceLineNo">437</span> * Matcher <jv>matcher</jv> = <jv>client</jv><a name="line.437"></a> |
| <span class="sourceLineNo">438</span> * .get(<jsf>URI</jsf>)<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> * .run()<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> * .getHeader(<js>"Content-Type"</js>).asMatcher(<js>"application/(.*)"</js>, <jsf>CASE_INSENSITIVE</jsf>);<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> *<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> * <jk>if</jk> (<jv>matcher</jv>.matches()) {<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> * String <jv>mediaType</jv> = <jv>matcher</jv>.group(1);<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> * }<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> * </p><a name="line.445"></a> |
| <span class="sourceLineNo">446</span> *<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> * @param regex The regular expression pattern to match.<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> * @param flags Pattern match flags. See {@link Pattern#compile(String, int)}.<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> * @return The matcher.<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> */<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> public Matcher asMatcher(String regex, int flags) {<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> return asMatcher(Pattern.compile(regex, flags));<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> }<a name="line.453"></a> |
| <span class="sourceLineNo">454</span><a name="line.454"></a> |
| <span class="sourceLineNo">455</span> //------------------------------------------------------------------------------------------------------------------<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> // Assertions<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> //------------------------------------------------------------------------------------------------------------------<a name="line.457"></a> |
| <span class="sourceLineNo">458</span><a name="line.458"></a> |
| <span class="sourceLineNo">459</span> /**<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> * Provides the ability to perform fluent-style assertions on this response header.<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> *<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> * <h5 class='section'>Examples:</h5><a name="line.462"></a> |
| <span class="sourceLineNo">463</span> * <p class='bjava'><a name="line.463"></a> |
| <span class="sourceLineNo">464</span> * <jc>// Validates the content type header is provided.</jc><a name="line.464"></a> |
| <span class="sourceLineNo">465</span> * <jv>client</jv><a name="line.465"></a> |
| <span class="sourceLineNo">466</span> * .get(<jsf>URI</jsf>)<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> * .run()<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> * .getHeader(<js>"Content-Type"</js>).assertValue().exists();<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> *<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> * <jc>// Validates the content type is JSON.</jc><a name="line.470"></a> |
| <span class="sourceLineNo">471</span> * <jv>client</jv><a name="line.471"></a> |
| <span class="sourceLineNo">472</span> * .get(<jsf>URI</jsf>)<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> * .run()<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> * .getHeader(<js>"Content-Type"</js>).assertValue().equals(<js>"application/json"</js>);<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> *<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> * <jc>// Validates the content type is JSON using test predicate.</jc><a name="line.476"></a> |
| <span class="sourceLineNo">477</span> * <jv>client</jv><a name="line.477"></a> |
| <span class="sourceLineNo">478</span> * .get(<jsf>URI</jsf>)<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> * .run()<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> * .getHeader(<js>"Content-Type"</js>).assertValue().is(<jv>x</jv> -&gt; <jv>x</jv>.equals(<js>"application/json"</js>));<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> *<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> * <jc>// Validates the content type is JSON by just checking for substring.</jc><a name="line.482"></a> |
| <span class="sourceLineNo">483</span> * <jv>client</jv><a name="line.483"></a> |
| <span class="sourceLineNo">484</span> * .get(<jsf>URI</jsf>)<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> * .run()<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> * .getHeader(<js>"Content-Type"</js>).assertValue().contains(<js>"json"</js>);<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> *<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> * <jc>// Validates the content type is JSON using regular expression.</jc><a name="line.488"></a> |
| <span class="sourceLineNo">489</span> * <jv>client</jv><a name="line.489"></a> |
| <span class="sourceLineNo">490</span> * .get(<jsf>URI</jsf>)<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> * .run()<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> * .getHeader(<js>"Content-Type"</js>).assertValue().isPattern(<js>".*json.*"</js>);<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> *<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> * <jc>// Validates the content type is JSON using case-insensitive regular expression.</jc><a name="line.494"></a> |
| <span class="sourceLineNo">495</span> * <jv>client</jv><a name="line.495"></a> |
| <span class="sourceLineNo">496</span> * .get(<jsf>URI</jsf>)<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> * .run()<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> * .getHeader(<js>"Content-Type"</js>).assertValue().isPattern(<js>".*json.*"</js>, <jsf>CASE_INSENSITIVE</jsf>);<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> * </p><a name="line.499"></a> |
| <span class="sourceLineNo">500</span> *<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> * <p><a name="line.501"></a> |
| <span class="sourceLineNo">502</span> * The assertion test returns the original response object allowing you to chain multiple requests like so:<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> * <p class='bjava'><a name="line.503"></a> |
| <span class="sourceLineNo">504</span> * <jc>// Validates the header and converts it to a bean.</jc><a name="line.504"></a> |
| <span class="sourceLineNo">505</span> * MediaType <jv>mediaType</jv> = <jv>client</jv><a name="line.505"></a> |
| <span class="sourceLineNo">506</span> * .get(<jsf>URI</jsf>)<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> * .run()<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> * .getHeader(<js>"Content-Type"</js>).assertValue().isNotEmpty()<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> * .getHeader(<js>"Content-Type"</js>).assertValue().isPattern(<js>".*json.*"</js>)<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> * .getHeader(<js>"Content-Type"</js>).as(MediaType.<jk>class</jk>);<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> * </p><a name="line.511"></a> |
| <span class="sourceLineNo">512</span> *<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> * @return A new fluent assertion object.<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> */<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> public FluentResponseHeaderAssertion<ResponseHeader> assertValue() {<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> return new FluentResponseHeaderAssertion<>(this, this);<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> }<a name="line.517"></a> |
| <span class="sourceLineNo">518</span><a name="line.518"></a> |
| <span class="sourceLineNo">519</span> /**<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> * Shortcut for calling <c>assertValue().asString()</c>.<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> *<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> * @return A new fluent assertion.<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> */<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> public FluentStringAssertion<ResponseHeader> assertString() {<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> return new FluentResponseHeaderAssertion<>(this, this).asString();<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> }<a name="line.526"></a> |
| <span class="sourceLineNo">527</span><a name="line.527"></a> |
| <span class="sourceLineNo">528</span> /**<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> * Shortcut for calling <c>assertValue().asInteger()</c>.<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> *<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> * @return A new fluent assertion.<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> */<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> public FluentIntegerAssertion<ResponseHeader> assertInteger() {<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> return new FluentResponseHeaderAssertion<>(this, this).asInteger();<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> }<a name="line.535"></a> |
| <span class="sourceLineNo">536</span><a name="line.536"></a> |
| <span class="sourceLineNo">537</span> /**<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> * Shortcut for calling <c>assertValue().asLong()</c>.<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> *<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> * @return A new fluent assertion.<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> */<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> public FluentLongAssertion<ResponseHeader> assertLong() {<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> return new FluentResponseHeaderAssertion<>(this, this).asLong();<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> }<a name="line.544"></a> |
| <span class="sourceLineNo">545</span><a name="line.545"></a> |
| <span class="sourceLineNo">546</span> /**<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> * Shortcut for calling <c>assertValue().asZonedDateTime()</c>.<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> *<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> * @return A new fluent assertion.<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> */<a name="line.550"></a> |
| <span class="sourceLineNo">551</span> public FluentZonedDateTimeAssertion<ResponseHeader> assertZonedDateTime() {<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> return new FluentResponseHeaderAssertion<>(this, this).asZonedDateTime();<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> }<a name="line.553"></a> |
| <span class="sourceLineNo">554</span><a name="line.554"></a> |
| <span class="sourceLineNo">555</span> /**<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> * Returns the response that created this object.<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> *<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> * @return The response that created this object.<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> */<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> public RestResponse response() {<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> return response;<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> }<a name="line.562"></a> |
| <span class="sourceLineNo">563</span><a name="line.563"></a> |
| <span class="sourceLineNo">564</span> //------------------------------------------------------------------------------------------------------------------<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> // Header passthrough methods.<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> //------------------------------------------------------------------------------------------------------------------<a name="line.566"></a> |
| <span class="sourceLineNo">567</span><a name="line.567"></a> |
| <span class="sourceLineNo">568</span> /**<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> * Parses the value.<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> *<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> * @return An array of {@link HeaderElement} entries, may be empty, but is never <jk>null</jk>.<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> * @throws org.apache.http.ParseException In case of a parsing error.<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> */<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> @Override /* Header */<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> public HeaderElement[] getElements() throws org.apache.http.ParseException {<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> return elements;<a name="line.576"></a> |
| <span class="sourceLineNo">577</span> }<a name="line.577"></a> |
| <span class="sourceLineNo">578</span>}<a name="line.578"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
