GitHub-Mirror/rundeck-api-java-client
2
0
Fork 0
mirror of https://github.com/Fishwaldo/rundeck-api-java-client.git synced 2025-07-23 21:38:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
rundeck-api-java-client/xref/org/rundeck/api/ApiPathBuilder.html
Greg Schueler d18ef95f57 Wagon: Deploying site to repository
2012-12-31 17:34:38 -08:00

336 lines
41 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>ApiPathBuilder xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/rundeck/api/ApiPathBuilder.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Copyright 2011 Vincent Behar</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <strong class="jxr_keyword">package</strong> org.rundeck.api;
<a class="jxr_linenumber" name="17" href="#17">17</a>
<a class="jxr_linenumber" name="18" href="#18">18</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.Date;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Properties;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.http.NameValuePair;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.http.message.BasicNameValuePair;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.rundeck.api.util.ParametersUtil;
<a class="jxr_linenumber" name="30" href="#30">30</a>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Builder for API paths</em>
<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * @author Vincent Behar</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">class</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> {
<a class="jxr_linenumber" name="37" href="#37">37</a>
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Internally, we store everything in a {@link StringBuilder} */</em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> StringBuilder apiPath;
<a class="jxr_linenumber" name="40" href="#40">40</a>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> When POSTing, we can add attachments */</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map&lt;String, InputStream&gt; attachments;
<a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List&lt;NameValuePair&gt; form = <strong class="jxr_keyword">new</strong> ArrayList&lt;NameValuePair&gt;();
<a class="jxr_linenumber" name="44" href="#44">44</a>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Marker for using the right separator between parameters ("?" or "&amp;") */</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> firstParamDone = false;
<a class="jxr_linenumber" name="47" href="#47">47</a>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Build a new instance, for the given "path" (the "path" is the part before the parameters. The path and the</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * parameters are separated by a "?")</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @param paths elements of the path</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a>(String... paths) {
<a class="jxr_linenumber" name="55" href="#55">55</a> apiPath = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="56" href="#56">56</a> attachments = <strong class="jxr_keyword">new</strong> HashMap&lt;String, InputStream&gt;();
<a class="jxr_linenumber" name="57" href="#57">57</a> <strong class="jxr_keyword">if</strong> (paths != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="58" href="#58">58</a> <strong class="jxr_keyword">for</strong> (String path : paths) {
<a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(path)) {
<a class="jxr_linenumber" name="60" href="#60">60</a> append(path);
<a class="jxr_linenumber" name="61" href="#61">61</a> }
<a class="jxr_linenumber" name="62" href="#62">62</a> }
<a class="jxr_linenumber" name="63" href="#63">63</a> }
<a class="jxr_linenumber" name="64" href="#64">64</a> }
<a class="jxr_linenumber" name="65" href="#65">65</a>
<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * Visit a {@link BuildsParameters} and add the parameters</em>
<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> param(<a href="../../../org/rundeck/api/ApiPathBuilder.html">BuildsParameters</a> params) {
<a class="jxr_linenumber" name="70" href="#70">70</a> params.buildParameters(<strong class="jxr_keyword">this</strong>, false);
<a class="jxr_linenumber" name="71" href="#71">71</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="72" href="#72">72</a> }
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * Visit a {@link BuildsParameters} and add the parameters</em>
<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="76" href="#76">76</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> field(<a href="../../../org/rundeck/api/ApiPathBuilder.html">BuildsParameters</a> params) {
<a class="jxr_linenumber" name="77" href="#77">77</a> params.buildParameters(<strong class="jxr_keyword">this</strong>, <strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="79" href="#79">79</a> }
<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * Append the given parameter (key and value). This will only append the parameter if it is not blank (null, empty</em>
<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * or whitespace), and make sure to add the right separator ("?" or "&amp;") before. The key and value will be separated</em>
<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * by the "=" character. Also, the value will be url-encoded.</em>
<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @param key of the parameter. Must not be null or empty</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * @param value of the parameter. May be null/empty/blank. Will be url-encoded.</em>
<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @return this, for method chaining</em>
<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="89" href="#89">89</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> param(String key, String value) {
<a class="jxr_linenumber" name="90" href="#90">90</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(value)) {
<a class="jxr_linenumber" name="91" href="#91">91</a> appendSeparator();
<a class="jxr_linenumber" name="92" href="#92">92</a> append(key);
<a class="jxr_linenumber" name="93" href="#93">93</a> append(<span class="jxr_string">"="</span>);
<a class="jxr_linenumber" name="94" href="#94">94</a> append(ParametersUtil.urlEncode(value));
<a class="jxr_linenumber" name="95" href="#95">95</a> }
<a class="jxr_linenumber" name="96" href="#96">96</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="97" href="#97">97</a> }
<a class="jxr_linenumber" name="98" href="#98">98</a>
<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * Append the given parameter (key and value). This will only append the parameter if it is not blank (null, empty</em>
<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * or whitespace), and make sure to add the right separator ("?" or "&amp;") before. The key and value will be separated</em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * by the "=" character. Also, the value will be url-encoded.</em>
<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @param key of the parameter. Must not be null or empty</em>
<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @param value of the parameter. May be null/empty/blank. Will be url-encoded.</em>
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * @return this, for method chaining</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> param(<strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> Collection&lt;String&gt; values) {
<a class="jxr_linenumber" name="109" href="#109">109</a> <strong class="jxr_keyword">for</strong>(<strong class="jxr_keyword">final</strong> String value: values){
<a class="jxr_linenumber" name="110" href="#110">110</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(value)) {
<a class="jxr_linenumber" name="111" href="#111">111</a> appendSeparator();
<a class="jxr_linenumber" name="112" href="#112">112</a> append(key);
<a class="jxr_linenumber" name="113" href="#113">113</a> append(<span class="jxr_string">"="</span>);
<a class="jxr_linenumber" name="114" href="#114">114</a> append(ParametersUtil.urlEncode(value));
<a class="jxr_linenumber" name="115" href="#115">115</a> }
<a class="jxr_linenumber" name="116" href="#116">116</a> }
<a class="jxr_linenumber" name="117" href="#117">117</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="118" href="#118">118</a> }
<a class="jxr_linenumber" name="119" href="#119">119</a>
<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * Append multiple values for the given Form field. This will be appended if it is not blank (null, empty</em>
<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * or whitespace). The form field values will only be used for a "post" request</em>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @param key of the field name. Must not be null or empty</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * @param values of the field. May be null/empty/blank. Will be url-encoded.</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @return this, for method chaining</em>
<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="128" href="#128">128</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> field(<strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> Collection&lt;String&gt; values) {
<a class="jxr_linenumber" name="129" href="#129">129</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong>!=values) {
<a class="jxr_linenumber" name="130" href="#130">130</a> <strong class="jxr_keyword">for</strong>(<strong class="jxr_keyword">final</strong> String value: values){
<a class="jxr_linenumber" name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(value)) {
<a class="jxr_linenumber" name="132" href="#132">132</a> form.add(<strong class="jxr_keyword">new</strong> BasicNameValuePair(key, value));
<a class="jxr_linenumber" name="133" href="#133">133</a> }
<a class="jxr_linenumber" name="134" href="#134">134</a> }
<a class="jxr_linenumber" name="135" href="#135">135</a> }
<a class="jxr_linenumber" name="136" href="#136">136</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="137" href="#137">137</a> }
<a class="jxr_linenumber" name="138" href="#138">138</a>
<a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * Append a single value for the given Form field. This will be appended if it is not blank (null, empty</em>
<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * or whitespace). The form field values will only be used for a "post" request</em>
<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @param key of the field name. Must not be null or empty</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * @param value of the field. May be null/empty/blank. Will be url-encoded.</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * @return this, for method chaining</em>
<a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="147" href="#147">147</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> field(<strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> String value) {
<a class="jxr_linenumber" name="148" href="#148">148</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(value)) {
<a class="jxr_linenumber" name="149" href="#149">149</a> form.add(<strong class="jxr_keyword">new</strong> BasicNameValuePair(key, value));
<a class="jxr_linenumber" name="150" href="#150">150</a> }
<a class="jxr_linenumber" name="151" href="#151">151</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="152" href="#152">152</a> }
<a class="jxr_linenumber" name="153" href="#153">153</a>
<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure</em>
<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * to add the right separator ("?" or "&amp;") before. The key and value will be separated by the "=" character. Also,</em>
<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * the value will be converted to lower-case.</em>
<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * @param key of the parameter. Must not be null or empty</em>
<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @param value of the parameter. May be null</em>
<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * @return this, for method chaining</em>
<a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="163" href="#163">163</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> param(String key, Enum&lt;?&gt; value) {
<a class="jxr_linenumber" name="164" href="#164">164</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="165" href="#165">165</a> param(key, StringUtils.lowerCase(value.toString()));
<a class="jxr_linenumber" name="166" href="#166">166</a> }
<a class="jxr_linenumber" name="167" href="#167">167</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="168" href="#168">168</a> }
<a class="jxr_linenumber" name="169" href="#169">169</a>
<a class="jxr_linenumber" name="170" href="#170">170</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure</em>
<a class="jxr_linenumber" name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * to add the right separator ("?" or "&amp;") before. The key and value will be separated by the "=" character.</em>
<a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * @param key of the parameter. Must not be null or empty</em>
<a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * @param value of the parameter. May be null</em>
<a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * @return this, for method chaining</em>
<a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="178" href="#178">178</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> param(String key, Date value) {
<a class="jxr_linenumber" name="179" href="#179">179</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="180" href="#180">180</a> param(key, value.getTime());
<a class="jxr_linenumber" name="181" href="#181">181</a> }
<a class="jxr_linenumber" name="182" href="#182">182</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="183" href="#183">183</a> }
<a class="jxr_linenumber" name="184" href="#184">184</a>
<a class="jxr_linenumber" name="185" href="#185">185</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="186" href="#186">186</a> <em class="jxr_javadoccomment"> * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure</em>
<a class="jxr_linenumber" name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * to add the right separator ("?" or "&amp;") before. The key and value will be separated by the "=" character.</em>
<a class="jxr_linenumber" name="188" href="#188">188</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * @param key of the parameter. Must not be null or empty</em>
<a class="jxr_linenumber" name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * @param value of the parameter. May be null</em>
<a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * @return this, for method chaining</em>
<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="193" href="#193">193</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> param(String key, Long value) {
<a class="jxr_linenumber" name="194" href="#194">194</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="195" href="#195">195</a> param(key, value.toString());
<a class="jxr_linenumber" name="196" href="#196">196</a> }
<a class="jxr_linenumber" name="197" href="#197">197</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="198" href="#198">198</a> }
<a class="jxr_linenumber" name="199" href="#199">199</a>
<a class="jxr_linenumber" name="200" href="#200">200</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure</em>
<a class="jxr_linenumber" name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * to add the right separator ("?" or "&amp;") before. The key and value will be separated by the "=" character.</em>
<a class="jxr_linenumber" name="203" href="#203">203</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * @param key of the parameter. Must not be null or empty</em>
<a class="jxr_linenumber" name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * @param value of the parameter. May be null</em>
<a class="jxr_linenumber" name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * @return this, for method chaining</em>
<a class="jxr_linenumber" name="207" href="#207">207</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="208" href="#208">208</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> param(String key, Integer value) {
<a class="jxr_linenumber" name="209" href="#209">209</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="210" href="#210">210</a> param(key, value.toString());
<a class="jxr_linenumber" name="211" href="#211">211</a> }
<a class="jxr_linenumber" name="212" href="#212">212</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="213" href="#213">213</a> }
<a class="jxr_linenumber" name="214" href="#214">214</a>
<a class="jxr_linenumber" name="215" href="#215">215</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * Append the given parameter (key and value). This will only append the parameter if it is not null, and make sure</em>
<a class="jxr_linenumber" name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * to add the right separator ("?" or "&amp;") before. The key and value will be separated by the "=" character.</em>
<a class="jxr_linenumber" name="218" href="#218">218</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * @param key of the parameter. Must not be null or empty</em>
<a class="jxr_linenumber" name="220" href="#220">220</a> <em class="jxr_javadoccomment"> * @param value of the parameter. May be null</em>
<a class="jxr_linenumber" name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * @return this, for method chaining</em>
<a class="jxr_linenumber" name="222" href="#222">222</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="223" href="#223">223</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> param(String key, Boolean value) {
<a class="jxr_linenumber" name="224" href="#224">224</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="225" href="#225">225</a> param(key, value.toString());
<a class="jxr_linenumber" name="226" href="#226">226</a> }
<a class="jxr_linenumber" name="227" href="#227">227</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="228" href="#228">228</a> }
<a class="jxr_linenumber" name="229" href="#229">229</a>
<a class="jxr_linenumber" name="230" href="#230">230</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * Append the given node filters, only if it is not null/empty</em>
<a class="jxr_linenumber" name="232" href="#232">232</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * @param nodeFilters may be null/empty</em>
<a class="jxr_linenumber" name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * @return this, for method chaining</em>
<a class="jxr_linenumber" name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * @see ParametersUtil#generateNodeFiltersString(Properties)</em>
<a class="jxr_linenumber" name="236" href="#236">236</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="237" href="#237">237</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> nodeFilters(Properties nodeFilters) {
<a class="jxr_linenumber" name="238" href="#238">238</a> String filters = ParametersUtil.generateNodeFiltersString(nodeFilters);
<a class="jxr_linenumber" name="239" href="#239">239</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(filters)) {
<a class="jxr_linenumber" name="240" href="#240">240</a> appendSeparator();
<a class="jxr_linenumber" name="241" href="#241">241</a> append(filters);
<a class="jxr_linenumber" name="242" href="#242">242</a> }
<a class="jxr_linenumber" name="243" href="#243">243</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="244" href="#244">244</a> }
<a class="jxr_linenumber" name="245" href="#245">245</a>
<a class="jxr_linenumber" name="246" href="#246">246</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="247" href="#247">247</a> <em class="jxr_javadoccomment"> * When POSTing a request, add the given {@link InputStream} as an attachment to the content of the request. This</em>
<a class="jxr_linenumber" name="248" href="#248">248</a> <em class="jxr_javadoccomment"> * will only add the stream if it is not null.</em>
<a class="jxr_linenumber" name="249" href="#249">249</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * @param name of the attachment. Must not be null or empty</em>
<a class="jxr_linenumber" name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * @param stream. May be null</em>
<a class="jxr_linenumber" name="252" href="#252">252</a> <em class="jxr_javadoccomment"> * @return this, for method chaining</em>
<a class="jxr_linenumber" name="253" href="#253">253</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="254" href="#254">254</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> attach(String name, InputStream stream) {
<a class="jxr_linenumber" name="255" href="#255">255</a> <strong class="jxr_keyword">if</strong> (stream != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="256" href="#256">256</a> attachments.put(name, stream);
<a class="jxr_linenumber" name="257" href="#257">257</a> }
<a class="jxr_linenumber" name="258" href="#258">258</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="259" href="#259">259</a> }
<a class="jxr_linenumber" name="260" href="#260">260</a>
<a class="jxr_linenumber" name="261" href="#261">261</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="262" href="#262">262</a> <em class="jxr_javadoccomment"> * @return all attachments to be POSTed, with their names</em>
<a class="jxr_linenumber" name="263" href="#263">263</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="264" href="#264">264</a> <strong class="jxr_keyword">public</strong> Map&lt;String, InputStream&gt; getAttachments() {
<a class="jxr_linenumber" name="265" href="#265">265</a> <strong class="jxr_keyword">return</strong> attachments;
<a class="jxr_linenumber" name="266" href="#266">266</a> }
<a class="jxr_linenumber" name="267" href="#267">267</a>
<a class="jxr_linenumber" name="268" href="#268">268</a> @Override
<a class="jxr_linenumber" name="269" href="#269">269</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="270" href="#270">270</a> <strong class="jxr_keyword">return</strong> apiPath.toString();
<a class="jxr_linenumber" name="271" href="#271">271</a> }
<a class="jxr_linenumber" name="272" href="#272">272</a>
<a class="jxr_linenumber" name="273" href="#273">273</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="274" href="#274">274</a> <em class="jxr_javadoccomment"> * Append the given string</em>
<a class="jxr_linenumber" name="275" href="#275">275</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * @param str to append</em>
<a class="jxr_linenumber" name="277" href="#277">277</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="278" href="#278">278</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> append(String str) {
<a class="jxr_linenumber" name="279" href="#279">279</a> apiPath.append(str);
<a class="jxr_linenumber" name="280" href="#280">280</a> }
<a class="jxr_linenumber" name="281" href="#281">281</a>
<a class="jxr_linenumber" name="282" href="#282">282</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * Append the right separator "?" or "&amp;" between 2 parameters</em>
<a class="jxr_linenumber" name="284" href="#284">284</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="285" href="#285">285</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendSeparator() {
<a class="jxr_linenumber" name="286" href="#286">286</a> <strong class="jxr_keyword">if</strong> (firstParamDone) {
<a class="jxr_linenumber" name="287" href="#287">287</a> append(<span class="jxr_string">"&amp;"</span>);
<a class="jxr_linenumber" name="288" href="#288">288</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="289" href="#289">289</a> append(<span class="jxr_string">"?"</span>);
<a class="jxr_linenumber" name="290" href="#290">290</a> firstParamDone = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="291" href="#291">291</a> }
<a class="jxr_linenumber" name="292" href="#292">292</a> }
<a class="jxr_linenumber" name="293" href="#293">293</a>
<a class="jxr_linenumber" name="294" href="#294">294</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * Form fields for POST request</em>
<a class="jxr_linenumber" name="296" href="#296">296</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="297" href="#297">297</a> <strong class="jxr_keyword">public</strong> List&lt;NameValuePair&gt; getForm() {
<a class="jxr_linenumber" name="298" href="#298">298</a> <strong class="jxr_keyword">return</strong> form;
<a class="jxr_linenumber" name="299" href="#299">299</a> }
<a class="jxr_linenumber" name="300" href="#300">300</a>
<a class="jxr_linenumber" name="301" href="#301">301</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="302" href="#302">302</a> <em class="jxr_javadoccomment"> * Return true if there are any Attachments or Form data for a POST request.</em>
<a class="jxr_linenumber" name="303" href="#303">303</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="304" href="#304">304</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasPostContent() {
<a class="jxr_linenumber" name="305" href="#305">305</a> <strong class="jxr_keyword">return</strong> getAttachments().size() &gt; 0 || getForm().size() &gt; 0;
<a class="jxr_linenumber" name="306" href="#306">306</a> }
<a class="jxr_linenumber" name="307" href="#307">307</a>
<a class="jxr_linenumber" name="308" href="#308">308</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * BuildsParameters can add URL or POST parameters to an {@link ApiPathBuilder}</em>
<a class="jxr_linenumber" name="310" href="#310">310</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="311" href="#311">311</a> <em class="jxr_javadoccomment"> * @author Greg Schueler &lt;a href="<a href="mailto:greg@dtosolutions.com" target="alexandria_uri">mailto:greg@dtosolutions.com</a>"&gt;greg@dtosolutions.com&lt;/a&gt;</em>
<a class="jxr_linenumber" name="312" href="#312">312</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="313" href="#313">313</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/rundeck/api/ApiPathBuilder.html">BuildsParameters</a> {
<a class="jxr_linenumber" name="314" href="#314">314</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="315" href="#315">315</a> <em class="jxr_javadoccomment"> * Add the parameters or form fields to the ApiPathBuilder</em>
<a class="jxr_linenumber" name="316" href="#316">316</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="317" href="#317">317</a> <em class="jxr_javadoccomment"> * @param builder the builder</em>
<a class="jxr_linenumber" name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * @param doPost if true, use form fields, otherwise use query parameters</em>
<a class="jxr_linenumber" name="319" href="#319">319</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="320" href="#320">320</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> buildParameters(<a href="../../../org/rundeck/api/ApiPathBuilder.html">ApiPathBuilder</a> builder, <strong class="jxr_keyword">boolean</strong> doPost);
<a class="jxr_linenumber" name="321" href="#321">321</a> }
<a class="jxr_linenumber" name="322" href="#322">322</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
Reference in a new issue View git blame Copy permalink