1 /**
2 * Licensed to jclouds, Inc. (jclouds) under one or more
3 * contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. jclouds licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.jclouds.http.options;
20
21 import com.google.common.collect.Multimap;
22
23 /**
24 * Builds options that override or append to HttpRequests.
25 *
26 * @author Adrian Cole
27 *
28 */
29 public interface HttpRequestOptions {
30
31 /**
32 * Builds headers representing options.
33 *
34 * @return multimap that may contain headers.
35 */
36 Multimap<String, String> buildRequestHeaders();
37
38 /**
39 * Builds query parameters representing options.
40 *
41 * @return map that may contain query parameters.
42 */
43 Multimap<String, String> buildQueryParameters();
44
45 /**
46 * Builds form parameters representing options.
47 *
48 * @return map that may contain query parameters.
49 */
50 Multimap<String, String> buildFormParameters();
51
52 /**
53 * Builds matrix parameters representing options.
54 *
55 * @return multimap that may contain matrix parameters.
56 */
57 Multimap<String, String> buildMatrixParameters();
58
59 String buildStringPayload();
60
61 String buildPathSuffix();
62
63 }