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

org.apache.hc.client5.http.nio.AsyncClientConnectionManager Maven / Gradle / Ivy

There is a newer version: 6.0.36
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.hc.client5.http.nio;

import java.util.concurrent.Future;

import org.apache.hc.client5.http.HttpRoute;
import org.apache.hc.core5.annotation.Contract;
import org.apache.hc.core5.annotation.ThreadingBehavior;
import org.apache.hc.core5.concurrent.FutureCallback;
import org.apache.hc.core5.http.protocol.HttpContext;
import org.apache.hc.core5.io.ModalCloseable;
import org.apache.hc.core5.reactor.ConnectionInitiator;
import org.apache.hc.core5.util.TimeValue;
import org.apache.hc.core5.util.Timeout;

/**
 * Represents a manager of persistent non-blocking client connections.
 * 

* The purpose of an HTTP connection manager is to serve as a factory for new * HTTP connections, manage persistent connections and synchronize access to * persistent connections making sure that only one thread of execution can * have access to a connection at a time. *

*

* Implementations of this interface must be thread-safe. Access to shared * data must be synchronized as methods of this interface may be executed * from multiple threads. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE) public interface AsyncClientConnectionManager extends ModalCloseable { /** * Returns a {@link Future} object which can be used to obtain * an {@link AsyncConnectionEndpoint} or to cancel the request by calling * {@link Future#cancel(boolean)}. *

* Please note that newly allocated endpoints can be leased * {@link AsyncConnectionEndpoint#isConnected() disconnected}. The consumer * of the endpoint is responsible for fully establishing the route to * the endpoint target by calling {@link #connect(AsyncConnectionEndpoint, * ConnectionInitiator, Timeout, Object, HttpContext, FutureCallback)} * in order to connect directly to the target or to the first proxy hop, * and optionally calling {@link #upgrade(AsyncConnectionEndpoint, Object, HttpContext)} * method to upgrade the underlying transport to Transport Layer Security * after having executed a {@code CONNECT} method to all intermediate * proxy hops. * * @param id unique operation ID or {@code null}. * @param route HTTP route of the requested connection. * @param state expected state of the connection or {@code null} * if the connection is not expected to carry any state. * @param requestTimeout lease request timeout. * @param callback result callback. */ Future lease( String id, HttpRoute route, Object state, Timeout requestTimeout, FutureCallback callback); /** * Releases the endpoint back to the manager making it potentially * re-usable by other consumers. Optionally, the maximum period * of how long the manager should keep the connection alive can be * defined using {@code validDuration} and {@code timeUnit} * parameters. * * @param endpoint the managed endpoint. * @param newState the new connection state of {@code null} if state-less. * @param validDuration the duration of time this connection is valid for reuse. */ void release(AsyncConnectionEndpoint endpoint, Object newState, TimeValue validDuration); /** * Connects the endpoint to the initial hop (connection target in case * of a direct route or to the first proxy hop in case of a route via a proxy * or multiple proxies). * * @param endpoint the managed endpoint. * @param connectTimeout connect timeout. * @param context the actual HTTP context. * @param attachment connect request attachment. * @param callback result callback. */ Future connect( AsyncConnectionEndpoint endpoint, ConnectionInitiator connectionInitiator, Timeout connectTimeout, Object attachment, HttpContext context, FutureCallback callback); /** * Upgrades transport security of the given endpoint by using the TLS security protocol. * * @param endpoint the managed endpoint. * @param attachment the attachment the upgrade attachment object. * @param context the actual HTTP context. */ void upgrade( AsyncConnectionEndpoint endpoint, Object attachment, HttpContext context); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy