summaryrefslogtreecommitdiffstats
path: root/docs/manual/tasks/post-method_task.html
blob: 0d9cb3c255a1d34b78056eba22f27745cd3af6bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>Ant-contrib Tasks: Http Tasks</title>
  </head>

  <body>
    <h1>Post-Method</h1>
    The &lt;post-method&gt; task allows the caller to use the HTTP POST
    method to send data to an arbitrary url.  This data can be one of the
    following:
    <ul>
    <li>Name/Value pairs</li>
    <li>File content</li>
    <li>Text content</li>
    <li>Multi-part content</li>
    </ul>
    This method inherits the <a href="method_task_common.html">
    Common Method</a> attributes and subelements.  It also contains
    the following additional attributes and subelements:


    <h2>Parameters</h2>
    <table border="1" cellpadding="2" cellspacing="0">
      <tr>
        <th>Attribute</th>
        <th>Description</th>
        <th>Required</th>
      </tr>
      <tr>
        <td valign="top"><i>multipart</i></td>
        <td valign="top">Should multipart content be forced, even if
          only a single file or text part is specified.</td>
        <td align="center" valign="top">No.</td>
      </tr>
      <tr>
        <td valign="top"><i>parameters</td>
        <td valign="top">A java .properties file which contains post parameters.</td>
        <td align="center" valign="top">No.</td>
      </tr>
    </table>
    
    <h2>Parameters specified as Nested Elements</h2>
    

    <br />
    <br />
    <b>&lt;parameter&gt;</b><br />
    <p>
    Create a text post parameter.
    </p>
    <table border="1" cellpadding="2" cellspacing="0">
      <tr>
        <th>Attribute</th>
        <th>Description</th>
        <th>Required</th>
      </tr>
      <tr>
        <td valign="top"><i>name</i></td>
        <td valign="top">The parameter name.</td>
        <td align="center" valign="top">Yes.</td>
      </tr>
      <tr>
        <td valign="top"><i>value</i></td>
        <td valign="top">The parameter value.</td>
        <td align="center" valign="top">Yes.</td>
      </tr>
    </table>

    <br />
    <br />
    <b>&lt;file&gt;</b><br />
    <p>
    Add a File part to the request.
    </p>
    <table border="1" cellpadding="2" cellspacing="0">
      <tr>
        <th>Attribute</th>
        <th>Description</th>
        <th>Required</th>
      </tr>
      <tr>
        <td valign="top"><i>name</i></td>
        <td valign="top">The parameter name.</td>
        <td align="center" valign="top">Yes.</td>
      </tr>
      <tr>
        <td valign="top"><i>path</i></td>
        <td valign="top">The file path to send.</td>
        <td align="center" valign="top">Yes.</td>
      </tr>
      <tr>
        <td valign="top"><i>contentType</i></td>
        <td valign="top">The content type of the file.</td>
        <td align="center" valign="top">No.</td>
      </tr>
      <tr>
        <td valign="top"><i>charSet</i></td>
        <td valign="top">The character set.</td>
        <td align="center" valign="top">No.</td>
      </tr>
    </table>

    <br />
    <br />
    <b>&lt;text&gt;</b><br />
    <p>
    Add a Text part to the request.
    </p>
    <table border="1" cellpadding="2" cellspacing="0">
      <tr>
        <th>Attribute</th>
        <th>Description</th>
        <th>Required</th>
      </tr>
      <tr>
        <td valign="top"><i>name</i></td>
        <td valign="top">The parameter name.</td>
        <td align="center" valign="top">Yes.</td>
      </tr>
      <tr>
        <td valign="top"><i>value</i></td>
        <td valign="top">The string value to send.  This may
        also be specified as nested text to this element.</td>
        <td align="center" valign="top">Yes.</td>
      </tr>
      <tr>
        <td valign="top"><i>contentType</i></td>
        <td valign="top">The content type of the file.</td>
        <td align="center" valign="top">No.</td>
      </tr>
      <tr>
        <td valign="top"><i>charSet</i></td>
        <td valign="top">The character set.</td>
        <td align="center" valign="top">No.</td>
      </tr>
    </table>


    <h2>Examples</h2>


    <hr>
    <p align="center">Copyright &copy; 2002-2003 Ant-Contrib Project. All
    rights Reserved.</p>

  </body>
</html>