org.asynchttpclient.handler.TransferCompletionHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of async-http-client Show documentation
The Async Http Client (AHC) classes.
There is a newer version: 3.0.0
/*
 * Copyright (c) 2010-2012 Sonatype, Inc. All rights reserved.
 *
 * This program is licensed to you under the Apache License Version 2.0,
 * and you may not use this file except in compliance with the Apache License Version 2.0.
 * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the Apache License Version 2.0 is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
 */
package org.asynchttpclient.handler;

import io.netty.handler.codec.http.HttpHeaders;
import org.asynchttpclient.AsyncCompletionHandlerBase;
import org.asynchttpclient.HttpResponseBodyPart;
import org.asynchttpclient.Response;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.concurrent.ConcurrentLinkedQueue;

/**
 * A {@link org.asynchttpclient.AsyncHandler} that can be used to notify a set of {@link TransferListener}
 * 

 * 
 *  * AsyncHttpClient client = new AsyncHttpClient();
 * TransferCompletionHandler tl = new TransferCompletionHandler();
 * tl.addTransferListener(new TransferListener() {
 *
 * public void onRequestHeadersSent(HttpHeaders headers) {
 * }
 *
 * public void onResponseHeadersReceived(HttpHeaders headers) {
 * }
 *
 * public void onBytesReceived(ByteBuffer buffer) {
 * }
 *
 * public void onBytesSent(long amount, long current, long total) {
 * }
 *
 * public void onRequestResponseCompleted() {
 * }
 *
 * public void onThrowable(Throwable t) {
 * }
 * });
 *
 * Response response = httpClient.prepareGet("http://...").execute(tl).get();
 * 
 * 
 */
public class TransferCompletionHandler extends AsyncCompletionHandlerBase {
  private final static Logger logger = LoggerFactory.getLogger(TransferCompletionHandler.class);
  private final ConcurrentLinkedQueue listeners = new ConcurrentLinkedQueue<>();
  private final boolean accumulateResponseBytes;
  private HttpHeaders headers;

  /**
   * Create a TransferCompletionHandler that will not accumulate bytes. The resulting {@link org.asynchttpclient.Response#getResponseBody()},
   * {@link org.asynchttpclient.Response#getResponseBodyAsStream()} will throw an IllegalStateException if called.
   */
  public TransferCompletionHandler() {
    this(false);
  }

  /**
   * Create a TransferCompletionHandler that can or cannot accumulate bytes and make it available when {@link org.asynchttpclient.Response#getResponseBody()} get called. The
   * default is false.
   *
   * @param accumulateResponseBytes true to accumulates bytes in memory.
   */
  public TransferCompletionHandler(boolean accumulateResponseBytes) {
    this.accumulateResponseBytes = accumulateResponseBytes;
  }

  public TransferCompletionHandler addTransferListener(TransferListener t) {
    listeners.offer(t);
    return this;
  }

  public TransferCompletionHandler removeTransferListener(TransferListener t) {
    listeners.remove(t);
    return this;
  }

  public void headers(HttpHeaders headers) {
    this.headers = headers;
  }

  @Override
  public State onHeadersReceived(final HttpHeaders headers) throws Exception {
    fireOnHeaderReceived(headers);
    return super.onHeadersReceived(headers);
  }

  @Override
  public State onTrailingHeadersReceived(HttpHeaders headers) throws Exception {
    fireOnHeaderReceived(headers);
    return super.onHeadersReceived(headers);
  }

  @Override
  public State onBodyPartReceived(final HttpResponseBodyPart content) throws Exception {
    State s = State.CONTINUE;
    if (accumulateResponseBytes) {
      s = super.onBodyPartReceived(content);
    }
    fireOnBytesReceived(content.getBodyPartBytes());
    return s;
  }

  @Override
  public Response onCompleted(Response response) throws Exception {
    fireOnEnd();
    return response;
  }

  @Override
  public State onHeadersWritten() {
    if (headers != null) {
      fireOnHeadersSent(headers);
    }
    return State.CONTINUE;
  }

  @Override
  public State onContentWriteProgress(long amount, long current, long total) {
    fireOnBytesSent(amount, current, total);
    return State.CONTINUE;
  }

  @Override
  public void onThrowable(Throwable t) {
    fireOnThrowable(t);
  }

  private void fireOnHeadersSent(HttpHeaders headers) {
    for (TransferListener l : listeners) {
      try {
        l.onRequestHeadersSent(headers);
      } catch (Throwable t) {
        l.onThrowable(t);
      }
    }
  }

  private void fireOnHeaderReceived(HttpHeaders headers) {
    for (TransferListener l : listeners) {
      try {
        l.onResponseHeadersReceived(headers);
      } catch (Throwable t) {
        l.onThrowable(t);
      }
    }
  }

  private void fireOnEnd() {
    for (TransferListener l : listeners) {
      try {
        l.onRequestResponseCompleted();
      } catch (Throwable t) {
        l.onThrowable(t);
      }
    }
  }

  private void fireOnBytesReceived(byte[] b) {
    for (TransferListener l : listeners) {
      try {
        l.onBytesReceived(b);
      } catch (Throwable t) {
        l.onThrowable(t);
      }
    }
  }

  private void fireOnBytesSent(long amount, long current, long total) {
    for (TransferListener l : listeners) {
      try {
        l.onBytesSent(amount, current, total);
      } catch (Throwable t) {
        l.onThrowable(t);
      }
    }
  }

  private void fireOnThrowable(Throwable t) {
    for (TransferListener l : listeners) {
      try {
        l.onThrowable(t);
      } catch (Throwable t2) {
        logger.warn("onThrowable", t2);
      }
    }
  }
}