Package brave.http

Class HttpServerAdapter<Req,Resp>

java.lang.Object

brave.http.HttpAdapter<Req,Resp>

brave.http.HttpServerAdapter<Req,Resp>

public abstract class HttpServerAdapter<Req,Resp>
extends HttpAdapter<Req,Resp>

Constructor Summary

Constructors

Constructor	Description
HttpServerAdapter()

Method Summary

Modifier and Type	Method	Description
boolean	parseClientAddress(Req req, zipkin2.Endpoint.Builder builder)	Deprecated. parseClientIpAndPort(Req, brave.Span) addresses this functionality.
boolean	parseClientIpAndPort(Req req, Span span)	Used by HttpServerHandler.handleReceive(HttpServerRequest) to add remote socket information about the client.
boolean	parseClientIpFromXForwardedFor(Req req, Span span)	Returns the first value in the "X-Forwarded-For" header, or null if not present.

Methods inherited from class brave.http.HttpAdapter

finishTimestamp, method, methodFromResponse, path, requestHeader, route, startTimestamp, statusCode, statusCodeAsInt, url

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HttpServerAdapter

public HttpServerAdapter()

Method Details

parseClientAddress

@Deprecated public boolean parseClientAddress(Req req, zipkin2.Endpoint.Builder builder)

Deprecated.

parseClientIpAndPort(Req, brave.Span) addresses this functionality. This will be removed in Brave v6.

parseClientIpAndPort

public boolean parseClientIpAndPort(Req req, Span span)

Used by HttpServerHandler.handleReceive(HttpServerRequest) to add remote socket information about the client. By default, this tries to parse the forwarded IP. Override to add client socket information when forwarded info is not available.

Aside: the ability to parse socket information on server request objects is likely even if it is not as likely on the client side. This is because client requests are often parsed before a network route is chosen, whereas server requests are parsed after the network layer.

Since:

5.2

parseClientIpFromXForwardedFor

public boolean parseClientIpFromXForwardedFor(Req req, Span span)

Returns the first value in the "X-Forwarded-For" header, or null if not present.

Since:

5.2