io.vertx.httpproxy.ProxyInterceptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wheel-vertx Show documentation

wheel利用vert.x框架进行开发常用的工具库

There is a newer version: 3.5.45

/**
 * XXX 复制4.4.3版本的io.vertx.httpproxy.impl.ProxyInterceptor接口的代码，让websocket也支持代理拦截器
 * 扩展ProxyInterceptor接口，添加修改代理请求的方法
 */
package io.vertx.httpproxy;

import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Future;

/**
 * A {@link HttpProxy} interceptor.
 */
@VertxGen(concrete = false)
public interface ProxyInterceptor {

    /**
     * XXX 默认调用modifyProxyRequest方法
     *
     * Handle the proxy request at the stage of this interceptor.
     *
     * @param context the proxy context
     * @return when the request has actually been sent to the origin
     */
    default Future handleProxyRequest(ProxyContext context) {
        // XXX 默认调用modifyProxyRequest方法
        this.modifyProxyRequest(context.request());
        // 继续拦截器
        return context.sendRequest();
    }

    /**
     * Handle the proxy response at the stage of this interceptor.
     *
     * @param context the proxy context
     * @return when the response has actually been sent to the user-agent
     */
    default Future handleProxyResponse(ProxyContext context) {
        return context.sendResponse();
    }

    /**
     * XXX 修改代理请求
     *
     * @param proxyRequest 要修改的代理请求
     */
    default void modifyProxyRequest(ProxyRequest proxyRequest) {
    }

}