WebContainerListenerpublic class WebContainerListener extends Object implements org.apache.catalina.ContainerListener, org.apache.catalina.InstanceListener
| Fields Summary |
|---|
| private static final String | JSP_SERVLET | | private static final ThreadLocal | threadLocalThread local object.
This motivation for this object is to ensure that the natural call flow
sequence is maintained. Refer to the javadoc description of Agent class.
The natural call flow sequence expects startTime() to be called after
all the addRequestInfo() calls are completed.
In the case of the web container, we need to explicitly issue the first
startTime() call, just before the beforeFilter or beforeService
operation. However, for nested local servlet calls, called by the first
Servlet, there is no need to explicitly issue the startTime() call,
since the web container provides the beforeDispatch() event.
Unfortunately, the beforeDispatch() event is not available for the
first Servlet call, it is only available for nested local servlet
invocations; so we use this thread local object as a work around.
So, this thread local object exists, primarily to support the explicit
issuance of the first startTime() call and its corollary endTime() call,
during the invocation of the first Servlet or filter in the invocation
path. | | private static final ThreadLocal | requestStartTls | | private Agent | callFlowAgent |
| Constructors Summary |
|---|
public WebContainerListener()
this.callFlowAgent = Switch.getSwitch().getCallFlowAgent();
|
| Methods Summary |
|---|
| public void | containerEvent(org.apache.catalina.ContainerEvent event)Receive event from the Grizzly HTTP Connector.
The ContainerEvent.getData() will return the current
RequestInfo, which contains request information.
if (!callFlowAgent.isEnabled()) {
return;
}
Object obj = event.getData();
if (!(obj instanceof org.apache.coyote.RequestInfo)) {
return;
}
org.apache.coyote.RequestInfo
requestInfo = (org.apache.coyote.RequestInfo) obj;
if (Adapter.CONNECTION_PROCESSING_STARTED.equals(event.getType())) {
requestStartTls.set (Boolean.TRUE);
callFlowAgent.requestStart(RequestType.REMOTE_WEB);
callFlowAgent.addRequestInfo(
RequestInfo.CALLER_IP_ADDRESS,
requestInfo.getRemoteAddr());
} else if (Adapter.REQUEST_PROCESSING_COMPLETED.
equals(event.getType())) {
callFlowAgent.requestEnd();
}
| | private java.lang.String | extractJSPName(javax.servlet.http.HttpServletRequest request)
String jspUri = null;
String jspFile = (String) request.getAttribute(Constants.JSP_FILE);
if (jspFile != null) {
// JSP is specified via <jsp-file> in <servlet> declaration
jspUri = jspFile;
} else {
/*
* Check to see if the requested JSP has been the target of a
* RequestDispatcher.include()
*/
jspUri = (String) request.getAttribute(Constants.INC_SERVLET_PATH);
if (jspUri != null) {
/*
* Requested JSP has been target of
* RequestDispatcher.include(). Its path is assembled from the
* relevant javax.servlet.include.* request attributes
*/
String pathInfo = (String) request.getAttribute(
"javax.servlet.include.path_info");
if (pathInfo != null) {
jspUri += pathInfo;
}
} else {
/*
* Requested JSP has not been the target of a
* RequestDispatcher.include(). Reconstruct its path from the
* request's getServletPath() and getPathInfo()
*/
jspUri = request.getServletPath();
String pathInfo = request.getPathInfo();
if (pathInfo != null) {
jspUri += pathInfo;
}
}
}
return jspUri;
| | public void | instanceEvent(org.apache.catalina.InstanceEvent event)
if (!callFlowAgent.isEnabled()) {
return;
}
if (!requestStartTls.get ())
return;
if (event.getType().equals(InstanceEvent.BEFORE_SERVICE_EVENT)) {
AgentImpl.FlowStack<Boolean> flowStack = threadLocal.get();
if (flowStack.size() == 0) {
// Explicitly issue first startTime() only for the first
// Servlet or filter call, in the invocation path.
processBeforeDispatchEvent(event);
}
flowStack.push(Boolean.TRUE);
processBeforeServiceEvent(event);
} else if (event.getType().equals(InstanceEvent.AFTER_SERVICE_EVENT)) {
processAfterServiceEvent(event);
AgentImpl.FlowStack<Boolean> flowStack = threadLocal.get();
flowStack.pop();
if (flowStack.size() == 0) {
// Explicitly issue the matching endTime() for the first
// Servlet or filter call, in the invocation path.
processAfterDispatchEvent(event);
}
} else if (event.getType().equals(InstanceEvent.BEFORE_FILTER_EVENT)) {
AgentImpl.FlowStack<Boolean> flowStack = threadLocal.get();
if (flowStack.size() == 0) {
// Explicitly issue first startTime() only for the first
// Servlet or filter call, in the invocation path.
processBeforeDispatchEvent(event);
}
flowStack.push(Boolean.TRUE);
processBeforeFilterEvent(event);
} else if (event.getType().equals(InstanceEvent.AFTER_FILTER_EVENT)) {
processAfterFilterEvent(event);
AgentImpl.FlowStack<Boolean> flowStack = threadLocal.get();
flowStack.pop();
if (flowStack.size() == 0) {
// Explicitly issue the matching endTime() for the first
// Servlet or filter call, in the invocation path.
processAfterDispatchEvent(event);
}
} else if (event.getType().
equals(InstanceEvent.BEFORE_DISPATCH_EVENT)) {
processBeforeDispatchEvent(event);
} else if (event.getType().equals(InstanceEvent.AFTER_DISPATCH_EVENT)) {
processAfterDispatchEvent(event);
}
| | private void | processAfterDispatchEvent(org.apache.catalina.InstanceEvent event)
callFlowAgent.endTime();
| | private void | processAfterFilterEvent(org.apache.catalina.InstanceEvent event)
Throwable exception = event.getException();
callFlowAgent.webMethodEnd(exception);
| | private void | processAfterServiceEvent(org.apache.catalina.InstanceEvent event)
Throwable exception = event.getException();
callFlowAgent.webMethodEnd(exception);
| | private void | processBeforeDispatchEvent(org.apache.catalina.InstanceEvent event)
callFlowAgent.startTime(ContainerTypeOrApplicationType.WEB_CONTAINER);
| | private void | processBeforeFilterEvent(org.apache.catalina.InstanceEvent event)
Filter filter = event.getFilter();
HttpServletRequest req = (HttpServletRequest) event.getRequest();
String methodName = req.getRequestURI() + ":" +
filter.getClass().getName() + ".doFilter";
String callerPrincipal = req.getRemoteUser();
if (callerPrincipal == null) {
if (req.getUserPrincipal() != null) {
callerPrincipal = req.getUserPrincipal().getName();
} else {
callerPrincipal = "anonymous";
}
}
Wrapper wrapper = event.getWrapper();
String applicationName =
((StandardContext)wrapper.getParent()).getJ2EEApplication();
if ((applicationName == null) || (applicationName.equals("null"))) {
applicationName = "URI:" + req.getRequestURI();
}
String moduleName = wrapper.getParent().getName();
callFlowAgent.webMethodStart(
methodName, applicationName, moduleName,
filter.getClass().getName(),
ComponentType.SERVLET_FILTER, callerPrincipal);
| | private void | processBeforeServiceEvent(org.apache.catalina.InstanceEvent event)
Servlet servlet = event.getServlet();
ServletConfig servletConfig = servlet.getServletConfig();
String servletName = "UNKNOWN";
if (servletConfig != null) {
servletName = servletConfig.getServletName();
}
HttpServletRequest req = (HttpServletRequest) event.getRequest();
String methodName = req.getRequestURI() + ":";
if (!servlet.getClass().getName().equalsIgnoreCase(JSP_SERVLET)){
methodName += servlet.getClass().getName() + ".service";
} else {
// JSP
methodName += extractJSPName(req) +":" + JSP_SERVLET + ".service";
}
String callerPrincipal = req.getRemoteUser();
if (callerPrincipal == null) {
if (req.getUserPrincipal() != null) {
callerPrincipal = req.getUserPrincipal().getName();
} else {
callerPrincipal = "anonymous";
}
}
Wrapper wrapper = event.getWrapper();
String applicationName =
((StandardContext)wrapper.getParent()).getJ2EEApplication();
if ((applicationName == null) || (applicationName.equals("null"))) {
applicationName = "URI:" + req.getRequestURI();
}
String moduleName = wrapper.getParent().getName();
callFlowAgent.webMethodStart(
methodName, applicationName, moduleName,
servletName, ComponentType.SERVLET,
callerPrincipal);
|
|
