Module brave.http

Package brave.http

Class HttpServerRequest

java.lang.Object

brave.http.HttpServerRequest

public abstract class HttpServerRequest
extends java.lang.Object

Marks an interface for use in HttpServerHandler.handleReceive(HttpServerRequest). This gives a standard type to consider when parsing an incoming context.

Since:

5.7

See Also:

HttpServerResponse

Constructor Summary

Constructors

Constructor	Description
HttpServerRequest()

Method Summary

Modifier and Type	Method	Description
abstract java.lang.String	header(java.lang.String name)
abstract java.lang.String	method()
boolean	parseClientIpAndPort(Span span)	Override and return true when it is possible to parse the remote IP and port from the delegate.
abstract java.lang.String	path()
long	startTimestamp()
java.lang.String	toString()
abstract java.lang.Object	unwrap()	Returns the underlying http request object.
abstract java.lang.String	url()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpServerRequest

public HttpServerRequest()

Method Detail

unwrap

public abstract java.lang.Object unwrap()

Returns the underlying http request object. Ex. javax.servlet.http.HttpServletRequest

Note: Some implementations are composed of multiple types, such as a request and a socket address of the client. Moreover, an implementation may change the type returned due to refactoring. Unless you control the implementation, cast carefully (ex using instance of) instead of presuming a specific type will always be returned.

method

@Nullable
public abstract java.lang.String method()

See Also:

HttpAdapter.method(Object)

path

@Nullable
public abstract java.lang.String path()

See Also:

HttpAdapter.path(Object)

url

@Nullable
public abstract java.lang.String url()

See Also:

HttpAdapter.url(Object)

header

@Nullable
public abstract java.lang.String header(java.lang.String name)

See Also:

HttpAdapter.requestHeader(Object, String)

parseClientIpAndPort

public boolean parseClientIpAndPort(Span span)

Override and return true when it is possible to parse the remote IP and port from the delegate. Defaults to false.

See Also:

HttpServerAdapter.parseClientIpAndPort(Object, Span)

startTimestamp

public long startTimestamp()

See Also:

HttpAdapter.startTimestamp(Object)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object