Package io.opencensus.contrib.http
Class HttpExtractor<Q,P>
- java.lang.Object
-
- io.opencensus.contrib.http.HttpExtractor<Q,P>
-
- Type Parameters:
Q
- the HTTP request entity.P
- the HTTP response entity.
- Direct Known Subclasses:
JaxrsClientExtractor
,JaxrsContainerExtractor
,OcHttpServletExtractor
,OcJettyHttpClientExtractor
@ExperimentalApi public abstract class HttpExtractor<Q,P> extends java.lang.Object
An adaptor to extract information from request and response.This class provides no-op implementations by default.
Please refer to this document for more information about the HTTP attributes recorded in Open Census.
- Since:
- 0.19
-
-
Constructor Summary
Constructors Constructor Description HttpExtractor()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract java.lang.String
getHost(Q request)
Returns the request URL host.abstract java.lang.String
getMethod(Q request)
Returns the request method.abstract java.lang.String
getPath(Q request)
Returns the request URL path.abstract java.lang.String
getRoute(Q request)
Returns the request route.abstract int
getStatusCode(P response)
Returns the response status code.abstract java.lang.String
getUrl(Q request)
Returns the request URL.abstract java.lang.String
getUserAgent(Q request)
Returns the request user agent.
-
-
-
Method Detail
-
getRoute
@Nullable public abstract java.lang.String getRoute(Q request)
Returns the request route.- Parameters:
request
- the HTTP request.- Returns:
- the request route.
- Since:
- 0.19
-
getUrl
@Nullable public abstract java.lang.String getUrl(Q request)
Returns the request URL.- Parameters:
request
- the HTTP request.- Returns:
- the request URL.
- Since:
- 0.19
-
getHost
@Nullable public abstract java.lang.String getHost(Q request)
Returns the request URL host.- Parameters:
request
- the HTTP request.- Returns:
- the request URL host.
- Since:
- 0.19
-
getMethod
@Nullable public abstract java.lang.String getMethod(Q request)
Returns the request method.- Parameters:
request
- the HTTP request.- Returns:
- the request method.
- Since:
- 0.19
-
getPath
@Nullable public abstract java.lang.String getPath(Q request)
Returns the request URL path.- Parameters:
request
- the HTTP request.- Returns:
- the request URL path.
- Since:
- 0.19
-
getUserAgent
@Nullable public abstract java.lang.String getUserAgent(Q request)
Returns the request user agent.- Parameters:
request
- the HTTP request.- Returns:
- the request user agent.
- Since:
- 0.19
-
getStatusCode
public abstract int getStatusCode(@Nullable P response)
Returns the response status code. If the response is null, this method should return0
.- Parameters:
response
- the HTTP response.- Returns:
- the response status code.
- Since:
- 0.19
-
-