|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
com.filenet.wcm.toolkit.server.util.FrameworkException
A renderable exception / wrapper that is generated and thrown from hooks into the toolkit framework page cycle (event/render) via low-level try/catch blocks. Can be caught and rethrown without obscuring the original stack trace, since the "stack trace" and "message" accessors wrap the Throwable passed in the constructor. Construction collects sufficient information to call the WcmErrorMessageBox.render static call.
Field Summary | |
protected java.util.List |
anchorLinks
|
protected java.lang.Throwable |
cause
|
protected java.util.Map |
extraParameters
|
protected boolean |
isWarning
|
protected WcmAnchor |
signOutAnchor
|
protected java.lang.String |
weReturnURL
|
Constructor Summary | |
FrameworkException(java.lang.Throwable cause,
java.lang.String baseURL,
boolean isWarning,
boolean showHelpLink,
java.util.List anchorLinks)
This constructor allows total control over the links shown at the bottom of the WcmErrorMessageBox display. |
|
FrameworkException(java.lang.Throwable cause,
java.lang.String baseURL,
java.lang.String pageName,
WindowID wid,
boolean windowSignedIn)
|
|
FrameworkException(java.lang.Throwable cause,
java.lang.String baseURL,
java.lang.String pageName,
WindowID wid,
boolean windowSignedIn,
boolean isWarning)
Create a FrameworkException object that can optionally be displayed as a warning (no stack trace is shown). |
|
FrameworkException(java.lang.Throwable cause,
java.lang.String baseURL,
java.lang.String pageName,
WindowID wid,
boolean windowSignedIn,
java.util.Locale locale)
Create a FrameworkException object.. |
Method Summary | |
protected void |
configureCloseURL(boolean windowSignedIn,
boolean isPopup)
|
protected void |
configureHelpURL(java.lang.String baseURL)
|
protected void |
configureReturnURL(java.lang.String baseURL,
java.lang.String pageName,
java.lang.String weReturnURL,
WindowID wid)
|
protected void |
configureSignoutURL(boolean windowSignedIn,
boolean isMainWindow,
java.lang.String baseURL)
|
java.lang.String |
extractStackTrace()
|
java.lang.Throwable |
getCauseException()
Get the exception object wrapped by this exception object. |
java.lang.String |
getLocalizedMessage()
|
java.lang.String |
getMessage()
|
void |
printStackTrace()
|
void |
printStackTrace(java.io.PrintStream printStream)
|
void |
printStackTrace(java.io.PrintWriter printWriter)
|
void |
renderErrorMessageBox(javax.servlet.http.HttpServletRequest request,
java.io.Writer w)
Renders the WcmErrorMessageBox display based on the parameters that were passed in. |
void |
renderErrorMessageBox(java.io.Writer w)
Deprecated. - Use renderErrorMessageBox(HttpServletRequest, Writer) |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Throwable |
fillInStackTrace, getCause, getStackTrace, initCause, setStackTrace |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected java.lang.Throwable cause
protected java.util.Map extraParameters
protected java.lang.String weReturnURL
protected boolean isWarning
protected java.util.List anchorLinks
protected WcmAnchor signOutAnchor
Constructor Detail |
public FrameworkException(java.lang.Throwable cause, java.lang.String baseURL, java.lang.String pageName, WindowID wid, boolean windowSignedIn)
public FrameworkException(java.lang.Throwable cause, java.lang.String baseURL, java.lang.String pageName, WindowID wid, boolean windowSignedIn, java.util.Locale locale)
cause
- The cause exception being wrapped (required).baseURL
- The baseURL value for the application (required).pageName
- The page name qualified relative to the application base URL, as returned from WcmController.getPageName() (required).wid
- The window ID object as returned from WcmController.getWindowIdObject() (required).public FrameworkException(java.lang.Throwable cause, java.lang.String baseURL, java.lang.String pageName, WindowID wid, boolean windowSignedIn, boolean isWarning)
cause
- The cause exception being wrapped (required).baseURL
- The baseURL value for the application (required).pageName
- The page name qualified relative to the application base URL, as returned from WcmController.getPageName() (required).wid
- The window ID object as returned from WcmController.getWindowIdObject() (required).windowSignedIn
- Specify if the windowId represents the first windowId accessed after sign-in.isWarning
- Secify whether or not this message is a warning. If true, the show/hide details link is hidden.public FrameworkException(java.lang.Throwable cause, java.lang.String baseURL, boolean isWarning, boolean showHelpLink, java.util.List anchorLinks)
cause
- The cause exception being wrapped (required).baseURL
- The baseURL value for the application (required).isWarning
- Secify whether or not this message is a warning. If true, the show/hide details link is hidden.showHelpLink
- Specify whether or not to show the help link.anchorLinks
- A list of anchor links to show in addition to the show/hide details and help link (optional).Method Detail |
protected void configureHelpURL(java.lang.String baseURL)
protected void configureSignoutURL(boolean windowSignedIn, boolean isMainWindow, java.lang.String baseURL)
protected void configureCloseURL(boolean windowSignedIn, boolean isPopup)
protected void configureReturnURL(java.lang.String baseURL, java.lang.String pageName, java.lang.String weReturnURL, WindowID wid)
public java.lang.Throwable getCauseException()
public void renderErrorMessageBox(java.io.Writer w) throws java.io.IOException
java.io.IOException
public void renderErrorMessageBox(javax.servlet.http.HttpServletRequest request, java.io.Writer w) throws java.io.IOException
request
- w
-
java.io.IOException
public java.lang.String getLocalizedMessage()
public java.lang.String getMessage()
public void printStackTrace()
public void printStackTrace(java.io.PrintStream printStream)
public void printStackTrace(java.io.PrintWriter printWriter)
public java.lang.String toString()
public java.lang.String extractStackTrace()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |