001: /*
002: * $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 $
003: * $Revision: 480424 $
004: * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $
005: *
006: * ====================================================================
007: *
008: * Licensed to the Apache Software Foundation (ASF) under one or more
009: * contributor license agreements. See the NOTICE file distributed with
010: * this work for additional information regarding copyright ownership.
011: * The ASF licenses this file to You under the Apache License, Version 2.0
012: * (the "License"); you may not use this file except in compliance with
013: * the License. You may obtain a copy of the License at
014: *
015: * http://www.apache.org/licenses/LICENSE-2.0
016: *
017: * Unless required by applicable law or agreed to in writing, software
018: * distributed under the License is distributed on an "AS IS" BASIS,
019: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
020: * See the License for the specific language governing permissions and
021: * limitations under the License.
022: * ====================================================================
023: *
024: * This software consists of voluntary contributions made by many
025: * individuals on behalf of the Apache Software Foundation. For more
026: * information on the Apache Software Foundation, please see
027: * <http://www.apache.org/>.
028: *
029: */
030:
031: package org.apache.commons.httpclient.params;
032:
033: /**
034: * This class represents a collection of HTTP protocol parameters applicable to
035: * {@link org.apache.commons.httpclient.HostConfiguration instances of HostConfiguration}.
036: * Protocol parameters may be linked together to form a hierarchy. If a particular
037: * parameter value has not been explicitly defined in the collection itself, its
038: * value will be drawn from the parent collection of parameters.
039: *
040: * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
041: *
042: * @version $Revision: 480424 $
043: *
044: * @since 3.0
045: */
046: public class HostParams extends DefaultHttpParams {
047:
048: /**
049: * Defines the request headers to be sent per default with each request.
050: * <p>
051: * This parameter expects a value of type {@link java.util.Collection}. The
052: * collection is expected to contain {@link org.apache.commons.httpclient.Header}s.
053: * </p>
054: */
055: public static final String DEFAULT_HEADERS = "http.default-headers";
056:
057: /**
058: * Creates a new collection of parameters with the collection returned
059: * by {@link #getDefaultParams()} as a parent. The collection will defer
060: * to its parent for a default value if a particular parameter is not
061: * explicitly set in the collection itself.
062: *
063: * @see #getDefaultParams()
064: */
065: public HostParams() {
066: super ();
067: }
068:
069: /**
070: * Creates a new collection of parameters with the given parent.
071: * The collection will defer to its parent for a default value
072: * if a particular parameter is not explicitly set in the collection
073: * itself.
074: *
075: * @param defaults the parent collection to defer to, if a parameter
076: * is not explictly set in the collection itself.
077: *
078: * @see #getDefaultParams()
079: */
080: public HostParams(HttpParams defaults) {
081: super (defaults);
082: }
083:
084: /**
085: * Sets the virtual host name.
086: *
087: * @param hostname The host name
088: */
089: public void setVirtualHost(final String hostname) {
090: setParameter(HttpMethodParams.VIRTUAL_HOST, hostname);
091: }
092:
093: /**
094: * Returns the virtual host name.
095: *
096: * @return The virtual host name
097: */
098: public String getVirtualHost() {
099: return (String) getParameter(HttpMethodParams.VIRTUAL_HOST);
100: }
101:
102: }
|