/*
* ====================================================================
* 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.core5.http.impl.nio.bootstrap;
import java.io.Closeable;
import java.io.IOException;
import java.util.concurrent.Future;
import java.util.concurrent.atomic.AtomicBoolean;
import org.apache.hc.core5.annotation.Contract;
import org.apache.hc.core5.annotation.ThreadingBehavior;
import org.apache.hc.core5.concurrent.BasicFuture;
import org.apache.hc.core5.concurrent.FutureCallback;
import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler;
import org.apache.hc.core5.http.nio.AsyncRequestProducer;
import org.apache.hc.core5.http.nio.AsyncResponseConsumer;
import org.apache.hc.core5.http.nio.command.ExecutionCommand;
import org.apache.hc.core5.http.nio.command.ShutdownCommand;
import org.apache.hc.core5.http.nio.command.ShutdownType;
import org.apache.hc.core5.http.nio.support.BasicClientExchangeHandler;
import org.apache.hc.core5.http.protocol.HttpContext;
import org.apache.hc.core5.http.protocol.HttpCoreContext;
import org.apache.hc.core5.reactor.Command;
import org.apache.hc.core5.reactor.IOSession;
import org.apache.hc.core5.util.Asserts;
/**
* Client endpoint that can be used to initiate HTTP message exchanges.
*
* @since 5.0
*/
@Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL)
public final class ClientEndpoint implements Closeable {
private final IOSession ioSession;
private final AtomicBoolean closed;
public ClientEndpoint(final IOSession ioSession) {
super();
this.ioSession = ioSession;
this.closed = new AtomicBoolean(false);
}
public void execute(final Command command) {
ioSession.addLast(command);
if (ioSession.isClosed()) {
command.cancel();
}
}
public void execute(
final AsyncClientExchangeHandler exchangeHandler,
final HttpContext context) {
Asserts.check(!closed.get(), "Connection is already closed");
final Command executionCommand = new ExecutionCommand(
exchangeHandler,
context != null ? context : HttpCoreContext.create());
execute(executionCommand);
}
public Future execute(
final AsyncRequestProducer requestProducer,
final AsyncResponseConsumer responseConsumer,
final HttpContext context,
final FutureCallback callback) {
Asserts.check(!closed.get(), "Connection is already closed");
final BasicFuture future = new BasicFuture<>(callback);
execute(new BasicClientExchangeHandler<>(requestProducer, responseConsumer,
new FutureCallback() {
@Override
public void completed(final T result) {
future.completed(result);
}
@Override
public void failed(final Exception ex) {
future.failed(ex);
}
@Override
public void cancelled() {
future.cancel();
}
}),
context != null ? context : HttpCoreContext.create());
return future;
}
public Future execute(
final AsyncRequestProducer requestProducer,
final AsyncResponseConsumer responseConsumer,
final FutureCallback callback) {
return execute(requestProducer, responseConsumer, null, callback);
}
public boolean isOpen() {
return !closed.get() && !ioSession.isClosed();
}
public void shutdown() {
if (closed.compareAndSet(false, true)) {
ioSession.shutdown();
}
}
@Override
public void close() throws IOException {
if (closed.compareAndSet(false, true)) {
ioSession.addFirst(new ShutdownCommand(ShutdownType.GRACEFUL));
}
}
@Override
public String toString() {
return ioSession.toString();
}
}