org.apache.wicket.settings
Interface IExceptionSettings

All Known Implementing Classes:
Settings

public interface IExceptionSettings

Settings interface for configuring exception handling related settings.

unexpectedExceptionDisplay (defaults to SHOW_EXCEPTION_PAGE) - Determines how exceptions are displayed to the developer or user

throwExceptionOnMissingResource (defaults to true) - Set to true to throw a runtime exception if a required string resource is not found. Set to false to return the requested resource key surrounded by pairs of question mark characters (e.g. "??missingKey??")

Author:
Igor Vaynberg (ivaynberg)

Nested Class Summary
static class IExceptionSettings.UnexpectedExceptionDisplay
          Enumerated type for different ways of displaying unexpected exceptions.
 
Field Summary
static IExceptionSettings.UnexpectedExceptionDisplay SHOW_EXCEPTION_PAGE
          Indicates that an exception page appropriate to development should be shown when an unexpected exception is thrown.
static IExceptionSettings.UnexpectedExceptionDisplay SHOW_INTERNAL_ERROR_PAGE
          Indicates a generic internal error page should be shown when an unexpected exception is thrown.
static IExceptionSettings.UnexpectedExceptionDisplay SHOW_NO_EXCEPTION_PAGE
          Indicates that no exception page should be shown when an unexpected exception is thrown.
 
Method Summary
 boolean getThrowExceptionOnMissingResource()
          Deprecated. use IResourceSettings.getThrowExceptionOnMissingResource() instead
 IExceptionSettings.UnexpectedExceptionDisplay getUnexpectedExceptionDisplay()
           
 void setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)
          Deprecated. use IResourceSettings.setThrowExceptionOnMissingResource(boolean) instead
 void setUnexpectedExceptionDisplay(IExceptionSettings.UnexpectedExceptionDisplay unexpectedExceptionDisplay)
          The exception display type determines how the framework displays exceptions to you as a developer or user.
 

Field Detail

SHOW_EXCEPTION_PAGE

static final IExceptionSettings.UnexpectedExceptionDisplay SHOW_EXCEPTION_PAGE
Indicates that an exception page appropriate to development should be shown when an unexpected exception is thrown.


SHOW_INTERNAL_ERROR_PAGE

static final IExceptionSettings.UnexpectedExceptionDisplay SHOW_INTERNAL_ERROR_PAGE
Indicates a generic internal error page should be shown when an unexpected exception is thrown.


SHOW_NO_EXCEPTION_PAGE

static final IExceptionSettings.UnexpectedExceptionDisplay SHOW_NO_EXCEPTION_PAGE
Indicates that no exception page should be shown when an unexpected exception is thrown.

Method Detail

getThrowExceptionOnMissingResource

@Deprecated
boolean getThrowExceptionOnMissingResource()
Deprecated. use IResourceSettings.getThrowExceptionOnMissingResource() instead

Returns:
Whether to throw an exception when a missing resource is requested

getUnexpectedExceptionDisplay

IExceptionSettings.UnexpectedExceptionDisplay getUnexpectedExceptionDisplay()
Returns:
Returns the unexpectedExceptionDisplay.

setThrowExceptionOnMissingResource

@Deprecated
void setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)
Deprecated. use IResourceSettings.setThrowExceptionOnMissingResource(boolean) instead

Parameters:
throwExceptionOnMissingResource - Whether to throw an exception when a missing resource is requested

setUnexpectedExceptionDisplay

void setUnexpectedExceptionDisplay(IExceptionSettings.UnexpectedExceptionDisplay unexpectedExceptionDisplay)
The exception display type determines how the framework displays exceptions to you as a developer or user.

The default value for exception display type is SHOW_EXCEPTION_PAGE. When this value is set and an unhandled runtime exception is thrown by a page, a redirect to a helpful exception display page will occur.

This is a developer feature, however, and you may want to instead show an internal error page without developer details that allows a user to start over at the application's home page. This can be accomplished by setting the exception display type to SHOW_INTERNAL_ERROR_PAGE.

Finally, if you are having trouble with the exception display pages themselves, you can disable exception displaying entirely with the value SHOW_NO_EXCEPTION_PAGE. This will cause the framework to re-throw any unhandled runtime exceptions after wrapping them in a ServletException wrapper.

Parameters:
unexpectedExceptionDisplay - The unexpectedExceptionDisplay to set.


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.