Home / Class/ HttpRequestEncoder Class — netty Architecture

HttpRequestEncoder Class — netty Architecture

Architecture documentation for the HttpRequestEncoder class in HttpRequestEncoder.java from the netty codebase.

Entity Profile

Dependency Diagram

graph TD
  161b2c86_34d5_a1fc_3893_b52b82c67020["HttpRequestEncoder"]
  400a6e1f_96ae_d753_c466_1e686733ab52["HttpRequestEncoder.java"]
  161b2c86_34d5_a1fc_3893_b52b82c67020 -->|defined in| 400a6e1f_96ae_d753_c466_1e686733ab52
  5123d107_2674_8d66_2fcd_41ec46a86eb5["acceptOutboundMessage()"]
  161b2c86_34d5_a1fc_3893_b52b82c67020 -->|method| 5123d107_2674_8d66_2fcd_41ec46a86eb5
  41692290_ce43_dba3_2424_a992a23e8684["encodeInitialLine()"]
  161b2c86_34d5_a1fc_3893_b52b82c67020 -->|method| 41692290_ce43_dba3_2424_a992a23e8684

Relationship Graph

Source Code

codec-http/src/main/java/io/netty/handler/codec/http/HttpRequestEncoder.java lines 28–80

public class HttpRequestEncoder extends HttpObjectEncoder<HttpRequest> {
    private static final char SLASH = '/';
    private static final char QUESTION_MARK = '?';
    private static final int SLASH_AND_SPACE_SHORT = (SLASH << 8) | SP;
    private static final int SPACE_SLASH_AND_SPACE_MEDIUM = (SP << 16) | SLASH_AND_SPACE_SHORT;

    @Override
    public boolean acceptOutboundMessage(Object msg) throws Exception {
        return super.acceptOutboundMessage(msg) && !(msg instanceof HttpResponse);
    }

    @Override
    protected void encodeInitialLine(ByteBuf buf, HttpRequest request) throws Exception {
        ByteBufUtil.copy(request.method().asciiName(), buf);

        String uri = request.uri();

        if (uri.isEmpty()) {
            // Add " / " as absolute path if uri is not present.
            // See https://tools.ietf.org/html/rfc2616#section-5.1.2
            ByteBufUtil.writeMediumBE(buf, SPACE_SLASH_AND_SPACE_MEDIUM);
        } else {
            CharSequence uriCharSequence = uri;
            boolean needSlash = false;
            int start = uri.indexOf("://");
            if (start != -1 && uri.charAt(0) != SLASH) {
                start += 3;
                // Correctly handle query params.
                // See https://github.com/netty/netty/issues/2732
                int index = uri.indexOf(QUESTION_MARK, start);
                if (index == -1) {
                    if (uri.lastIndexOf(SLASH) < start) {
                        needSlash = true;
                    }
                } else {
                    if (uri.lastIndexOf(SLASH, index) < start) {
                        uriCharSequence = new StringBuilder(uri).insert(index, SLASH);
                    }
                }
            }
            buf.writeByte(SP).writeCharSequence(uriCharSequence, CharsetUtil.UTF_8);
            if (needSlash) {
                // write "/ " after uri
                ByteBufUtil.writeShortBE(buf, SLASH_AND_SPACE_SHORT);
            } else {
                buf.writeByte(SP);
            }
        }

        request.protocolVersion().encode(buf);
        ByteBufUtil.writeShortBE(buf, CRLF_SHORT);
    }
}

Frequently Asked Questions

What is the HttpRequestEncoder class?
HttpRequestEncoder is a class in the netty codebase, defined in codec-http/src/main/java/io/netty/handler/codec/http/HttpRequestEncoder.java.
Where is HttpRequestEncoder defined?
HttpRequestEncoder is defined in codec-http/src/main/java/io/netty/handler/codec/http/HttpRequestEncoder.java at line 28.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free