HttpMonFactory (JAMon Core 2.81 API)

java.lang.Object
- com.jamonapi.http.HttpMonFactory

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JettyHttpMonFactory
```
public class HttpMonFactory
extends Object
implements Serializable
```
Base class that monitors a httpServletRequest, and HttpServletResponse by returning an HttpMonRequest object per page request. Although this class can be used directly it will more often be used transparently by classes such as JAMonTomcat55Valve, JAMonServletFilter and JAMonJettyHandler. To get a list of many possible (though not all) HttpServletRequest and HttpServletResponse labels pass 'demo' to the valve, handler or servlet filter. You can also see these same possibiliteis by calling HttpMonFactory.getDemoLabels(). Note jetty and tomcat handler and valve respectively are based on objects that inherit from HttpServletRequest and HttpServletResponse respectively and all methods that these subclasses implement are available too.
Representative values returned from response methods
- response.getBufferSize()=8192
- response.getCharacterEncoding()=utf-8
- response.getContentCount()=985
- response.getContentType()=text/html;charset=utf-8
- response.getLocale()=en_US
Representative values returned from request methods
- request.getAuthType()=null
- request.getCharacterEncoding()=null
- request.getContentLength()=-1
- request.getCharacterEncoding()=null
- request.getContentType()=null
- request.getContextPath()=/jamon
- request.getLocalAddr()=127.0.0.1
- request.getLocale()=en_US
- request.getLocalName()=localhost
- request.getLocalPort()=8080
- request.getMethod()=GET
- request.getPathInfo()=null
- request.getPathTranslated()=null
- request.getProtocol()=HTTP/1.1
- request.getQueryString()=name=steve%20souza&id=9898
- request.getRemoteAddr()=127.0.0.1
- request.getRemoteHost()=127.0.0.1
- request.getRemotePort()=1454
- request.getRemoteUser()=null
- request.getRequestedSessionId()=670BFE2B4A7C7C77D9825EFA753D2058
- request.getRequestURI()=/jamon/ZZZZ
- request.getRequestURL()=http://localhost:8080/jamon/ZZZZ
- request.getScheme()=http
- request.getServerName()=localhost
- request.getServerPort()=8080
- request.getServletPath()=/ZZZZ
- request.getUserPrincipal()=null
- request.isRequestedSessionIdFromCookie()=true
- request.isRequestedSessionIdFromURL()=false
- request.isRequestedSessionIdValid()=false
- request.isSecure()=false
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

HttpMonFactory(String labelPrefix)
Create an HttpMonFactory by passing in text that occurs at the beginning of all jamon labels.

Constructors
Constructor and Description
`HttpMonFactory(String labelPrefix)` Create an HttpMonFactory by passing in text that occurs at the beginning of all jamon labels.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSummaryLabel(String jamonSummaryLabel)` Pass a String that has an HttpServletRequest/HttpServletResponse method such as response.getStatus() and then this class will monitor that method call.
`static String`	`getDemoLabels()`
`boolean`	`getEnabled()` Determin if http monitoring is enabled
`boolean`	`getIgnoreHttpParams()` Determine if http params are ignored when creating a jamon label for request.getRequestURI(), and request.getRequestURL().
`String`	`getLabelPrefix()`
`HttpMon`	`getMon(Object request, Object response)`
`int`	`getSize()` Get the max number of possible HttpMonitors.
`String`	`getSummaryLabels()` Get the passed in summaryLabels.
`void`	`setEnabled(boolean enable)` Enable/disable http monitoring
`void`	`setIgnoreHttpParams(boolean ignoreHttpParams)` Set if http params are ignored when creating a jamon label for request.getRequestURI(), and request.getRequestURL().
`void`	`setSize(int size)` Set the max number of possible HttpMonitors.
`void`	`setSummaryLabels(String jamonSummaryLabels)` Pass a series of things (HttpServletRequest/HttpServletResponse methods) to monitor.
`void`	`setSummaryLabels(String summaryLabel, String defaultString)` if passed summaryLabel has 'default' in it replace it with defaultString and then call this classes setSummaryLabels method.
`HttpMon`	`start(Object request, Object response)` Method called to start monitoring a request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HttpMonFactory
```
public HttpMonFactory(String labelPrefix)
```
    Create an HttpMonFactory by passing in text that occurs at the beginning of all jamon labels. ex com.jamonapi.http.JAMonTomcatValve
- Method Detail
  - setSummaryLabels
```
public void setSummaryLabels(String jamonSummaryLabels)
```
    Pass a series of things (HttpServletRequest/HttpServletResponse methods) to monitor. If the word 'default' is passed then the default values will be used. If 'demo' is passed you will see a list of possibilities (This should not be done in production as too much data would be generated). You can add to the default by doing passing "default, request.getStatus().httpStatus". Each time this method is called any previously set items that were being monitored will not longer be monitored. See http://www.jamonapi.com for more examples.
  - getDemoLabels
```
public static String getDemoLabels()
```
  - setSummaryLabels
```
public void setSummaryLabels(String summaryLabel,
                             String defaultString)
```
    if passed summaryLabel has 'default' in it replace it with defaultString and then call this classes setSummaryLabels method. This allows each implementing class to have different defaults.
    
    Parameters:
    
    summaryLabel -
    
    defaultString -
  - addSummaryLabel
```
public void addSummaryLabel(String jamonSummaryLabel)
```
    Pass a String that has an HttpServletRequest/HttpServletResponse method such as response.getStatus() and then this class will monitor that method call.
  - getSummaryLabels
```
public String getSummaryLabels()
```
    Get the passed in summaryLabels.
  - getIgnoreHttpParams
```
public boolean getIgnoreHttpParams()
```
    Determine if http params are ignored when creating a jamon label for request.getRequestURI(), and request.getRequestURL(). This is important for jsessionid can make every label passed to jamon nonunique if not enabled. By default this value is true (ignore params).
  - setIgnoreHttpParams
```
public void setIgnoreHttpParams(boolean ignoreHttpParams)
```
    Set if http params are ignored when creating a jamon label for request.getRequestURI(), and request.getRequestURL(). This is important for jsessionid can make every label passed to jamon nonunique if not enabled. By default this value is true (ignore params).
  - setEnabled
```
public void setEnabled(boolean enable)
```
    Enable/disable http monitoring
  - getEnabled
```
public boolean getEnabled()
```
    Determin if http monitoring is enabled
  - getSize
```
public int getSize()
```
    Get the max number of possible HttpMonitors. By default this is 5000
  - setSize
```
public void setSize(int size)
```
    Set the max number of possible HttpMonitors. By default this is 5000. A value <=0 means there is no limit on the number of jamon records that can be creating due to monitoring.
  - getLabelPrefix
```
public String getLabelPrefix()
```
  - getMon
```
public HttpMon getMon(Object request,
                      Object response)
```
  - start
```
public HttpMon start(Object request,
                     Object response)
```
    Method called to start monitoring a request.

Class HttpMonFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpMonFactory

Method Detail

setSummaryLabels

getDemoLabels

setSummaryLabels

addSummaryLabel

getSummaryLabels

getIgnoreHttpParams

setIgnoreHttpParams

setEnabled

getEnabled

getSize

setSize

getLabelPrefix

getMon

start