org.apache.jetspeed.request
Interface RequestDiagnostics

All Superinterfaces:

java.io.Serializable

public interface RequestDiagnostics
extends java.io.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

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

Method Detail

getId

java.lang.String getId()

getTimeRecorded

java.lang.String getTimeRecorded()

getThread

java.lang.String getThread()

isInternal

boolean isInternal()

setInternal

void setInternal(boolean internal)

getServer

java.lang.String getServer()

setServer

void setServer(java.lang.String value)

getRemoteAddr

java.lang.String getRemoteAddr()

setRemoteAddr

void setRemoteAddr(java.lang.String value)

getLocalAddr

java.lang.String getLocalAddr()

setLocalAddr

void setLocalAddr(java.lang.String value)

getContextPath

java.lang.String getContextPath()

setContextPath

void setContextPath(java.lang.String value)

getServletPath

java.lang.String getServletPath()

setServletPath

void setServletPath(java.lang.String value)

getPathInfo

java.lang.String getPathInfo()

setPathInfo

void setPathInfo(java.lang.String value)

getQueryString

java.lang.String getQueryString()

setQueryString

void setQueryString(java.lang.String value)

getRequestURI

java.lang.String getRequestURI()

setRequestURI

void setRequestURI(java.lang.String value)

getRequestMethod

java.lang.String getRequestMethod()

setRequestMethod

void setRequestMethod(java.lang.String value)

getPagePath

java.lang.String getPagePath()

setPagePath

void setPagePath(java.lang.String value)

getPageId

java.lang.String getPageId()

setPageId

void setPageId(java.lang.String value)

getPath

java.lang.String getPath()

getPortalURLType

PortalURL.URLType getPortalURLType()

setPortalURLType

void setPortalURLType(PortalURL.URLType value)

getPortletApplicationName

java.lang.String getPortletApplicationName()

setPortletApplicationName

void setPortletApplicationName(java.lang.String value)

getPortletName

java.lang.String getPortletName()

setPortletName

void setPortletName(java.lang.String value)

getPortletWindowId

java.lang.String getPortletWindowId()

setPortletWindowId

void setPortletWindowId(java.lang.String value)

getUserPrincipalName

java.lang.String getUserPrincipalName()

setUserPrincipalName

void setUserPrincipalName(java.lang.String value)

getException

java.lang.Throwable getException()

setException

void setException(java.lang.Throwable value)

getCause

java.lang.Throwable getCause()

setCause

void setCause(java.lang.Throwable value)

getErrorMessage

java.lang.String getErrorMessage()

setErrorMessage

void setErrorMessage(java.lang.String value)

getErrorDescription

java.lang.String getErrorDescription()

setErrorDescription

void setErrorDescription(java.lang.String value)

isAttributesEmpty

boolean isAttributesEmpty()

getAttributes

java.util.Map<java.lang.String,java.io.Serializable> getAttributes()

logAsInfo

void logAsInfo()

logAsWarning

void logAsWarning()

logAsError

void logAsError()

logAsTrace

void logAsTrace()

logAsDebug

void logAsDebug()