kong.unirest.core.MetricContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of unirest-java-core Show documentation

Simplified, lightweight HTTP client library.

There is a newer version: 4.4.5

/**
 * The MIT License
 *
 * Copyright for portions of unirest-java are held by Kong Inc (c) 2013.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package kong.unirest.core;

/**
 * A metric context for the current request
 */
@FunctionalInterface
public interface MetricContext {
     /**
      * Finishes a Http Request. Called just after the main request but before any mapping
      * function including before any streaming responses (like file downloads) are complete.
      * @param httpResponse a summary of the just executed response or null in the case of a system exception.
      * @param ex an exception if one happened or null .
      *           Note that this is not just a 500 from the remote,
      *           but more likely a socket or connection timeout.
      */
     void complete(HttpResponseSummary httpResponse, Exception ex);
}