Module brave.http

Package brave.http

Class HttpClientRequest

java.lang.Object

brave.http.HttpClientRequest

public abstract class HttpClientRequest
extends java.lang.Object

Marks an interface for use in HttpClientHandler.handleSend(HttpClientRequest). This gives a standard type to consider when parsing an outgoing context.

Since:

5.7

See Also:

HttpClientResponse

Constructor Summary

Constructors

Constructor	Description
HttpClientRequest()

Method Summary

Modifier and Type	Method	Description
abstract java.lang.String	header(java.lang.String name)
abstract void	header(java.lang.String name, java.lang.String value)
abstract java.lang.String	method()
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

HttpClientRequest

public HttpClientRequest()

Method Detail

unwrap

public abstract java.lang.Object unwrap()

Returns the underlying http request object. Ex. org.apache.http.HttpRequest

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)

startTimestamp

public long startTimestamp()

See Also:

HttpAdapter.startTimestamp(Object)

header

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

See Also:

SETTER

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object