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: 155418 $
4    * $Date: 2005-02-26 08:01:52 -0500 (Sat, 26 Feb 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  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 }