View Javadoc

1   /*
2    * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/params/HostParams.java,v 1.5 2004/10/06 17:32:04 olegk Exp $
3    * $Revision: 224451 $
4    * $Date: 2005-07-23 06:23:59 -0400 (Sat, 23 Jul 2005) $
5    *
6    * ====================================================================
7    *
8    *  Copyright 1999-2004 The Apache Software Foundation
9    *
10   *  Licensed under the Apache License, Version 2.0 (the "License");
11   *  you may not use this file except in compliance with the License.
12   *  You may obtain a copy of the License at
13   *
14   *      http://www.apache.org/licenses/LICENSE-2.0
15   *
16   *  Unless required by applicable law or agreed to in writing, software
17   *  distributed under the License is distributed on an "AS IS" BASIS,
18   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19   *  See the License for the specific language governing permissions and
20   *  limitations under the License.
21   * ====================================================================
22   *
23   * This software consists of voluntary contributions made by many
24   * individuals on behalf of the Apache Software Foundation.  For more
25   * information on the Apache Software Foundation, please see
26   * <http://www.apache.org/>.
27   *
28   */
29  
30  package org.apache.commons.httpclient.params;
31  
32  /***
33   * This class represents a collection of HTTP protocol parameters applicable to 
34   * {@link org.apache.commons.httpclient.HostConfiguration instances of HostConfiguration}. 
35   * Protocol parameters may be linked together to form a hierarchy. If a particular 
36   * parameter value has not been explicitly defined in the collection itself, its 
37   * value will be drawn from the parent collection of parameters.
38   * 
39   * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
40   * 
41   * @version $Revision: 224451 $
42   * 
43   * @since 3.0
44   */
45  public class HostParams extends DefaultHttpParams {
46  
47      /***
48       * Defines the request headers to be sent per default with each request.
49       * <p>
50       * This parameter expects a value of type {@link java.util.Collection}. The 
51       * collection is expected to contain {@link org.apache.commons.httpclient.Header}s. 
52       * </p>
53       */
54      public static final String DEFAULT_HEADERS = "http.default-headers"; 
55  
56      /***
57       * Creates a new collection of parameters with the collection returned
58       * by {@link #getDefaultParams()} as a parent. The collection will defer
59       * to its parent for a default value if a particular parameter is not 
60       * explicitly set in the collection itself.
61       * 
62       * @see #getDefaultParams()
63       */
64      public HostParams() {
65          super();
66      }
67  
68      /***
69       * Creates a new collection of parameters with the given parent. 
70       * The collection will defer to its parent for a default value 
71       * if a particular parameter is not explicitly set in the collection
72       * itself.
73       * 
74       * @param defaults the parent collection to defer to, if a parameter
75       * is not explictly set in the collection itself.
76       *
77       * @see #getDefaultParams()
78       */
79      public HostParams(HttpParams defaults) {
80          super(defaults);
81      }
82      
83      /***
84       * Sets the virtual host name.
85       * 
86       * @param hostname The host name
87       */
88      public void setVirtualHost(final String hostname) {
89          setParameter(HttpMethodParams.VIRTUAL_HOST, hostname);
90      }
91  
92      /***
93       * Returns the virtual host name.
94       * 
95       * @return The virtual host name
96       */
97      public String getVirtualHost() {
98          return (String) getParameter(HttpMethodParams.VIRTUAL_HOST);
99      }
100         
101 }