michael@0: /*
michael@0:  * ====================================================================
michael@0:  *
michael@0:  *  Licensed to the Apache Software Foundation (ASF) under one or more
michael@0:  *  contributor license agreements.  See the NOTICE file distributed with
michael@0:  *  this work for additional information regarding copyright ownership.
michael@0:  *  The ASF licenses this file to You under the Apache License, Version 2.0
michael@0:  *  (the "License"); you may not use this file except in compliance with
michael@0:  *  the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *      http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  *  Unless required by applicable law or agreed to in writing, software
michael@0:  *  distributed under the License is distributed on an "AS IS" BASIS,
michael@0:  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0:  *  See the License for the specific language governing permissions and
michael@0:  *  limitations under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.client.params;
michael@0: 
michael@0: /**
michael@0:  * Parameter names for HTTP client parameters.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface ClientPNames {
michael@0: 
michael@0:     /**
michael@0:      * Defines the class name of the default {@link ch.boye.httpclientandroidlib.conn.ClientConnectionManager}
michael@0:      * <p>
michael@0:      * This parameter expects a value of type {@link String}.
michael@0:      * </p>
michael@0:      */
michael@0:     public static final String CONNECTION_MANAGER_FACTORY_CLASS_NAME = "http.connection-manager.factory-class-name";
michael@0: 
michael@0:     /**
michael@0:      * @deprecated use #CONNECTION_MANAGER_FACTORY_CLASS_NAME
michael@0:      */
michael@0:     @Deprecated
michael@0:     public static final String CONNECTION_MANAGER_FACTORY = "http.connection-manager.factory-object";
michael@0: 
michael@0:     /**
michael@0:      * Defines whether redirects should be handled automatically
michael@0:      * <p>
michael@0:      * This parameter expects a value of type {@link Boolean}.
michael@0:      * </p>
michael@0:      */
michael@0:     public static final String HANDLE_REDIRECTS = "http.protocol.handle-redirects";
michael@0: 
michael@0:     /**
michael@0:      * Defines whether relative redirects should be rejected. HTTP specification
michael@0:      * requires the location value be an absolute URI.
michael@0:      * <p>
michael@0:      * This parameter expects a value of type {@link Boolean}.
michael@0:      * </p>
michael@0:      */
michael@0:     public static final String REJECT_RELATIVE_REDIRECT = "http.protocol.reject-relative-redirect";
michael@0: 
michael@0:     /**
michael@0:      * Defines the maximum number of redirects to be followed.
michael@0:      * The limit on number of redirects is intended to prevent infinite loops.
michael@0:      * <p>
michael@0:      * This parameter expects a value of type {@link Integer}.
michael@0:      * </p>
michael@0:      */
michael@0:     public static final String MAX_REDIRECTS = "http.protocol.max-redirects";
michael@0: 
michael@0:     /**
michael@0:      * Defines whether circular redirects (redirects to the same location) should be allowed.
michael@0:      * The HTTP spec is not sufficiently clear whether circular redirects are permitted,
michael@0:      * therefore optionally they can be enabled
michael@0:      * <p>
michael@0:      * This parameter expects a value of type {@link Boolean}.
michael@0:      * </p>
michael@0:      */
michael@0:     public static final String ALLOW_CIRCULAR_REDIRECTS = "http.protocol.allow-circular-redirects";
michael@0: 
michael@0:     /**
michael@0:      * Defines whether authentication should be handled automatically.
michael@0:      * <p>
michael@0:      * This parameter expects a value of type {@link Boolean}.
michael@0:      * </p>
michael@0:      */
michael@0:     public static final String HANDLE_AUTHENTICATION = "http.protocol.handle-authentication";
michael@0: 
michael@0:     /**
michael@0:      * Defines the name of the cookie specification to be used for HTTP state management.
michael@0:      * <p>
michael@0:      * This parameter expects a value of type {@link String}.
michael@0:      * </p>
michael@0:      */
michael@0:     public static final String COOKIE_POLICY = "http.protocol.cookie-policy";
michael@0: 
michael@0:     /**
michael@0:      * Defines the virtual host to be used in the <code>Host</code>
michael@0:      * request header instead of the physical host.
michael@0:      * <p>
michael@0:      * This parameter expects a value of type {@link ch.boye.httpclientandroidlib.HttpHost}.
michael@0:      * </p>
michael@0:      * If a port is not provided, it will be derived from the request URL.
michael@0:      */
michael@0:     public static final String VIRTUAL_HOST = "http.virtual-host";
michael@0: 
michael@0:     /**
michael@0:      * Defines the request headers to be sent per default with each request.
michael@0:      * <p>
michael@0:      * This parameter expects a value of type {@link java.util.Collection}. The
michael@0:      * collection is expected to contain {@link ch.boye.httpclientandroidlib.Header}s.
michael@0:      * </p>
michael@0:      */
michael@0:     public static final String DEFAULT_HEADERS = "http.default-headers";
michael@0: 
michael@0:     /**
michael@0:      * Defines the default host. The default value will be used if the target host is
michael@0:      * not explicitly specified in the request URI.
michael@0:      * <p>
michael@0:      * This parameter expects a value of type {@link ch.boye.httpclientandroidlib.HttpHost}.
michael@0:      * </p>
michael@0:      */
michael@0:     public static final String DEFAULT_HOST = "http.default-host";
michael@0: 
michael@0: }
michael@0: