Package io.opentelemetry.javaagent.instrumentation.servlet

Interface ServletAccessor<REQUEST,RESPONSE>

Type Parameters:

REQUEST - HttpServletRequest class (or a wrapper)

RESPONSE - HttpServletResponse class (or a wrapper)

public interface ServletAccessor<REQUEST,RESPONSE>

This interface is used to access methods of ServletContext, HttpServletRequest and HttpServletResponse classes in shared code that is used for both jakarta.servlet and javax.servlet versions of those classes. A wrapper class with extra information attached may be used as well in cases where the class itself does not provide some field (such as response status for Servlet API 2.2).

Method Summary

Modifier and Type	Method	Description
void	addRequestAsyncListener(REQUEST request, ServletAsyncListener<RESPONSE> listener, Object response)
Object	getRequestAttribute(REQUEST request, String name)
String	getRequestContextPath(REQUEST request)
String	getRequestHeader(REQUEST request, String name)
Iterable<String>	getRequestHeaderNames(REQUEST request)
List<String>	getRequestHeaderValues(REQUEST request, String name)
String	getRequestLocalAddr(REQUEST request)
Integer	getRequestLocalPort(REQUEST request)
String	getRequestMethod(REQUEST request)
List<String>	getRequestParameterValues(REQUEST request, String name)
String	getRequestPathInfo(REQUEST request)
String	getRequestProtocol(REQUEST request)
String	getRequestQueryString(REQUEST request)
String	getRequestRemoteAddr(REQUEST request)
Integer	getRequestRemotePort(REQUEST request)
String	getRequestScheme(REQUEST request)
String	getRequestServletPath(REQUEST request)
String	getRequestUri(REQUEST request)
Principal	getRequestUserPrincipal(REQUEST request)
List<String>	getResponseHeaderValues(RESPONSE response, String name)
int	getResponseStatus(RESPONSE response)
boolean	isResponseCommitted(RESPONSE response)
boolean	isServletException(Throwable throwable)
void	setRequestAttribute(REQUEST request, String name, Object value)

Method Details

getRequestContextPath

String getRequestContextPath(REQUEST request)

getRequestScheme

String getRequestScheme(REQUEST request)

getRequestUri

String getRequestUri(REQUEST request)

getRequestQueryString

String getRequestQueryString(REQUEST request)

getRequestAttribute

Object getRequestAttribute(REQUEST request,
 String name)

setRequestAttribute

void setRequestAttribute(REQUEST request,
 String name,
 Object value)

getRequestProtocol

String getRequestProtocol(REQUEST request)

getRequestMethod

String getRequestMethod(REQUEST request)

getRequestRemoteAddr

String getRequestRemoteAddr(REQUEST request)

getRequestRemotePort

Integer getRequestRemotePort(REQUEST request)

getRequestLocalAddr

String getRequestLocalAddr(REQUEST request)

getRequestLocalPort

Integer getRequestLocalPort(REQUEST request)

getRequestHeader

String getRequestHeader(REQUEST request,
 String name)

getRequestHeaderValues

List<String> getRequestHeaderValues(REQUEST request,
 String name)

getRequestHeaderNames

Iterable<String> getRequestHeaderNames(REQUEST request)

getRequestParameterValues

List<String> getRequestParameterValues(REQUEST request,
 String name)

getRequestServletPath

String getRequestServletPath(REQUEST request)

getRequestPathInfo

String getRequestPathInfo(REQUEST request)

getRequestUserPrincipal

Principal getRequestUserPrincipal(REQUEST request)

addRequestAsyncListener

void addRequestAsyncListener(REQUEST request,
 ServletAsyncListener<RESPONSE> listener,
 Object response)

getResponseStatus

int getResponseStatus(RESPONSE response)

getResponseHeaderValues

List<String> getResponseHeaderValues(RESPONSE response,
 String name)

isResponseCommitted

boolean isResponseCommitted(RESPONSE response)

isServletException

boolean isServletException(Throwable throwable)