http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/d35b70d1/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/SecurityScheme.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/SecurityScheme.html b/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/SecurityScheme.html index dbf624a..4de3df2 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/SecurityScheme.html +++ b/content/site/apidocs/src-html/org/apache/juneau/dto/swagger/SecurityScheme.html @@ -24,8 +24,8 @@ <span class="sourceLineNo">016</span><a name="line.16"></a> <span class="sourceLineNo">017</span>import java.util.*;<a name="line.17"></a> <span class="sourceLineNo">018</span><a name="line.18"></a> -<span class="sourceLineNo">019</span>import org.apache.juneau.annotation.*;<a name="line.19"></a> -<span class="sourceLineNo">020</span>import org.apache.juneau.json.*;<a name="line.20"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.juneau.annotation.*;<a name="line.20"></a> <span class="sourceLineNo">021</span><a name="line.21"></a> <span class="sourceLineNo">022</span>/**<a name="line.22"></a> <span class="sourceLineNo">023</span> * Allows the definition of a security scheme that can be used by the operations.<a name="line.23"></a> @@ -125,314 +125,315 @@ <span class="sourceLineNo">117</span> */<a name="line.117"></a> <span class="sourceLineNo">118</span> public SecurityScheme setType(String type) {<a name="line.118"></a> <span class="sourceLineNo">119</span> if (isStrict() && ! contains(type, VALID_TYPES))<a name="line.119"></a> -<span class="sourceLineNo">120</span> throw new RuntimeException(<a name="line.120"></a> -<span class="sourceLineNo">121</span> "Invalid value passed in to setType(String). Value='"+type+"', valid values="<a name="line.121"></a> -<span class="sourceLineNo">122</span> + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));<a name="line.122"></a> -<span class="sourceLineNo">123</span> this.type = type;<a name="line.123"></a> -<span class="sourceLineNo">124</span> return this;<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> /**<a name="line.127"></a> -<span class="sourceLineNo">128</span> * Synonym for {@link #setType(String)}.<a name="line.128"></a> -<span class="sourceLineNo">129</span> *<a name="line.129"></a> -<span class="sourceLineNo">130</span> * @param type The new value for the <property>type</property> property on this bean.<a name="line.130"></a> -<span class="sourceLineNo">131</span> * @return This object (for method chaining).<a name="line.131"></a> -<span class="sourceLineNo">132</span> */<a name="line.132"></a> -<span class="sourceLineNo">133</span> public SecurityScheme type(String type) {<a name="line.133"></a> -<span class="sourceLineNo">134</span> return setType(type);<a name="line.134"></a> -<span class="sourceLineNo">135</span> }<a name="line.135"></a> -<span class="sourceLineNo">136</span><a name="line.136"></a> -<span class="sourceLineNo">137</span> /**<a name="line.137"></a> -<span class="sourceLineNo">138</span> * Bean property getter: <property>description</property>.<a name="line.138"></a> -<span class="sourceLineNo">139</span> *<a name="line.139"></a> -<span class="sourceLineNo">140</span> * <p><a name="line.140"></a> -<span class="sourceLineNo">141</span> * A short description for security scheme.<a name="line.141"></a> -<span class="sourceLineNo">142</span> *<a name="line.142"></a> -<span class="sourceLineNo">143</span> * @return<a name="line.143"></a> -<span class="sourceLineNo">144</span> * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.144"></a> -<span class="sourceLineNo">145</span> */<a name="line.145"></a> -<span class="sourceLineNo">146</span> public String getDescription() {<a name="line.146"></a> -<span class="sourceLineNo">147</span> return description;<a name="line.147"></a> -<span class="sourceLineNo">148</span> }<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> * Bean property setter: <property>description</property>.<a name="line.151"></a> -<span class="sourceLineNo">152</span> *<a name="line.152"></a> -<span class="sourceLineNo">153</span> * <p><a name="line.153"></a> -<span class="sourceLineNo">154</span> * A short description for security scheme.<a name="line.154"></a> -<span class="sourceLineNo">155</span> *<a name="line.155"></a> -<span class="sourceLineNo">156</span> * @param description The new value for the <property>description</property> property on this bean.<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @return This object (for method chaining).<a name="line.157"></a> -<span class="sourceLineNo">158</span> */<a name="line.158"></a> -<span class="sourceLineNo">159</span> public SecurityScheme setDescription(String description) {<a name="line.159"></a> -<span class="sourceLineNo">160</span> this.description = description;<a name="line.160"></a> -<span class="sourceLineNo">161</span> return this;<a name="line.161"></a> -<span class="sourceLineNo">162</span> }<a name="line.162"></a> -<span class="sourceLineNo">163</span><a name="line.163"></a> -<span class="sourceLineNo">164</span> /**<a name="line.164"></a> -<span class="sourceLineNo">165</span> * Synonym for {@link #setDescription(String)}.<a name="line.165"></a> -<span class="sourceLineNo">166</span> *<a name="line.166"></a> -<span class="sourceLineNo">167</span> * @param description The new value for the <property>description</property> property on this bean.<a name="line.167"></a> -<span class="sourceLineNo">168</span> * @return This object (for method chaining).<a name="line.168"></a> -<span class="sourceLineNo">169</span> */<a name="line.169"></a> -<span class="sourceLineNo">170</span> public SecurityScheme description(String description) {<a name="line.170"></a> -<span class="sourceLineNo">171</span> return setDescription(description);<a name="line.171"></a> -<span class="sourceLineNo">172</span> }<a name="line.172"></a> -<span class="sourceLineNo">173</span><a name="line.173"></a> -<span class="sourceLineNo">174</span> /**<a name="line.174"></a> -<span class="sourceLineNo">175</span> * Bean property getter: <property>name</property>.<a name="line.175"></a> -<span class="sourceLineNo">176</span> *<a name="line.176"></a> -<span class="sourceLineNo">177</span> * <p><a name="line.177"></a> -<span class="sourceLineNo">178</span> * The name of the header or query parameter to be used.<a name="line.178"></a> -<span class="sourceLineNo">179</span> *<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.180"></a> -<span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> public String getName() {<a name="line.182"></a> -<span class="sourceLineNo">183</span> return name;<a name="line.183"></a> -<span class="sourceLineNo">184</span> }<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> * Bean property setter: <property>name</property>.<a name="line.187"></a> -<span class="sourceLineNo">188</span> *<a name="line.188"></a> -<span class="sourceLineNo">189</span> * <p><a name="line.189"></a> -<span class="sourceLineNo">190</span> * The name of the header or query parameter to be used.<a name="line.190"></a> -<span class="sourceLineNo">191</span> *<a name="line.191"></a> -<span class="sourceLineNo">192</span> * @param name The new value for the <property>name</property> property on this bean.<a name="line.192"></a> -<span class="sourceLineNo">193</span> * @return This object (for method chaining).<a name="line.193"></a> -<span class="sourceLineNo">194</span> */<a name="line.194"></a> -<span class="sourceLineNo">195</span> public SecurityScheme setName(String name) {<a name="line.195"></a> -<span class="sourceLineNo">196</span> this.name = name;<a name="line.196"></a> -<span class="sourceLineNo">197</span> return this;<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> /**<a name="line.200"></a> -<span class="sourceLineNo">201</span> * Synonym for {@link #setName(String)}.<a name="line.201"></a> -<span class="sourceLineNo">202</span> *<a name="line.202"></a> -<span class="sourceLineNo">203</span> * @param name The new value for the <property>name</property> property on this bean.<a name="line.203"></a> -<span class="sourceLineNo">204</span> * @return This object (for method chaining).<a name="line.204"></a> -<span class="sourceLineNo">205</span> */<a name="line.205"></a> -<span class="sourceLineNo">206</span> public SecurityScheme name(String name) {<a name="line.206"></a> -<span class="sourceLineNo">207</span> return setName(name);<a name="line.207"></a> -<span class="sourceLineNo">208</span> }<a name="line.208"></a> -<span class="sourceLineNo">209</span><a name="line.209"></a> -<span class="sourceLineNo">210</span> /**<a name="line.210"></a> -<span class="sourceLineNo">211</span> * Bean property getter: <property>in</property>.<a name="line.211"></a> -<span class="sourceLineNo">212</span> *<a name="line.212"></a> -<span class="sourceLineNo">213</span> * <p><a name="line.213"></a> -<span class="sourceLineNo">214</span> * The location of the API key. Valid values are <js>"query"</js> or <js>"header"</js>.<a name="line.214"></a> -<span class="sourceLineNo">215</span> *<a name="line.215"></a> -<span class="sourceLineNo">216</span> * @return The value of the <property>in</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.216"></a> -<span class="sourceLineNo">217</span> */<a name="line.217"></a> -<span class="sourceLineNo">218</span> public String getIn() {<a name="line.218"></a> -<span class="sourceLineNo">219</span> return in;<a name="line.219"></a> -<span class="sourceLineNo">220</span> }<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> * Bean property setter: <property>in</property>.<a name="line.223"></a> -<span class="sourceLineNo">224</span> *<a name="line.224"></a> -<span class="sourceLineNo">225</span> * <p><a name="line.225"></a> -<span class="sourceLineNo">226</span> * The location of the API key. Valid values are <js>"query"</js> or <js>"header"</js>.<a name="line.226"></a> -<span class="sourceLineNo">227</span> *<a name="line.227"></a> -<span class="sourceLineNo">228</span> * @param in The new value for the <property>in</property> property on this bean.<a name="line.228"></a> -<span class="sourceLineNo">229</span> * @return This object (for method chaining).<a name="line.229"></a> -<span class="sourceLineNo">230</span> */<a name="line.230"></a> -<span class="sourceLineNo">231</span> public SecurityScheme setIn(String in) {<a name="line.231"></a> -<span class="sourceLineNo">232</span> this.in = in;<a name="line.232"></a> -<span class="sourceLineNo">233</span> return this;<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> /**<a name="line.236"></a> -<span class="sourceLineNo">237</span> * Synonym for {@link #setIn(String)}.<a name="line.237"></a> -<span class="sourceLineNo">238</span> *<a name="line.238"></a> -<span class="sourceLineNo">239</span> * @param in The new value for the <property>in</property> property on this bean.<a name="line.239"></a> -<span class="sourceLineNo">240</span> * @return This object (for method chaining).<a name="line.240"></a> -<span class="sourceLineNo">241</span> */<a name="line.241"></a> -<span class="sourceLineNo">242</span> public SecurityScheme in(String in) {<a name="line.242"></a> -<span class="sourceLineNo">243</span> return setIn(in);<a name="line.243"></a> -<span class="sourceLineNo">244</span> }<a name="line.244"></a> -<span class="sourceLineNo">245</span><a name="line.245"></a> -<span class="sourceLineNo">246</span> /**<a name="line.246"></a> -<span class="sourceLineNo">247</span> * Bean property getter: <property>flow</property>.<a name="line.247"></a> -<span class="sourceLineNo">248</span> *<a name="line.248"></a> -<span class="sourceLineNo">249</span> * <p><a name="line.249"></a> -<span class="sourceLineNo">250</span> * The flow used by the OAuth2 security scheme.<a name="line.250"></a> -<span class="sourceLineNo">251</span> *<a name="line.251"></a> -<span class="sourceLineNo">252</span> * <p><a name="line.252"></a> -<span class="sourceLineNo">253</span> * Valid values are <js>"implicit"</js>, <js>"password"</js>, <js>"application"</js> or <js>"accessCode"</js>.<a name="line.253"></a> -<span class="sourceLineNo">254</span> *<a name="line.254"></a> -<span class="sourceLineNo">255</span> * @return The value of the <property>flow</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.255"></a> -<span class="sourceLineNo">256</span> */<a name="line.256"></a> -<span class="sourceLineNo">257</span> public String getFlow() {<a name="line.257"></a> -<span class="sourceLineNo">258</span> return flow;<a name="line.258"></a> -<span class="sourceLineNo">259</span> }<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> * Bean property setter: <property>flow</property>.<a name="line.262"></a> -<span class="sourceLineNo">263</span> *<a name="line.263"></a> -<span class="sourceLineNo">264</span> * <p><a name="line.264"></a> -<span class="sourceLineNo">265</span> * The flow used by the OAuth2 security scheme.<a name="line.265"></a> -<span class="sourceLineNo">266</span> *<a name="line.266"></a> -<span class="sourceLineNo">267</span> * <p><a name="line.267"></a> -<span class="sourceLineNo">268</span> * Valid values are <js>"implicit"</js>, <js>"password"</js>, <js>"application"</js> or <js>"accessCode"</js>.<a name="line.268"></a> -<span class="sourceLineNo">269</span> *<a name="line.269"></a> -<span class="sourceLineNo">270</span> * @param flow The new value for the <property>flow</property> property on this bean.<a name="line.270"></a> -<span class="sourceLineNo">271</span> * @return This object (for method chaining).<a name="line.271"></a> -<span class="sourceLineNo">272</span> */<a name="line.272"></a> -<span class="sourceLineNo">273</span> public SecurityScheme setFlow(String flow) {<a name="line.273"></a> -<span class="sourceLineNo">274</span> this.flow = flow;<a name="line.274"></a> -<span class="sourceLineNo">275</span> return this;<a name="line.275"></a> -<span class="sourceLineNo">276</span> }<a name="line.276"></a> -<span class="sourceLineNo">277</span><a name="line.277"></a> -<span class="sourceLineNo">278</span> /**<a name="line.278"></a> -<span class="sourceLineNo">279</span> * Synonym for {@link #setFlow(String)}.<a name="line.279"></a> -<span class="sourceLineNo">280</span> *<a name="line.280"></a> -<span class="sourceLineNo">281</span> * @param flow The new value for the <property>flow</property> property on this bean.<a name="line.281"></a> -<span class="sourceLineNo">282</span> * @return This object (for method chaining).<a name="line.282"></a> -<span class="sourceLineNo">283</span> */<a name="line.283"></a> -<span class="sourceLineNo">284</span> public SecurityScheme flow(String flow) {<a name="line.284"></a> -<span class="sourceLineNo">285</span> return setFlow(flow);<a name="line.285"></a> -<span class="sourceLineNo">286</span> }<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> * Bean property getter: <property>authorizationUrl</property>.<a name="line.289"></a> -<span class="sourceLineNo">290</span> *<a name="line.290"></a> -<span class="sourceLineNo">291</span> * <p><a name="line.291"></a> -<span class="sourceLineNo">292</span> * The authorization URL to be used for this flow.<a name="line.292"></a> -<span class="sourceLineNo">293</span> *<a name="line.293"></a> -<span class="sourceLineNo">294</span> * <p><a name="line.294"></a> -<span class="sourceLineNo">295</span> * This SHOULD be in the form of a URL.<a name="line.295"></a> -<span class="sourceLineNo">296</span> *<a name="line.296"></a> -<span class="sourceLineNo">297</span> * @return<a name="line.297"></a> -<span class="sourceLineNo">298</span> * The value of the <property>authorizationUrl</property> property on this bean, or <jk>null</jk> if it<a name="line.298"></a> -<span class="sourceLineNo">299</span> * is not set.<a name="line.299"></a> -<span class="sourceLineNo">300</span> */<a name="line.300"></a> -<span class="sourceLineNo">301</span> public String getAuthorizationUrl() {<a name="line.301"></a> -<span class="sourceLineNo">302</span> return authorizationUrl;<a name="line.302"></a> -<span class="sourceLineNo">303</span> }<a name="line.303"></a> -<span class="sourceLineNo">304</span><a name="line.304"></a> -<span class="sourceLineNo">305</span> /**<a name="line.305"></a> -<span class="sourceLineNo">306</span> * Bean property setter: <property>authorizationUrl</property>.<a name="line.306"></a> -<span class="sourceLineNo">307</span> *<a name="line.307"></a> -<span class="sourceLineNo">308</span> * <p><a name="line.308"></a> -<span class="sourceLineNo">309</span> * The authorization URL to be used for this flow.<a name="line.309"></a> -<span class="sourceLineNo">310</span> *<a name="line.310"></a> -<span class="sourceLineNo">311</span> * <p><a name="line.311"></a> -<span class="sourceLineNo">312</span> * This SHOULD be in the form of a URL.<a name="line.312"></a> -<span class="sourceLineNo">313</span> *<a name="line.313"></a> -<span class="sourceLineNo">314</span> * @param authorizationUrl The new value for the <property>authorizationUrl</property> property on this bean.<a name="line.314"></a> -<span class="sourceLineNo">315</span> * @return This object (for method chaining).<a name="line.315"></a> -<span class="sourceLineNo">316</span> */<a name="line.316"></a> -<span class="sourceLineNo">317</span> public SecurityScheme setAuthorizationUrl(String authorizationUrl) {<a name="line.317"></a> -<span class="sourceLineNo">318</span> this.authorizationUrl = authorizationUrl;<a name="line.318"></a> -<span class="sourceLineNo">319</span> return this;<a name="line.319"></a> -<span class="sourceLineNo">320</span> }<a name="line.320"></a> -<span class="sourceLineNo">321</span><a name="line.321"></a> -<span class="sourceLineNo">322</span> /**<a name="line.322"></a> -<span class="sourceLineNo">323</span> * Synonym for {@link #setAuthorizationUrl(String)}.<a name="line.323"></a> -<span class="sourceLineNo">324</span> *<a name="line.324"></a> -<span class="sourceLineNo">325</span> * @param authorizationUrl The new value for the <property>authorizationUrl</property> property on this bean.<a name="line.325"></a> -<span class="sourceLineNo">326</span> * @return This object (for method chaining).<a name="line.326"></a> -<span class="sourceLineNo">327</span> */<a name="line.327"></a> -<span class="sourceLineNo">328</span> public SecurityScheme authorizationUrl(String authorizationUrl) {<a name="line.328"></a> -<span class="sourceLineNo">329</span> return setAuthorizationUrl(authorizationUrl);<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> /**<a name="line.332"></a> -<span class="sourceLineNo">333</span> * Bean property getter: <property>tokenUrl</property>.<a name="line.333"></a> -<span class="sourceLineNo">334</span> *<a name="line.334"></a> -<span class="sourceLineNo">335</span> * <p><a name="line.335"></a> -<span class="sourceLineNo">336</span> * The token URL to be used for this flow.<a name="line.336"></a> -<span class="sourceLineNo">337</span> *<a name="line.337"></a> -<span class="sourceLineNo">338</span> * <p><a name="line.338"></a> -<span class="sourceLineNo">339</span> * This SHOULD be in the form of a URL.<a name="line.339"></a> -<span class="sourceLineNo">340</span> *<a name="line.340"></a> -<span class="sourceLineNo">341</span> * @return The value of the <property>tokenUrl</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.341"></a> -<span class="sourceLineNo">342</span> */<a name="line.342"></a> -<span class="sourceLineNo">343</span> public String getTokenUrl() {<a name="line.343"></a> -<span class="sourceLineNo">344</span> return tokenUrl;<a name="line.344"></a> -<span class="sourceLineNo">345</span> }<a name="line.345"></a> -<span class="sourceLineNo">346</span><a name="line.346"></a> -<span class="sourceLineNo">347</span> /**<a name="line.347"></a> -<span class="sourceLineNo">348</span> * Bean property setter: <property>tokenUrl</property>.<a name="line.348"></a> -<span class="sourceLineNo">349</span> *<a name="line.349"></a> -<span class="sourceLineNo">350</span> * <p><a name="line.350"></a> -<span class="sourceLineNo">351</span> * The token URL to be used for this flow.<a name="line.351"></a> -<span class="sourceLineNo">352</span> *<a name="line.352"></a> -<span class="sourceLineNo">353</span> * <p><a name="line.353"></a> -<span class="sourceLineNo">354</span> * This SHOULD be in the form of a URL.<a name="line.354"></a> -<span class="sourceLineNo">355</span> *<a name="line.355"></a> -<span class="sourceLineNo">356</span> * @param tokenUrl The new value for the <property>tokenUrl</property> property on this bean.<a name="line.356"></a> -<span class="sourceLineNo">357</span> * @return This object (for method chaining).<a name="line.357"></a> -<span class="sourceLineNo">358</span> */<a name="line.358"></a> -<span class="sourceLineNo">359</span> public SecurityScheme setTokenUrl(String tokenUrl) {<a name="line.359"></a> -<span class="sourceLineNo">360</span> this.tokenUrl = tokenUrl;<a name="line.360"></a> -<span class="sourceLineNo">361</span> return this;<a name="line.361"></a> -<span class="sourceLineNo">362</span> }<a name="line.362"></a> -<span class="sourceLineNo">363</span><a name="line.363"></a> -<span class="sourceLineNo">364</span> /**<a name="line.364"></a> -<span class="sourceLineNo">365</span> * Synonym for {@link #setTokenUrl(String)}.<a name="line.365"></a> -<span class="sourceLineNo">366</span> *<a name="line.366"></a> -<span class="sourceLineNo">367</span> * @param tokenUrl The new value for the <property>tokenUrl</property> property on this bean.<a name="line.367"></a> -<span class="sourceLineNo">368</span> * @return This object (for method chaining).<a name="line.368"></a> -<span class="sourceLineNo">369</span> */<a name="line.369"></a> -<span class="sourceLineNo">370</span> public SecurityScheme tokenUrl(String tokenUrl) {<a name="line.370"></a> -<span class="sourceLineNo">371</span> return setTokenUrl(tokenUrl);<a name="line.371"></a> -<span class="sourceLineNo">372</span> }<a name="line.372"></a> -<span class="sourceLineNo">373</span><a name="line.373"></a> -<span class="sourceLineNo">374</span> /**<a name="line.374"></a> -<span class="sourceLineNo">375</span> * Bean property getter: <property>scopes</property>.<a name="line.375"></a> -<span class="sourceLineNo">376</span> *<a name="line.376"></a> -<span class="sourceLineNo">377</span> * <p><a name="line.377"></a> -<span class="sourceLineNo">378</span> * The available scopes for the OAuth2 security scheme.<a name="line.378"></a> -<span class="sourceLineNo">379</span> *<a name="line.379"></a> -<span class="sourceLineNo">380</span> * @return The value of the <property>scopes</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.380"></a> -<span class="sourceLineNo">381</span> */<a name="line.381"></a> -<span class="sourceLineNo">382</span> public Map<String,String> getScopes() {<a name="line.382"></a> -<span class="sourceLineNo">383</span> return scopes;<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> /**<a name="line.386"></a> -<span class="sourceLineNo">387</span> * Bean property setter: <property>scopes</property>.<a name="line.387"></a> -<span class="sourceLineNo">388</span> *<a name="line.388"></a> -<span class="sourceLineNo">389</span> * <p><a name="line.389"></a> -<span class="sourceLineNo">390</span> * The available scopes for the OAuth2 security scheme.<a name="line.390"></a> -<span class="sourceLineNo">391</span> *<a name="line.391"></a> -<span class="sourceLineNo">392</span> * @param scopes The new value for the <property>scopes</property> property on this bean.<a name="line.392"></a> -<span class="sourceLineNo">393</span> * @return This object (for method chaining).<a name="line.393"></a> -<span class="sourceLineNo">394</span> */<a name="line.394"></a> -<span class="sourceLineNo">395</span> public SecurityScheme setScopes(Map<String,String> scopes) {<a name="line.395"></a> -<span class="sourceLineNo">396</span> this.scopes = scopes;<a name="line.396"></a> -<span class="sourceLineNo">397</span> return this;<a name="line.397"></a> -<span class="sourceLineNo">398</span> }<a name="line.398"></a> -<span class="sourceLineNo">399</span><a name="line.399"></a> -<span class="sourceLineNo">400</span> /**<a name="line.400"></a> -<span class="sourceLineNo">401</span> * Bean property adder: <property>scopes</property>.<a name="line.401"></a> -<span class="sourceLineNo">402</span> *<a name="line.402"></a> -<span class="sourceLineNo">403</span> * <p><a name="line.403"></a> -<span class="sourceLineNo">404</span> * The available scopes for the OAuth2 security scheme.<a name="line.404"></a> -<span class="sourceLineNo">405</span> *<a name="line.405"></a> -<span class="sourceLineNo">406</span> * @param name The name of the scope.<a name="line.406"></a> -<span class="sourceLineNo">407</span> * @param description A short description of the scope.<a name="line.407"></a> -<span class="sourceLineNo">408</span> * @return This object (for method chaining).<a name="line.408"></a> -<span class="sourceLineNo">409</span> */<a name="line.409"></a> -<span class="sourceLineNo">410</span> public SecurityScheme addScope(String name, String description) {<a name="line.410"></a> -<span class="sourceLineNo">411</span> if (scopes == null)<a name="line.411"></a> -<span class="sourceLineNo">412</span> scopes = new TreeMap<String,String>();<a name="line.412"></a> -<span class="sourceLineNo">413</span> scopes.put(name, description);<a name="line.413"></a> -<span class="sourceLineNo">414</span> return this;<a name="line.414"></a> -<span class="sourceLineNo">415</span> }<a name="line.415"></a> -<span class="sourceLineNo">416</span><a name="line.416"></a> -<span class="sourceLineNo">417</span> /**<a name="line.417"></a> -<span class="sourceLineNo">418</span> * Synonym for {@link #addScope(String,String)}.<a name="line.418"></a> -<span class="sourceLineNo">419</span> *<a name="line.419"></a> -<span class="sourceLineNo">420</span> * @param name The name of the scope.<a name="line.420"></a> -<span class="sourceLineNo">421</span> * @param description A short description of the scope.<a name="line.421"></a> -<span class="sourceLineNo">422</span> * @return This object (for method chaining).<a name="line.422"></a> -<span class="sourceLineNo">423</span> */<a name="line.423"></a> -<span class="sourceLineNo">424</span> public SecurityScheme scope(String name, String description) {<a name="line.424"></a> -<span class="sourceLineNo">425</span> return addScope(name, description);<a name="line.425"></a> -<span class="sourceLineNo">426</span> }<a name="line.426"></a> -<span class="sourceLineNo">427</span>}<a name="line.427"></a> +<span class="sourceLineNo">120</span> throw new FormattedRuntimeException(<a name="line.120"></a> +<span class="sourceLineNo">121</span> "Invalid value passed in to setType(String). Value=''{0}'', valid values={1}",<a name="line.121"></a> +<span class="sourceLineNo">122</span> type, VALID_TYPES<a name="line.122"></a> +<span class="sourceLineNo">123</span> );<a name="line.123"></a> +<span class="sourceLineNo">124</span> this.type = type;<a name="line.124"></a> +<span class="sourceLineNo">125</span> return this;<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> /**<a name="line.128"></a> +<span class="sourceLineNo">129</span> * Synonym for {@link #setType(String)}.<a name="line.129"></a> +<span class="sourceLineNo">130</span> *<a name="line.130"></a> +<span class="sourceLineNo">131</span> * @param type The new value for the <property>type</property> property on this bean.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * @return This object (for method chaining).<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> public SecurityScheme type(String type) {<a name="line.134"></a> +<span class="sourceLineNo">135</span> return setType(type);<a name="line.135"></a> +<span class="sourceLineNo">136</span> }<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> * Bean property getter: <property>description</property>.<a name="line.139"></a> +<span class="sourceLineNo">140</span> *<a name="line.140"></a> +<span class="sourceLineNo">141</span> * <p><a name="line.141"></a> +<span class="sourceLineNo">142</span> * A short description for security scheme.<a name="line.142"></a> +<span class="sourceLineNo">143</span> *<a name="line.143"></a> +<span class="sourceLineNo">144</span> * @return<a name="line.144"></a> +<span class="sourceLineNo">145</span> * The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.145"></a> +<span class="sourceLineNo">146</span> */<a name="line.146"></a> +<span class="sourceLineNo">147</span> public String getDescription() {<a name="line.147"></a> +<span class="sourceLineNo">148</span> return description;<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> * Bean property setter: <property>description</property>.<a name="line.152"></a> +<span class="sourceLineNo">153</span> *<a name="line.153"></a> +<span class="sourceLineNo">154</span> * <p><a name="line.154"></a> +<span class="sourceLineNo">155</span> * A short description for security scheme.<a name="line.155"></a> +<span class="sourceLineNo">156</span> *<a name="line.156"></a> +<span class="sourceLineNo">157</span> * @param description The new value for the <property>description</property> property on this bean.<a name="line.157"></a> +<span class="sourceLineNo">158</span> * @return This object (for method chaining).<a name="line.158"></a> +<span class="sourceLineNo">159</span> */<a name="line.159"></a> +<span class="sourceLineNo">160</span> public SecurityScheme setDescription(String description) {<a name="line.160"></a> +<span class="sourceLineNo">161</span> this.description = description;<a name="line.161"></a> +<span class="sourceLineNo">162</span> return this;<a name="line.162"></a> +<span class="sourceLineNo">163</span> }<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> * Synonym for {@link #setDescription(String)}.<a name="line.166"></a> +<span class="sourceLineNo">167</span> *<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @param description The new value for the <property>description</property> property on this bean.<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @return This object (for method chaining).<a name="line.169"></a> +<span class="sourceLineNo">170</span> */<a name="line.170"></a> +<span class="sourceLineNo">171</span> public SecurityScheme description(String description) {<a name="line.171"></a> +<span class="sourceLineNo">172</span> return setDescription(description);<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> * Bean property getter: <property>name</property>.<a name="line.176"></a> +<span class="sourceLineNo">177</span> *<a name="line.177"></a> +<span class="sourceLineNo">178</span> * <p><a name="line.178"></a> +<span class="sourceLineNo">179</span> * The name of the header or query parameter to be used.<a name="line.179"></a> +<span class="sourceLineNo">180</span> *<a name="line.180"></a> +<span class="sourceLineNo">181</span> * @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.181"></a> +<span class="sourceLineNo">182</span> */<a name="line.182"></a> +<span class="sourceLineNo">183</span> public String getName() {<a name="line.183"></a> +<span class="sourceLineNo">184</span> return name;<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> * Bean property setter: <property>name</property>.<a name="line.188"></a> +<span class="sourceLineNo">189</span> *<a name="line.189"></a> +<span class="sourceLineNo">190</span> * <p><a name="line.190"></a> +<span class="sourceLineNo">191</span> * The name of the header or query parameter to be used.<a name="line.191"></a> +<span class="sourceLineNo">192</span> *<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @param name The new value for the <property>name</property> property on this bean.<a name="line.193"></a> +<span class="sourceLineNo">194</span> * @return This object (for method chaining).<a name="line.194"></a> +<span class="sourceLineNo">195</span> */<a name="line.195"></a> +<span class="sourceLineNo">196</span> public SecurityScheme setName(String name) {<a name="line.196"></a> +<span class="sourceLineNo">197</span> this.name = name;<a name="line.197"></a> +<span class="sourceLineNo">198</span> return this;<a name="line.198"></a> +<span class="sourceLineNo">199</span> }<a name="line.199"></a> +<span class="sourceLineNo">200</span><a name="line.200"></a> +<span class="sourceLineNo">201</span> /**<a name="line.201"></a> +<span class="sourceLineNo">202</span> * Synonym for {@link #setName(String)}.<a name="line.202"></a> +<span class="sourceLineNo">203</span> *<a name="line.203"></a> +<span class="sourceLineNo">204</span> * @param name The new value for the <property>name</property> property on this bean.<a name="line.204"></a> +<span class="sourceLineNo">205</span> * @return This object (for method chaining).<a name="line.205"></a> +<span class="sourceLineNo">206</span> */<a name="line.206"></a> +<span class="sourceLineNo">207</span> public SecurityScheme name(String name) {<a name="line.207"></a> +<span class="sourceLineNo">208</span> return setName(name);<a name="line.208"></a> +<span class="sourceLineNo">209</span> }<a name="line.209"></a> +<span class="sourceLineNo">210</span><a name="line.210"></a> +<span class="sourceLineNo">211</span> /**<a name="line.211"></a> +<span class="sourceLineNo">212</span> * Bean property getter: <property>in</property>.<a name="line.212"></a> +<span class="sourceLineNo">213</span> *<a name="line.213"></a> +<span class="sourceLineNo">214</span> * <p><a name="line.214"></a> +<span class="sourceLineNo">215</span> * The location of the API key. Valid values are <js>"query"</js> or <js>"header"</js>.<a name="line.215"></a> +<span class="sourceLineNo">216</span> *<a name="line.216"></a> +<span class="sourceLineNo">217</span> * @return The value of the <property>in</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.217"></a> +<span class="sourceLineNo">218</span> */<a name="line.218"></a> +<span class="sourceLineNo">219</span> public String getIn() {<a name="line.219"></a> +<span class="sourceLineNo">220</span> return in;<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> * Bean property setter: <property>in</property>.<a name="line.224"></a> +<span class="sourceLineNo">225</span> *<a name="line.225"></a> +<span class="sourceLineNo">226</span> * <p><a name="line.226"></a> +<span class="sourceLineNo">227</span> * The location of the API key. Valid values are <js>"query"</js> or <js>"header"</js>.<a name="line.227"></a> +<span class="sourceLineNo">228</span> *<a name="line.228"></a> +<span class="sourceLineNo">229</span> * @param in The new value for the <property>in</property> property on this bean.<a name="line.229"></a> +<span class="sourceLineNo">230</span> * @return This object (for method chaining).<a name="line.230"></a> +<span class="sourceLineNo">231</span> */<a name="line.231"></a> +<span class="sourceLineNo">232</span> public SecurityScheme setIn(String in) {<a name="line.232"></a> +<span class="sourceLineNo">233</span> this.in = in;<a name="line.233"></a> +<span class="sourceLineNo">234</span> return this;<a name="line.234"></a> +<span class="sourceLineNo">235</span> }<a name="line.235"></a> +<span class="sourceLineNo">236</span><a name="line.236"></a> +<span class="sourceLineNo">237</span> /**<a name="line.237"></a> +<span class="sourceLineNo">238</span> * Synonym for {@link #setIn(String)}.<a name="line.238"></a> +<span class="sourceLineNo">239</span> *<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @param in The new value for the <property>in</property> property on this bean.<a name="line.240"></a> +<span class="sourceLineNo">241</span> * @return This object (for method chaining).<a name="line.241"></a> +<span class="sourceLineNo">242</span> */<a name="line.242"></a> +<span class="sourceLineNo">243</span> public SecurityScheme in(String in) {<a name="line.243"></a> +<span class="sourceLineNo">244</span> return setIn(in);<a name="line.244"></a> +<span class="sourceLineNo">245</span> }<a name="line.245"></a> +<span class="sourceLineNo">246</span><a name="line.246"></a> +<span class="sourceLineNo">247</span> /**<a name="line.247"></a> +<span class="sourceLineNo">248</span> * Bean property getter: <property>flow</property>.<a name="line.248"></a> +<span class="sourceLineNo">249</span> *<a name="line.249"></a> +<span class="sourceLineNo">250</span> * <p><a name="line.250"></a> +<span class="sourceLineNo">251</span> * The flow used by the OAuth2 security scheme.<a name="line.251"></a> +<span class="sourceLineNo">252</span> *<a name="line.252"></a> +<span class="sourceLineNo">253</span> * <p><a name="line.253"></a> +<span class="sourceLineNo">254</span> * Valid values are <js>"implicit"</js>, <js>"password"</js>, <js>"application"</js> or <js>"accessCode"</js>.<a name="line.254"></a> +<span class="sourceLineNo">255</span> *<a name="line.255"></a> +<span class="sourceLineNo">256</span> * @return The value of the <property>flow</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.256"></a> +<span class="sourceLineNo">257</span> */<a name="line.257"></a> +<span class="sourceLineNo">258</span> public String getFlow() {<a name="line.258"></a> +<span class="sourceLineNo">259</span> return flow;<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> * Bean property setter: <property>flow</property>.<a name="line.263"></a> +<span class="sourceLineNo">264</span> *<a name="line.264"></a> +<span class="sourceLineNo">265</span> * <p><a name="line.265"></a> +<span class="sourceLineNo">266</span> * The flow used by the OAuth2 security scheme.<a name="line.266"></a> +<span class="sourceLineNo">267</span> *<a name="line.267"></a> +<span class="sourceLineNo">268</span> * <p><a name="line.268"></a> +<span class="sourceLineNo">269</span> * Valid values are <js>"implicit"</js>, <js>"password"</js>, <js>"application"</js> or <js>"accessCode"</js>.<a name="line.269"></a> +<span class="sourceLineNo">270</span> *<a name="line.270"></a> +<span class="sourceLineNo">271</span> * @param flow The new value for the <property>flow</property> property on this bean.<a name="line.271"></a> +<span class="sourceLineNo">272</span> * @return This object (for method chaining).<a name="line.272"></a> +<span class="sourceLineNo">273</span> */<a name="line.273"></a> +<span class="sourceLineNo">274</span> public SecurityScheme setFlow(String flow) {<a name="line.274"></a> +<span class="sourceLineNo">275</span> this.flow = flow;<a name="line.275"></a> +<span class="sourceLineNo">276</span> return this;<a name="line.276"></a> +<span class="sourceLineNo">277</span> }<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> * Synonym for {@link #setFlow(String)}.<a name="line.280"></a> +<span class="sourceLineNo">281</span> *<a name="line.281"></a> +<span class="sourceLineNo">282</span> * @param flow The new value for the <property>flow</property> property on this bean.<a name="line.282"></a> +<span class="sourceLineNo">283</span> * @return This object (for method chaining).<a name="line.283"></a> +<span class="sourceLineNo">284</span> */<a name="line.284"></a> +<span class="sourceLineNo">285</span> public SecurityScheme flow(String flow) {<a name="line.285"></a> +<span class="sourceLineNo">286</span> return setFlow(flow);<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> * Bean property getter: <property>authorizationUrl</property>.<a name="line.290"></a> +<span class="sourceLineNo">291</span> *<a name="line.291"></a> +<span class="sourceLineNo">292</span> * <p><a name="line.292"></a> +<span class="sourceLineNo">293</span> * The authorization URL to be used for this flow.<a name="line.293"></a> +<span class="sourceLineNo">294</span> *<a name="line.294"></a> +<span class="sourceLineNo">295</span> * <p><a name="line.295"></a> +<span class="sourceLineNo">296</span> * This SHOULD be in the form of a URL.<a name="line.296"></a> +<span class="sourceLineNo">297</span> *<a name="line.297"></a> +<span class="sourceLineNo">298</span> * @return<a name="line.298"></a> +<span class="sourceLineNo">299</span> * The value of the <property>authorizationUrl</property> property on this bean, or <jk>null</jk> if it<a name="line.299"></a> +<span class="sourceLineNo">300</span> * is not set.<a name="line.300"></a> +<span class="sourceLineNo">301</span> */<a name="line.301"></a> +<span class="sourceLineNo">302</span> public String getAuthorizationUrl() {<a name="line.302"></a> +<span class="sourceLineNo">303</span> return authorizationUrl;<a name="line.303"></a> +<span class="sourceLineNo">304</span> }<a name="line.304"></a> +<span class="sourceLineNo">305</span><a name="line.305"></a> +<span class="sourceLineNo">306</span> /**<a name="line.306"></a> +<span class="sourceLineNo">307</span> * Bean property setter: <property>authorizationUrl</property>.<a name="line.307"></a> +<span class="sourceLineNo">308</span> *<a name="line.308"></a> +<span class="sourceLineNo">309</span> * <p><a name="line.309"></a> +<span class="sourceLineNo">310</span> * The authorization URL to be used for this flow.<a name="line.310"></a> +<span class="sourceLineNo">311</span> *<a name="line.311"></a> +<span class="sourceLineNo">312</span> * <p><a name="line.312"></a> +<span class="sourceLineNo">313</span> * This SHOULD be in the form of a URL.<a name="line.313"></a> +<span class="sourceLineNo">314</span> *<a name="line.314"></a> +<span class="sourceLineNo">315</span> * @param authorizationUrl The new value for the <property>authorizationUrl</property> property on this bean.<a name="line.315"></a> +<span class="sourceLineNo">316</span> * @return This object (for method chaining).<a name="line.316"></a> +<span class="sourceLineNo">317</span> */<a name="line.317"></a> +<span class="sourceLineNo">318</span> public SecurityScheme setAuthorizationUrl(String authorizationUrl) {<a name="line.318"></a> +<span class="sourceLineNo">319</span> this.authorizationUrl = authorizationUrl;<a name="line.319"></a> +<span class="sourceLineNo">320</span> return this;<a name="line.320"></a> +<span class="sourceLineNo">321</span> }<a name="line.321"></a> +<span class="sourceLineNo">322</span><a name="line.322"></a> +<span class="sourceLineNo">323</span> /**<a name="line.323"></a> +<span class="sourceLineNo">324</span> * Synonym for {@link #setAuthorizationUrl(String)}.<a name="line.324"></a> +<span class="sourceLineNo">325</span> *<a name="line.325"></a> +<span class="sourceLineNo">326</span> * @param authorizationUrl The new value for the <property>authorizationUrl</property> property on this bean.<a name="line.326"></a> +<span class="sourceLineNo">327</span> * @return This object (for method chaining).<a name="line.327"></a> +<span class="sourceLineNo">328</span> */<a name="line.328"></a> +<span class="sourceLineNo">329</span> public SecurityScheme authorizationUrl(String authorizationUrl) {<a name="line.329"></a> +<span class="sourceLineNo">330</span> return setAuthorizationUrl(authorizationUrl);<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> * Bean property getter: <property>tokenUrl</property>.<a name="line.334"></a> +<span class="sourceLineNo">335</span> *<a name="line.335"></a> +<span class="sourceLineNo">336</span> * <p><a name="line.336"></a> +<span class="sourceLineNo">337</span> * The token URL to be used for this flow.<a name="line.337"></a> +<span class="sourceLineNo">338</span> *<a name="line.338"></a> +<span class="sourceLineNo">339</span> * <p><a name="line.339"></a> +<span class="sourceLineNo">340</span> * This SHOULD be in the form of a URL.<a name="line.340"></a> +<span class="sourceLineNo">341</span> *<a name="line.341"></a> +<span class="sourceLineNo">342</span> * @return The value of the <property>tokenUrl</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.342"></a> +<span class="sourceLineNo">343</span> */<a name="line.343"></a> +<span class="sourceLineNo">344</span> public String getTokenUrl() {<a name="line.344"></a> +<span class="sourceLineNo">345</span> return tokenUrl;<a name="line.345"></a> +<span class="sourceLineNo">346</span> }<a name="line.346"></a> +<span class="sourceLineNo">347</span><a name="line.347"></a> +<span class="sourceLineNo">348</span> /**<a name="line.348"></a> +<span class="sourceLineNo">349</span> * Bean property setter: <property>tokenUrl</property>.<a name="line.349"></a> +<span class="sourceLineNo">350</span> *<a name="line.350"></a> +<span class="sourceLineNo">351</span> * <p><a name="line.351"></a> +<span class="sourceLineNo">352</span> * The token URL to be used for this flow.<a name="line.352"></a> +<span class="sourceLineNo">353</span> *<a name="line.353"></a> +<span class="sourceLineNo">354</span> * <p><a name="line.354"></a> +<span class="sourceLineNo">355</span> * This SHOULD be in the form of a URL.<a name="line.355"></a> +<span class="sourceLineNo">356</span> *<a name="line.356"></a> +<span class="sourceLineNo">357</span> * @param tokenUrl The new value for the <property>tokenUrl</property> property on this bean.<a name="line.357"></a> +<span class="sourceLineNo">358</span> * @return This object (for method chaining).<a name="line.358"></a> +<span class="sourceLineNo">359</span> */<a name="line.359"></a> +<span class="sourceLineNo">360</span> public SecurityScheme setTokenUrl(String tokenUrl) {<a name="line.360"></a> +<span class="sourceLineNo">361</span> this.tokenUrl = tokenUrl;<a name="line.361"></a> +<span class="sourceLineNo">362</span> return this;<a name="line.362"></a> +<span class="sourceLineNo">363</span> }<a name="line.363"></a> +<span class="sourceLineNo">364</span><a name="line.364"></a> +<span class="sourceLineNo">365</span> /**<a name="line.365"></a> +<span class="sourceLineNo">366</span> * Synonym for {@link #setTokenUrl(String)}.<a name="line.366"></a> +<span class="sourceLineNo">367</span> *<a name="line.367"></a> +<span class="sourceLineNo">368</span> * @param tokenUrl The new value for the <property>tokenUrl</property> property on this bean.<a name="line.368"></a> +<span class="sourceLineNo">369</span> * @return This object (for method chaining).<a name="line.369"></a> +<span class="sourceLineNo">370</span> */<a name="line.370"></a> +<span class="sourceLineNo">371</span> public SecurityScheme tokenUrl(String tokenUrl) {<a name="line.371"></a> +<span class="sourceLineNo">372</span> return setTokenUrl(tokenUrl);<a name="line.372"></a> +<span class="sourceLineNo">373</span> }<a name="line.373"></a> +<span class="sourceLineNo">374</span><a name="line.374"></a> +<span class="sourceLineNo">375</span> /**<a name="line.375"></a> +<span class="sourceLineNo">376</span> * Bean property getter: <property>scopes</property>.<a name="line.376"></a> +<span class="sourceLineNo">377</span> *<a name="line.377"></a> +<span class="sourceLineNo">378</span> * <p><a name="line.378"></a> +<span class="sourceLineNo">379</span> * The available scopes for the OAuth2 security scheme.<a name="line.379"></a> +<span class="sourceLineNo">380</span> *<a name="line.380"></a> +<span class="sourceLineNo">381</span> * @return The value of the <property>scopes</property> property on this bean, or <jk>null</jk> if it is not set.<a name="line.381"></a> +<span class="sourceLineNo">382</span> */<a name="line.382"></a> +<span class="sourceLineNo">383</span> public Map<String,String> getScopes() {<a name="line.383"></a> +<span class="sourceLineNo">384</span> return scopes;<a name="line.384"></a> +<span class="sourceLineNo">385</span> }<a name="line.385"></a> +<span class="sourceLineNo">386</span><a name="line.386"></a> +<span class="sourceLineNo">387</span> /**<a name="line.387"></a> +<span class="sourceLineNo">388</span> * Bean property setter: <property>scopes</property>.<a name="line.388"></a> +<span class="sourceLineNo">389</span> *<a name="line.389"></a> +<span class="sourceLineNo">390</span> * <p><a name="line.390"></a> +<span class="sourceLineNo">391</span> * The available scopes for the OAuth2 security scheme.<a name="line.391"></a> +<span class="sourceLineNo">392</span> *<a name="line.392"></a> +<span class="sourceLineNo">393</span> * @param scopes The new value for the <property>scopes</property> property on this bean.<a name="line.393"></a> +<span class="sourceLineNo">394</span> * @return This object (for method chaining).<a name="line.394"></a> +<span class="sourceLineNo">395</span> */<a name="line.395"></a> +<span class="sourceLineNo">396</span> public SecurityScheme setScopes(Map<String,String> scopes) {<a name="line.396"></a> +<span class="sourceLineNo">397</span> this.scopes = scopes;<a name="line.397"></a> +<span class="sourceLineNo">398</span> return this;<a name="line.398"></a> +<span class="sourceLineNo">399</span> }<a name="line.399"></a> +<span class="sourceLineNo">400</span><a name="line.400"></a> +<span class="sourceLineNo">401</span> /**<a name="line.401"></a> +<span class="sourceLineNo">402</span> * Bean property adder: <property>scopes</property>.<a name="line.402"></a> +<span class="sourceLineNo">403</span> *<a name="line.403"></a> +<span class="sourceLineNo">404</span> * <p><a name="line.404"></a> +<span class="sourceLineNo">405</span> * The available scopes for the OAuth2 security scheme.<a name="line.405"></a> +<span class="sourceLineNo">406</span> *<a name="line.406"></a> +<span class="sourceLineNo">407</span> * @param name The name of the scope.<a name="line.407"></a> +<span class="sourceLineNo">408</span> * @param description A short description of the scope.<a name="line.408"></a> +<span class="sourceLineNo">409</span> * @return This object (for method chaining).<a name="line.409"></a> +<span class="sourceLineNo">410</span> */<a name="line.410"></a> +<span class="sourceLineNo">411</span> public SecurityScheme addScope(String name, String description) {<a name="line.411"></a> +<span class="sourceLineNo">412</span> if (scopes == null)<a name="line.412"></a> +<span class="sourceLineNo">413</span> scopes = new TreeMap<String,String>();<a name="line.413"></a> +<span class="sourceLineNo">414</span> scopes.put(name, description);<a name="line.414"></a> +<span class="sourceLineNo">415</span> return this;<a name="line.415"></a> +<span class="sourceLineNo">416</span> }<a name="line.416"></a> +<span class="sourceLineNo">417</span><a name="line.417"></a> +<span class="sourceLineNo">418</span> /**<a name="line.418"></a> +<span class="sourceLineNo">419</span> * Synonym for {@link #addScope(String,String)}.<a name="line.419"></a> +<span class="sourceLineNo">420</span> *<a name="line.420"></a> +<span class="sourceLineNo">421</span> * @param name The name of the scope.<a name="line.421"></a> +<span class="sourceLineNo">422</span> * @param description A short description of the scope.<a name="line.422"></a> +<span class="sourceLineNo">423</span> * @return This object (for method chaining).<a name="line.423"></a> +<span class="sourceLineNo">424</span> */<a name="line.424"></a> +<span class="sourceLineNo">425</span> public SecurityScheme scope(String name, String description) {<a name="line.425"></a> +<span class="sourceLineNo">426</span> return addScope(name, description);<a name="line.426"></a> +<span class="sourceLineNo">427</span> }<a name="line.427"></a> +<span class="sourceLineNo">428</span>}<a name="line.428"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/d35b70d1/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html index ef152d1..4940d59 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html +++ b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerContext.html @@ -461,7 +461,7 @@ <span class="sourceLineNo">453</span> * <b>Configuration property:</b> Stylesheet import URLs.<a name="line.453"></a> <span class="sourceLineNo">454</span> *<a name="line.454"></a> <span class="sourceLineNo">455</span> * <ul><a name="line.455"></a> -<span class="sourceLineNo">456</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.styleImport"</js><a name="line.456"></a> +<span class="sourceLineNo">456</span> * <li><b>Name:</b> <js>"HtmlDocSerializer.stylesheet"</js><a name="line.456"></a> <span class="sourceLineNo">457</span> * <li><b>Data type:</b> <code>List&lt;String&gt;</code><a name="line.457"></a> <span class="sourceLineNo">458</span> * <li><b>Default:</b> empty list<a name="line.458"></a> <span class="sourceLineNo">459</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.459"></a> @@ -471,17 +471,17 @@ <span class="sourceLineNo">463</span> * Adds a link to the specified stylesheet URL.<a name="line.463"></a> <span class="sourceLineNo">464</span> *<a name="line.464"></a> <span class="sourceLineNo">465</span> * <p><a name="line.465"></a> -<span class="sourceLineNo">466</span> * Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.styleImport()</code> annotation.<a name="line.466"></a> +<span class="sourceLineNo">466</span> * Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation.<a name="line.466"></a> <span class="sourceLineNo">467</span> *<a name="line.467"></a> <span class="sourceLineNo">468</span> * <p><a name="line.468"></a> <span class="sourceLineNo">469</span> * A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.<a name="line.469"></a> <span class="sourceLineNo">470</span> */<a name="line.470"></a> -<span class="sourceLineNo">471</span> public static final String HTMLDOC_styleImport = "HtmlDocSerializer.styleImport";<a name="line.471"></a> +<span class="sourceLineNo">471</span> public static final String HTMLDOC_stylesheet = "HtmlDocSerializer.stylesheet";<a name="line.471"></a> <span class="sourceLineNo">472</span><a name="line.472"></a> <span class="sourceLineNo">473</span> /**<a name="line.473"></a> -<span class="sourceLineNo">474</span> * <b>Configuration property:</b> Add to the {@link #HTMLDOC_styleImport} property.<a name="line.474"></a> +<span class="sourceLineNo">474</span> * <b>Configuration property:</b> Add to the {@link #HTMLDOC_stylesheet} property.<a name="line.474"></a> <span class="sourceLineNo">475</span> */<a name="line.475"></a> -<span class="sourceLineNo">476</span> public static final String HTMLDOC_styleImport_add = "HtmlDocSerializer.styleImport.list.add";<a name="line.476"></a> +<span class="sourceLineNo">476</span> public static final String HTMLDOC_stylesheet_add = "HtmlDocSerializer.stylesheet.list.add";<a name="line.476"></a> <span class="sourceLineNo">477</span><a name="line.477"></a> <span class="sourceLineNo">478</span> /**<a name="line.478"></a> <span class="sourceLineNo">479</span> * <b>Configuration property:</b> CSS style code.<a name="line.479"></a> @@ -592,7 +592,7 @@ <span class="sourceLineNo">584</span> public static final String HTMLDOC_template = "HtmlDocSerializer.template";<a name="line.584"></a> <span class="sourceLineNo">585</span><a name="line.585"></a> <span class="sourceLineNo">586</span><a name="line.586"></a> -<span class="sourceLineNo">587</span> final String[] style, styleImport, script;<a name="line.587"></a> +<span class="sourceLineNo">587</span> final String[] style, stylesheet, script;<a name="line.587"></a> <span class="sourceLineNo">588</span> final Map<String,Object> links;<a name="line.588"></a> <span class="sourceLineNo">589</span> final String title, description, branding, header, nav, aside, footer, noResultsMessage;<a name="line.589"></a> <span class="sourceLineNo">590</span> final boolean nowrap;<a name="line.590"></a> @@ -609,7 +609,7 @@ <span class="sourceLineNo">601</span> public HtmlDocSerializerContext(PropertyStore ps) {<a name="line.601"></a> <span class="sourceLineNo">602</span> super(ps);<a name="line.602"></a> <span class="sourceLineNo">603</span> style = ps.getProperty(HTMLDOC_style, String[].class, new String[0]);<a name="line.603"></a> -<span class="sourceLineNo">604</span> styleImport = ps.getProperty(HTMLDOC_styleImport, String[].class, new String[0]);<a name="line.604"></a> +<span class="sourceLineNo">604</span> stylesheet = ps.getProperty(HTMLDOC_stylesheet, String[].class, new String[0]);<a name="line.604"></a> <span class="sourceLineNo">605</span> script = ps.getProperty(HTMLDOC_script, String[].class, new String[0]);<a name="line.605"></a> <span class="sourceLineNo">606</span> title = ps.getProperty(HTMLDOC_title, String.class, null);<a name="line.606"></a> <span class="sourceLineNo">607</span> description = ps.getProperty(HTMLDOC_description, String.class, null);<a name="line.607"></a> @@ -637,7 +637,7 @@ <span class="sourceLineNo">629</span> .append("aside", aside)<a name="line.629"></a> <span class="sourceLineNo">630</span> .append("footer", footer)<a name="line.630"></a> <span class="sourceLineNo">631</span> .append("style", style)<a name="line.631"></a> -<span class="sourceLineNo">632</span> .append("styleImport", styleImport)<a name="line.632"></a> +<span class="sourceLineNo">632</span> .append("stylesheet", stylesheet)<a name="line.632"></a> <span class="sourceLineNo">633</span> .append("nowrap", nowrap)<a name="line.633"></a> <span class="sourceLineNo">634</span> .append("template", template)<a name="line.634"></a> <span class="sourceLineNo">635</span> .append("noResultsMessage", noResultsMessage)<a name="line.635"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/d35b70d1/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerSession.html b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerSession.html index d5f83bd..0cf6b84 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerSession.html +++ b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocSerializerSession.html @@ -43,7 +43,7 @@ <span class="sourceLineNo">035</span>public final class HtmlDocSerializerSession extends HtmlSerializerSession {<a name="line.35"></a> <span class="sourceLineNo">036</span><a name="line.36"></a> <span class="sourceLineNo">037</span> private final String title, description, branding, header, nav, aside, footer, noResultsMessage;<a name="line.37"></a> -<span class="sourceLineNo">038</span> private final String[] style, styleImport, script;<a name="line.38"></a> +<span class="sourceLineNo">038</span> private final String[] style, stylesheet, script;<a name="line.38"></a> <span class="sourceLineNo">039</span> private final Map<String,Object> links;<a name="line.39"></a> <span class="sourceLineNo">040</span> private final boolean nowrap;<a name="line.40"></a> <span class="sourceLineNo">041</span> private final HtmlDocTemplate template;<a name="line.41"></a> @@ -86,7 +86,7 @@ <span class="sourceLineNo">078</span> footer = ctx.footer;<a name="line.78"></a> <span class="sourceLineNo">079</span> links = ctx.links;<a name="line.79"></a> <span class="sourceLineNo">080</span> style = ctx.style;<a name="line.80"></a> -<span class="sourceLineNo">081</span> styleImport = ctx.styleImport;<a name="line.81"></a> +<span class="sourceLineNo">081</span> stylesheet = ctx.stylesheet;<a name="line.81"></a> <span class="sourceLineNo">082</span> script = ctx.script;<a name="line.82"></a> <span class="sourceLineNo">083</span> nowrap = ctx.nowrap;<a name="line.83"></a> <span class="sourceLineNo">084</span> noResultsMessage = ctx.noResultsMessage;<a name="line.84"></a> @@ -102,7 +102,7 @@ <span class="sourceLineNo">094</span> Map m = op.getMap(HTMLDOC_links, ctx.links);<a name="line.94"></a> <span class="sourceLineNo">095</span> links = ObjectUtils.isEmpty(m) ? null : new LinkedHashMap(m);<a name="line.95"></a> <span class="sourceLineNo">096</span> style = op.getStringArray(HTMLDOC_style, ctx.style);<a name="line.96"></a> -<span class="sourceLineNo">097</span> styleImport = op.getStringArray(HTMLDOC_styleImport, ctx.styleImport);<a name="line.97"></a> +<span class="sourceLineNo">097</span> stylesheet = op.getStringArray(HTMLDOC_stylesheet, ctx.stylesheet);<a name="line.97"></a> <span class="sourceLineNo">098</span> script = op.getStringArray(HTMLDOC_script, ctx.script);<a name="line.98"></a> <span class="sourceLineNo">099</span> nowrap = op.getBoolean(HTMLDOC_nowrap, ctx.nowrap);<a name="line.99"></a> <span class="sourceLineNo">100</span> noResultsMessage = op.getString(HTMLDOC_noResultsMessage, ctx.noResultsMessage);<a name="line.100"></a> @@ -123,15 +123,15 @@ <span class="sourceLineNo">115</span> }<a name="line.115"></a> <span class="sourceLineNo">116</span><a name="line.116"></a> <span class="sourceLineNo">117</span> /**<a name="line.117"></a> -<span class="sourceLineNo">118</span> * Returns the {@link HtmlDocSerializerContext#HTMLDOC_styleImport} setting value in this context.<a name="line.118"></a> +<span class="sourceLineNo">118</span> * Returns the {@link HtmlDocSerializerContext#HTMLDOC_stylesheet} setting value in this context.<a name="line.118"></a> <span class="sourceLineNo">119</span> *<a name="line.119"></a> <span class="sourceLineNo">120</span> * @return<a name="line.120"></a> -<span class="sourceLineNo">121</span> * The {@link HtmlDocSerializerContext#HTMLDOC_styleImport} setting value in this context.<a name="line.121"></a> +<span class="sourceLineNo">121</span> * The {@link HtmlDocSerializerContext#HTMLDOC_stylesheet} setting value in this context.<a name="line.121"></a> <span class="sourceLineNo">122</span> * An empty array if not specified.<a name="line.122"></a> <span class="sourceLineNo">123</span> * Never <jk>null</jk>.<a name="line.123"></a> <span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> public final String[] getStyleImport() {<a name="line.125"></a> -<span class="sourceLineNo">126</span> return styleImport;<a name="line.126"></a> +<span class="sourceLineNo">125</span> public final String[] getStylesheet() {<a name="line.125"></a> +<span class="sourceLineNo">126</span> return stylesheet;<a name="line.126"></a> <span class="sourceLineNo">127</span> }<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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/d35b70d1/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplateBasic.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplateBasic.html b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplateBasic.html index 5755b18..6281e76 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplateBasic.html +++ b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlDocTemplateBasic.html @@ -49,10 +49,10 @@ <span class="sourceLineNo">041</span> @Override /* HtmlDocTemplate */<a name="line.41"></a> <span class="sourceLineNo">042</span> public void style(HtmlDocSerializerSession session, HtmlWriter w, HtmlDocSerializer s, Object o) throws Exception {<a name="line.42"></a> <span class="sourceLineNo">043</span><a name="line.43"></a> -<span class="sourceLineNo">044</span> String[] styleImport = session.getStyleImport();<a name="line.44"></a> -<span class="sourceLineNo">045</span> if (! ArrayUtils.contains("NONE", styleImport))<a name="line.45"></a> -<span class="sourceLineNo">046</span> for (String si : styleImport)<a name="line.46"></a> -<span class="sourceLineNo">047</span> w.append(2, "@import ").q().append(session.resolveUri(si)).q().appendln("; ");<a name="line.47"></a> +<span class="sourceLineNo">044</span> String[] stylesheet = session.getStylesheet();<a name="line.44"></a> +<span class="sourceLineNo">045</span> if (! ArrayUtils.contains("NONE", stylesheet))<a name="line.45"></a> +<span class="sourceLineNo">046</span> for (String ss : stylesheet)<a name="line.46"></a> +<span class="sourceLineNo">047</span> w.append(2, "@import ").q().append(session.resolveUri(ss)).q().appendln("; ");<a name="line.47"></a> <span class="sourceLineNo">048</span><a name="line.48"></a> <span class="sourceLineNo">049</span> if (session.isNoWrap())<a name="line.49"></a> <span class="sourceLineNo">050</span> w.appendln("div.data * {white-space:nowrap;} ");<a name="line.50"></a>
