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 package org.apache.commons.httpclient.params;
31
32 import org.apache.commons.logging.Log;
33 import org.apache.commons.logging.LogFactory;
34
35 /***
36 * This class represents a collection of HTTP protocol parameters applicable to
37 * {@link org.apache.commons.httpclient.HostConfiguration instances of HostConfiguration}.
38 * Protocol parameters may be linked together to form a hierarchy. If a particular
39 * parameter value has not been explicitly defined in the collection itself, its
40 * value will be drawn from the parent collection of parameters.
41 *
42 * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
43 *
44 * @version $Revision: 155418 $
45 *
46 * @since 3.0
47 */
48 public class HostParams extends DefaultHttpParams {
49
50 /*** Log object for this class. */
51 private static final Log LOG = LogFactory.getLog(HttpParams.class);
52
53 /***
54 * Defines the request headers to be sent per default with each request.
55 * <p>
56 * This parameter expects a value of type {@link java.util.Collection}. The
57 * collection is expected to contain {@link org.apache.commons.httpclient.Header}s.
58 * </p>
59 */
60 public static final String DEFAULT_HEADERS = "http.default-headers";
61
62 /***
63 * Creates a new collection of parameters with the collection returned
64 * by {@link #getDefaultParams()} as a parent. The collection will defer
65 * to its parent for a default value if a particular parameter is not
66 * explicitly set in the collection itself.
67 *
68 * @see #getDefaultParams()
69 */
70 public HostParams() {
71 super();
72 }
73
74 /***
75 * Creates a new collection of parameters with the given parent.
76 * The collection will defer to its parent for a default value
77 * if a particular parameter is not explicitly set in the collection
78 * itself.
79 *
80 * @param defaults the parent collection to defer to, if a parameter
81 * is not explictly set in the collection itself.
82 *
83 * @see #getDefaultParams()
84 */
85 public HostParams(HttpParams defaults) {
86 super(defaults);
87 }
88
89 /***
90 * Sets the virtual host name.
91 *
92 * @param hostname The host name
93 */
94 public void setVirtualHost(final String hostname) {
95 setParameter(HttpMethodParams.VIRTUAL_HOST, hostname);
96 }
97
98 /***
99 * Returns the virtual host name.
100 *
101 * @return The virtual host name
102 */
103 public String getVirtualHost() {
104 return (String) getParameter(HttpMethodParams.VIRTUAL_HOST);
105 }
106
107 }