com.feilong.net.http.callback.ResultCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation

feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.

There is a newer version: 4.3.0

Show newest version

/*
 * Copyright (C) 2008 feilong
 *
 * Licensed 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.
 */
package com.feilong.net.http.callback;

import java.util.Date;

import com.feilong.lib.org.apache.http.HttpResponse;
import com.feilong.lib.org.apache.http.client.methods.HttpUriRequest;
import com.feilong.net.UncheckedHttpException;
import com.feilong.net.http.ConnectionConfig;
import com.feilong.net.http.HttpRequest;

/**
 * A callback interface,用来执行httpclient之后,渲染拿到的结果.
 * 
 * 
 * 是feilong httpclient 底层接口,目前有的实现有:
 * 
 * 
 * 
 * {@link HttpResponseResultCallback}:用来构造全的返回数据,包含字符串,状态码,时间等等
 * {@link ResponseBodyAsStringResultCallback}:用来获得接口的返回字符串(常用)
 * {@link StatusCodeResultCallback}:用来只需要获得状态码
 * 
 * 
 * 设计思想,类似于 org.springframework.data.redis.core.RedisCallback
 * 
 *
 * @param 
 *            the generic type
 * @see com.feilong.net.http.builder.HttpRequestExecuter#execute(HttpRequest, ConnectionConfig, ResultCallback)
 * @see HttpResponseResultCallback
 * @see ResponseBodyAsStringResultCallback
 * @see StatusCodeResultCallback
 */
public interface ResultCallback {

    /**
     * On.
     * 
     * 
     * 注意:每个参数都不会为null
     * 
     *
     * @param httpRequest
     *            the http request
     * @param httpUriRequest
     *            the http uri request
     * @param httpResponse
     *            the http response
     * @param useConnectionConfig
     *            the use connection config
     * @param beginDate
     *            http调用开始时间
     * @return the t
     */
    T on(
                    HttpRequest httpRequest,
                    HttpUriRequest httpUriRequest,
                    HttpResponse httpResponse,
                    ConnectionConfig useConnectionConfig,
                    Date beginDate);

    /**
     * 如果出现了异常.
     *
     * @param httpRequest
     *            the http request
     * @param httpUriRequest
     *            the http uri request
     * @param useConnectionConfig
     *            the use connection config
     * @param e
     *            the e
     * @param beginDate
     *            the begin date
     * @return the t
     * @since 4.2.0
     */
    T doException(
                    HttpRequest httpRequest,
                    HttpUriRequest httpUriRequest,
                    ConnectionConfig useConnectionConfig,
                    UncheckedHttpException e,
                    Date beginDate);
}