| <!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.httppart;<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><a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import java.lang.reflect.*;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>import java.util.regex.*;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.http.*;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.juneau.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.juneau.assertions.*;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.juneau.http.header.*;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.juneau.http.response.BasicHttpException;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.juneau.httppart.*;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.juneau.rest.*;<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> * Represents a single header on an HTTP request.<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> *<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <p><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * Typically accessed through the {@link RequestHeaders} class.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> *<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <p><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Some important methods on this class are:<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * </p><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <ul class='javatree'><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <li class='jc'>{@link RequestHeader}<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <ul class='spaced-list'><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <li>Methods for retrieving simple string values:<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <ul class='javatreec'><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <li class='jm'>{@link RequestHeader#asString() asString()}<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <li class='jm'>{@link RequestHeader#get() get()}<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <li class='jm'>{@link RequestHeader#isPresent() isPresent()}<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <li class='jm'>{@link RequestHeader#orElse(String) orElse(String)}<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * </ul><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <li>Methods for retrieving as other common types:<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <ul class='javatreec'><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <li class='jm'>{@link RequestHeader#asBoolean() asBoolean()}<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <li class='jm'>{@link RequestHeader#asBooleanHeader() asBooleanHeader()}<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <li class='jm'>{@link RequestHeader#asCsvArray() asCsvArray()}<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <li class='jm'>{@link RequestHeader#asCsvHeader() asCsvArrayHeader()}<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <li class='jm'>{@link RequestHeader#asDate() asDate()}<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * <li class='jm'>{@link RequestHeader#asDateHeader() asDateHeader()}<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <li class='jm'>{@link RequestHeader#asEntityTagsHeader() asEntityTagArrayHeader()}<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <li class='jm'>{@link RequestHeader#asEntityTagHeader() asEntityTagHeader()}<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <li class='jm'>{@link RequestHeader#asInteger() asInteger()}<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <li class='jm'>{@link RequestHeader#asIntegerHeader() asIntegerHeader()}<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * <li class='jm'>{@link RequestHeader#asLong() asLong()}<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <li class='jm'>{@link RequestHeader#asLongHeader() asLongHeader()}<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <li class='jm'>{@link RequestHeader#asMatcher(Pattern) asMatcher(Pattern)}<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * <li class='jm'>{@link RequestHeader#asMatcher(String) asMatcher(String)}<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <li class='jm'>{@link RequestHeader#asMatcher(String,int) asMatcher(String,int)}<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * <li class='jm'>{@link RequestHeader#asStringHeader() asStringHeader()}<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <li class='jm'>{@link RequestHeader#asStringRangesHeader() asStringRangeArrayHeader()}<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * <li class='jm'>{@link RequestHeader#asUriHeader() asUriHeader()}<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * </ul><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <li>Methods for retrieving as custom types:<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <ul class='javatreec'><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * <li class='jm'>{@link RequestHeader#as(Class) as(Class)}<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * <li class='jm'>{@link RequestHeader#as(ClassMeta) as(ClassMeta)}<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * <li class='jm'>{@link RequestHeader#as(Type,Type...) as(Type,Type...)}<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <li class='jm'>{@link RequestHeader#parser(HttpPartParserSession) parser(HttpPartParserSession)}<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * <li class='jm'>{@link RequestHeader#schema(HttpPartSchema) schema(HttpPartSchema)}<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * </ul><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * <li>Methods for performing assertion checks:<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * <ul class='javatreec'><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <li class='jm'>{@link RequestHeader#assertCsvArray() assertCsvArray()}<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * <li class='jm'>{@link RequestHeader#assertDate() assertDate()}<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * <li class='jm'>{@link RequestHeader#assertInteger() assertInteger()}<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <li class='jm'>{@link RequestHeader#assertLong() assertLong()}<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <li class='jm'>{@link RequestHeader#assertString() assertString()}<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * </ul><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * <li>Other methods:<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * <ul class='javatreec'><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <li class='jm'>{@link RequestHeader#getName() getName()}<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <li class='jm'>{@link RequestHeader#getValue() getValue()}<a name="line.87"></a> |
| <span class="sourceLineNo">088</span>* </ul><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * </ul><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> *<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * <ul class='seealso'><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * <li class='link'>{@doc jrs.HttpParts}<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * <li class='extlink'>{@source}<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * </ul><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span>public class RequestHeader extends RequestHttpPart implements Header {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> private String value;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> /**<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * Constructor.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> *<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @param request The request object.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @param name The header name.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @param value The header value.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> */<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> public RequestHeader(RestRequest request, String name, String value) {<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> super(HEADER, request, name);<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> this.value = value;<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> }<a name="line.110"></a> |
| <span class="sourceLineNo">111</span><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> /**<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * Sets a default value for this part.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> *<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @param def The default value.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @return This object.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> public RequestHeader def(String def) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> if (value == null)<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> value = def;<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> return this;<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> }<a name="line.122"></a> |
| <span class="sourceLineNo">123</span><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> //------------------------------------------------------------------------------------------------------------------<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> // Retrievers<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> //------------------------------------------------------------------------------------------------------------------<a name="line.126"></a> |
| <span class="sourceLineNo">127</span><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> @Override /* RequestHttpPart */<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> public String getValue() {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> return value;<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> }<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> /**<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * Returns the value of this header as a {@link BasicCsvHeader}.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> *<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * @return The value of this header as a {@link BasicCsvHeader}, never <jk>null</jk>.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> */<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> public BasicCsvHeader asCsvHeader() {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> return new BasicCsvHeader(getName(), getValue());<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> }<a name="line.140"></a> |
| <span class="sourceLineNo">141</span><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> /**<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * Returns the value of this header as a {@link BasicDateHeader}.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> *<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @return The value of this header as a {@link BasicDateHeader}, never <jk>null</jk>.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> public BasicDateHeader asDateHeader() {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> return new BasicDateHeader(getName(), getValue());<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> }<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> /**<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * Returns the value of this header as a {@link BasicEntityTagsHeader}.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> *<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * @return The value of this header as a {@link BasicEntityTagsHeader}, never <jk>null</jk>.<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> */<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> public BasicEntityTagsHeader asEntityTagsHeader() {<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> return new BasicEntityTagsHeader(getName(), getValue());<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> }<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> /**<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * Returns the value of this header as a {@link BasicEntityTagHeader}.<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> *<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @return The value of this header as a {@link BasicEntityTagHeader}, never <jk>null</jk>.<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> */<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> public BasicEntityTagHeader asEntityTagHeader() {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> return new BasicEntityTagHeader(getName(), getValue());<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> }<a name="line.167"></a> |
| <span class="sourceLineNo">168</span><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> /**<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * Returns the value of this header as a {@link BasicIntegerHeader}.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> *<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * @return The value of this header as a {@link BasicIntegerHeader}, never <jk>null</jk>.<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> */<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> public BasicIntegerHeader asIntegerHeader() {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> return new BasicIntegerHeader(getName(), getValue());<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> /**<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * Returns the value of this header as a {@link BasicBooleanHeader}.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> *<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @return The value of this header as a {@link BasicBooleanHeader}, never <jk>null</jk>.<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> */<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> public BasicBooleanHeader asBooleanHeader() {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> return new BasicBooleanHeader(getName(), getValue());<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> }<a name="line.185"></a> |
| <span class="sourceLineNo">186</span><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> /**<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * Returns the value of this header as a {@link BasicLongHeader}.<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> *<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * @return The value of this header as a {@link BasicLongHeader}, never <jk>null</jk>.<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> */<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> public BasicLongHeader asLongHeader() {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> return new BasicLongHeader(getName(), getValue());<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> }<a name="line.194"></a> |
| <span class="sourceLineNo">195</span><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> /**<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * Returns the value of this header as a {@link BasicStringRangesHeader}.<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> *<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * @return The value of this header as a {@link BasicStringRangesHeader}, never <jk>null</jk>.<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> */<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> public BasicStringRangesHeader asStringRangesHeader() {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> return new BasicStringRangesHeader(getName(), getValue());<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span> /**<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * Returns the value of this header as a {@link BasicStringHeader}.<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> *<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * @return The value of this header as a {@link BasicStringHeader}, never <jk>null</jk>.<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> */<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> public BasicStringHeader asStringHeader() {<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> return new BasicStringHeader(getName(), getValue());<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> }<a name="line.212"></a> |
| <span class="sourceLineNo">213</span><a name="line.213"></a> |
| <span class="sourceLineNo">214</span> /**<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * Returns the value of this header as a {@link BasicUriHeader}.<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> *<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * @return The value of this header as a {@link BasicUriHeader}, never <jk>null</jk>.<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> */<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> public BasicUriHeader asUriHeader() {<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> return new BasicUriHeader(getName(), getValue());<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> }<a name="line.221"></a> |
| <span class="sourceLineNo">222</span><a name="line.222"></a> |
| <span class="sourceLineNo">223</span> //------------------------------------------------------------------------------------------------------------------<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> // Assertions<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> /**<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * Provides the ability to perform fluent-style assertions on this parameter.<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> *<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * <h5 class='section'>Examples:</h5><a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * <p class='bjava'><a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * <jv>request</jv><a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * .getHeader(<js>"foo"</js>)<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * .assertString().contains(<js>"bar"</js>);<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * </p><a name="line.235"></a> |
| <span class="sourceLineNo">236</span> *<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * <p><a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * The assertion test returns the original object allowing you to chain multiple requests like so:<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * <p class='bjava'><a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * String <jv>foo</jv> = <jv>request</jv><a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * .getHeader(<js>"foo"</js>)<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * .assertString().contains(<js>"bar"</js>)<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * .asString().get();<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * </p><a name="line.244"></a> |
| <span class="sourceLineNo">245</span> *<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * @return A new fluent assertion object.<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> */<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> public FluentStringAssertion<RequestHeader> assertString() {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> return new FluentStringAssertion<>(orElse(null), this);<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> }<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> * Provides the ability to perform fluent-style assertions on an integer parameter.<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> *<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * <h5 class='section'>Examples:</h5><a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * <p class='bjava'><a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * <jv>request</jv><a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * .getHeader(<js>"age"</js>)<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * .assertInteger().isGreaterThan(1);<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * </p><a name="line.260"></a> |
| <span class="sourceLineNo">261</span> *<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * @return A new fluent assertion object.<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> */<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> public FluentIntegerAssertion<RequestHeader> assertInteger() {<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> return new FluentIntegerAssertion<>(asIntegerPart().asInteger().orElse(null), this);<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> }<a name="line.266"></a> |
| <span class="sourceLineNo">267</span><a name="line.267"></a> |
| <span class="sourceLineNo">268</span> /**<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * Provides the ability to perform fluent-style assertions on a long parameter.<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> *<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * <h5 class='section'>Examples:</h5><a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * <p class='bjava'><a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * <jv>request</jv><a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * .getHeader(<js>"length"</js>)<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * .assertLong().isLessThan(100000);<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * </p><a name="line.276"></a> |
| <span class="sourceLineNo">277</span> *<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * @return A new fluent assertion object.<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> */<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> public FluentLongAssertion<RequestHeader> assertLong() {<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> return new FluentLongAssertion<>(asLongPart().asLong().orElse(null), this);<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> }<a name="line.282"></a> |
| <span class="sourceLineNo">283</span><a name="line.283"></a> |
| <span class="sourceLineNo">284</span> /**<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * Provides the ability to perform fluent-style assertions on a date parameter.<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> *<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * <h5 class='section'>Examples:</h5><a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * <p class='bjava'><a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * <jv>request</jv><a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * .getHeader(<js>"time"</js>)<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * .assertDate().isAfterNow();<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * </p><a name="line.292"></a> |
| <span class="sourceLineNo">293</span> *<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * @return A new fluent assertion object.<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> */<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> public FluentZonedDateTimeAssertion<RequestHeader> assertDate() {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> return new FluentZonedDateTimeAssertion<>(asDatePart().asZonedDateTime().orElse(null), this);<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> * Provides the ability to perform fluent-style assertions on comma-separated string parameters.<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> *<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * <h5 class='section'>Examples:</h5><a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * <p class='bjava'><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> * <jv>request</jv><a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * .getHeader(<js>"allow"</js>)<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * .assertCsvArray().contains(<js>"GET"</js>);<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * </p><a name="line.308"></a> |
| <span class="sourceLineNo">309</span> *<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * @return A new fluent assertion object.<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> */<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> public FluentListAssertion<String,RequestHeader> assertCsvArray() {<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> return new FluentListAssertion<>(asCsvArrayPart().asList().orElse(null), this);<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> /**<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * Parses the value.<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> *<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * @return An array of {@link HeaderElement} entries, may be empty, but is never <jk>null</jk>.<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * @throws BasicHttpException In case of a parsing error.<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> */<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> @Override /* Header */<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> public HeaderElement[] getElements() throws BasicHttpException {<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> return new HeaderElement[0];<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> }<a name="line.325"></a> |
| <span class="sourceLineNo">326</span><a name="line.326"></a> |
| <span class="sourceLineNo">327</span> @Override /* Object */<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> public String toString() {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> return getName() + ": " + getValue();<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> }<a name="line.330"></a> |
| <span class="sourceLineNo">331</span><a name="line.331"></a> |
| <span class="sourceLineNo">332</span> // <FluentSetters><a name="line.332"></a> |
| <span class="sourceLineNo">333</span><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> @Override /* GENERATED */<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> public RequestHeader schema(HttpPartSchema value) {<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> super.schema(value);<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> return this;<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> }<a name="line.338"></a> |
| <span class="sourceLineNo">339</span><a name="line.339"></a> |
| <span class="sourceLineNo">340</span> @Override /* GENERATED */<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> public RequestHeader parser(HttpPartParserSession value) {<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> super.parser(value);<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> return this;<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> }<a name="line.344"></a> |
| <span class="sourceLineNo">345</span><a name="line.345"></a> |
| <span class="sourceLineNo">346</span> // </FluentSetters><a name="line.346"></a> |
| <span class="sourceLineNo">347</span>}<a name="line.347"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
