RequestDiagnostics (Jetspeed-2 Core API 2.3.1 API)

All Superinterfaces:

Serializable
```
public interface RequestDiagnostics
extends Serializable
```
Base Portal Request Diagnostics view to be provided to a pluggable DiagnosticsServlet/JSP to handle a Portal Request error.
Because this RequestDiagnostics view might get stored (temporarily) in the session and the DiagnosticsServlet might get redirected too, this view captures most common and important request state as Serializable data.

In addition, there is also an auxillary attributes Map which can be used to add additional data to be passed on to the DiagnosticsServlet without immediate need to extend this interface, although that's possible too of course.

Version:

$Id: RequestDiagnostics.java 772479 2009-05-07 00:43:28Z ate $

Method Summary

Methods
Modifier and Type	Method and Description
`Map<String,Serializable>`	`getAttributes()`
`Throwable`	`getCause()`
`String`	`getContextPath()`
`String`	`getErrorDescription()`
`String`	`getErrorMessage()`
`Throwable`	`getException()`
`String`	`getId()`
`String`	`getLocalAddr()`
`String`	`getPageId()`
`String`	`getPagePath()`
`String`	`getPath()`
`String`	`getPathInfo()`
`PortalURL.URLType`	`getPortalURLType()`
`String`	`getPortletApplicationName()`
`String`	`getPortletName()`
`String`	`getPortletWindowId()`
`String`	`getQueryString()`
`String`	`getRemoteAddr()`
`String`	`getRequestMethod()`
`String`	`getRequestURI()`
`String`	`getServer()`
`String`	`getServletPath()`
`String`	`getThread()`
`String`	`getTimeRecorded()`
`String`	`getUserPrincipalName()`
`boolean`	`isAttributesEmpty()`
`boolean`	`isInternal()`
`void`	`logAsDebug()`
`void`	`logAsError()`
`void`	`logAsInfo()`
`void`	`logAsTrace()`
`void`	`logAsWarning()`
`void`	`setCause(Throwable value)`
`void`	`setContextPath(String value)`
`void`	`setErrorDescription(String value)`
`void`	`setErrorMessage(String value)`
`void`	`setException(Throwable value)`
`void`	`setInternal(boolean internal)`
`void`	`setLocalAddr(String value)`
`void`	`setPageId(String value)`
`void`	`setPagePath(String value)`
`void`	`setPathInfo(String value)`
`void`	`setPortalURLType(PortalURL.URLType value)`
`void`	`setPortletApplicationName(String value)`
`void`	`setPortletName(String value)`
`void`	`setPortletWindowId(String value)`
`void`	`setQueryString(String value)`
`void`	`setRemoteAddr(String value)`
`void`	`setRequestMethod(String value)`
`void`	`setRequestURI(String value)`
`void`	`setServer(String value)`
`void`	`setServletPath(String value)`
`void`	`setUserPrincipalName(String value)`

Method Detail

getId
```
String getId()
```

getTimeRecorded
```
String getTimeRecorded()
```

getThread
```
String getThread()
```

isInternal
```
boolean isInternal()
```

setInternal
```
void setInternal(boolean internal)
```

getServer
```
String getServer()
```

setServer
```
void setServer(String value)
```

getRemoteAddr
```
String getRemoteAddr()
```

setRemoteAddr
```
void setRemoteAddr(String value)
```

getLocalAddr
```
String getLocalAddr()
```

setLocalAddr
```
void setLocalAddr(String value)
```

getContextPath
```
String getContextPath()
```

setContextPath
```
void setContextPath(String value)
```

getServletPath
```
String getServletPath()
```

setServletPath
```
void setServletPath(String value)
```

getPathInfo
```
String getPathInfo()
```

setPathInfo
```
void setPathInfo(String value)
```

getQueryString
```
String getQueryString()
```

setQueryString
```
void setQueryString(String value)
```

getRequestURI
```
String getRequestURI()
```

setRequestURI
```
void setRequestURI(String value)
```

getRequestMethod
```
String getRequestMethod()
```

setRequestMethod
```
void setRequestMethod(String value)
```

getPagePath
```
String getPagePath()
```

setPagePath
```
void setPagePath(String value)
```

getPageId
```
String getPageId()
```

setPageId
```
void setPageId(String value)
```

getPath
```
String getPath()
```

getPortalURLType
```
PortalURL.URLType getPortalURLType()
```

setPortalURLType

void setPortalURLType(PortalURL.URLType value)

getPortletApplicationName
```
String getPortletApplicationName()
```

setPortletApplicationName

void setPortletApplicationName(String value)

getPortletName
```
String getPortletName()
```

setPortletName
```
void setPortletName(String value)
```

getPortletWindowId
```
String getPortletWindowId()
```

setPortletWindowId
```
void setPortletWindowId(String value)
```

getUserPrincipalName
```
String getUserPrincipalName()
```

setUserPrincipalName

void setUserPrincipalName(String value)

getException
```
Throwable getException()
```

setException
```
void setException(Throwable value)
```

getCause
```
Throwable getCause()
```

setCause
```
void setCause(Throwable value)
```

getErrorMessage
```
String getErrorMessage()
```

setErrorMessage
```
void setErrorMessage(String value)
```

getErrorDescription
```
String getErrorDescription()
```

setErrorDescription

void setErrorDescription(String value)

isAttributesEmpty
```
boolean isAttributesEmpty()
```

getAttributes

Map<String,Serializable> getAttributes()

logAsInfo
```
void logAsInfo()
```

logAsWarning
```
void logAsWarning()
```

logAsError
```
void logAsError()
```

logAsTrace
```
void logAsTrace()
```

logAsDebug
```
void logAsDebug()
```

Interface RequestDiagnostics

Method Summary

Method Detail

getId

getTimeRecorded

getThread

isInternal

setInternal

getServer

setServer

getRemoteAddr

setRemoteAddr

getLocalAddr

setLocalAddr

getContextPath

setContextPath

getServletPath

setServletPath

getPathInfo

setPathInfo

getQueryString

setQueryString

getRequestURI

setRequestURI

getRequestMethod

setRequestMethod

getPagePath

setPagePath

getPageId

setPageId

getPath

getPortalURLType

setPortalURLType

getPortletApplicationName

setPortletApplicationName

getPortletName

setPortletName

getPortletWindowId

setPortletWindowId

getUserPrincipalName

setUserPrincipalName

getException

setException

getCause

setCause

getErrorMessage

setErrorMessage

getErrorDescription

setErrorDescription

isAttributesEmpty

getAttributes

logAsInfo

logAsWarning

logAsError

logAsTrace

logAsDebug