/*
 * ====================================================================
 * 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
 * <http://www.apache.org/>.
 *
 */
package org.apache.http.client.params;

import org.apache.http.params.HttpConnectionParams;
import org.apache.http.params.HttpParams;
import org.apache.http.util.Args;

An adaptor for manipulating HTTP client parameters in HttpParams.
Since:4.0
Deprecated:(4.3) use RequestConfig
/** * An adaptor for manipulating HTTP client parameters in {@link HttpParams}. * * @since 4.0 * * @deprecated (4.3) use {@link org.apache.http.client.config.RequestConfig} */
@Deprecated public class HttpClientParams { private HttpClientParams() { super(); } public static boolean isRedirecting(final HttpParams params) { Args.notNull(params, "HTTP parameters"); return params.getBooleanParameter (ClientPNames.HANDLE_REDIRECTS, true); } public static void setRedirecting(final HttpParams params, final boolean value) { Args.notNull(params, "HTTP parameters"); params.setBooleanParameter (ClientPNames.HANDLE_REDIRECTS, value); } public static boolean isAuthenticating(final HttpParams params) { Args.notNull(params, "HTTP parameters"); return params.getBooleanParameter (ClientPNames.HANDLE_AUTHENTICATION, true); } public static void setAuthenticating(final HttpParams params, final boolean value) { Args.notNull(params, "HTTP parameters"); params.setBooleanParameter (ClientPNames.HANDLE_AUTHENTICATION, value); } public static String getCookiePolicy(final HttpParams params) { Args.notNull(params, "HTTP parameters"); final String cookiePolicy = (String) params.getParameter(ClientPNames.COOKIE_POLICY); if (cookiePolicy == null) { return CookiePolicy.BEST_MATCH; } return cookiePolicy; } public static void setCookiePolicy(final HttpParams params, final String cookiePolicy) { Args.notNull(params, "HTTP parameters"); params.setParameter(ClientPNames.COOKIE_POLICY, cookiePolicy); }
Set the parameter ClientPNames.CONN_MANAGER_TIMEOUT.
Since:4.2
/** * Set the parameter {@code ClientPNames.CONN_MANAGER_TIMEOUT}. * * @since 4.2 */
public static void setConnectionManagerTimeout(final HttpParams params, final long timeout) { Args.notNull(params, "HTTP parameters"); params.setLongParameter(ClientPNames.CONN_MANAGER_TIMEOUT, timeout); }
Get the connectiion manager timeout value. This is defined by the parameter ClientPNames.CONN_MANAGER_TIMEOUT. Failing that it uses the parameter CoreConnectionPNames.CONNECTION_TIMEOUT which defaults to 0 if not defined.
Since:4.2
Returns:the timeout value
/** * Get the connectiion manager timeout value. * This is defined by the parameter {@code ClientPNames.CONN_MANAGER_TIMEOUT}. * Failing that it uses the parameter {@code CoreConnectionPNames.CONNECTION_TIMEOUT} * which defaults to 0 if not defined. * * @since 4.2 * @return the timeout value */
public static long getConnectionManagerTimeout(final HttpParams params) { Args.notNull(params, "HTTP parameters"); final Long timeout = (Long) params.getParameter(ClientPNames.CONN_MANAGER_TIMEOUT); if (timeout != null) { return timeout.longValue(); } return HttpConnectionParams.getConnectionTimeout(params); } }