All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.http.client.params.ClientPNames Maven / Gradle / Ivy

There is a newer version: 4.5.14
Show newest version
/*
 * ====================================================================
 *
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * .
 *
 */

package org.apache.http.client.params;

/**
 * Parameter names for HTTP client parameters.
 *
 * @since 4.0
 */
public interface ClientPNames {

    /**
     * Defines the class name of the default {@link org.apache.http.conn.ClientConnectionManager}
     * 

* This parameter expects a value of type {@link String}. *

*/ public static final String CONNECTION_MANAGER_FACTORY_CLASS_NAME = "http.connection-manager.factory-class-name"; /** * @deprecated use #CONNECTION_MANAGER_FACTORY_CLASS_NAME */ @Deprecated public static final String CONNECTION_MANAGER_FACTORY = "http.connection-manager.factory-object"; /** * Defines whether redirects should be handled automatically *

* This parameter expects a value of type {@link Boolean}. *

*/ public static final String HANDLE_REDIRECTS = "http.protocol.handle-redirects"; /** * Defines whether relative redirects should be rejected. HTTP specification * requires the location value be an absolute URI. *

* This parameter expects a value of type {@link Boolean}. *

*/ public static final String REJECT_RELATIVE_REDIRECT = "http.protocol.reject-relative-redirect"; /** * Defines the maximum number of redirects to be followed. * The limit on number of redirects is intended to prevent infinite loops. *

* This parameter expects a value of type {@link Integer}. *

*/ public static final String MAX_REDIRECTS = "http.protocol.max-redirects"; /** * Defines whether circular redirects (redirects to the same location) should be allowed. * The HTTP spec is not sufficiently clear whether circular redirects are permitted, * therefore optionally they can be enabled *

* This parameter expects a value of type {@link Boolean}. *

*/ public static final String ALLOW_CIRCULAR_REDIRECTS = "http.protocol.allow-circular-redirects"; /** * Defines whether authentication should be handled automatically. *

* This parameter expects a value of type {@link Boolean}. *

*/ public static final String HANDLE_AUTHENTICATION = "http.protocol.handle-authentication"; /** * Defines the name of the cookie specification to be used for HTTP state management. *

* This parameter expects a value of type {@link String}. *

*/ public static final String COOKIE_POLICY = "http.protocol.cookie-policy"; /** * Defines the virtual host name to be used in the Host * request header instead of the physical host name. *

* This parameter expects a value of type {@link org.apache.http.HttpHost}. *

*/ public static final String VIRTUAL_HOST = "http.virtual-host"; /** * Defines the request headers to be sent per default with each request. *

* This parameter expects a value of type {@link java.util.Collection}. The * collection is expected to contain {@link org.apache.http.Header}s. *

*/ public static final String DEFAULT_HEADERS = "http.default-headers"; /** * Defines the default host. The default value will be used if the target host is * not explicitly specified in the request URI. *

* This parameter expects a value of type {@link org.apache.http.HttpHost}. *

*/ public static final String DEFAULT_HOST = "http.default-host"; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy