org.archive.wayback.exception

Class WaybackException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.archive.wayback.exception.WaybackException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AccessControlException, AnchorWindowTooSmallException, AuthenticationControlException, BadQueryException, BetterRequestException, ConfigurationException, LiveDocumentNotAvailableException, LiveWebCacheUnavailableException, LiveWebTimeoutException, ResourceIndexNotAvailableException, ResourceNotInArchiveException, SpecificCaptureReplayException

public class WaybackException
extends Exception

Base class for Wayback internal exceptions.

Actually many sub-classes are not really "internal". The fact that this class has helper methods for localization suggests sub-classes, if not all, are to be made visible on user interface. Probably we should revise class hierarchy and add more sub-classes - that would eliminate ad-hoc branching found in many places.

Author:

Brad Tofel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	GENERIC_ID
protected String	id
protected boolean	isLiveWebAvailable
protected static String	KEY_MESSAGE_SUFFIX
protected static String	KEY_PREFIX
protected static String	KEY_TITLE_SUFFIX

Constructor Summary

Constructors

Constructor and Description
WaybackException(String message) Constructor with message only
WaybackException(String message, String title) Constructor with message, and title
WaybackException(String message, String title, String details) Constructor with message, title, and details

Method Summary

Methods

Modifier and Type	Method and Description
String	getDetails()
String	getMessage()
String	getMessageKey()
int	getStatus()
String	getTitle()
String	getTitleKey()
boolean	isLiveWebAvailable()
void	setLiveWebAvailable(boolean isLiveWebAvailable) Set if target URL is available on live Web.
void	setupResponse(javax.servlet.http.HttpServletResponse response)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

GENERIC_ID

protected static final String GENERIC_ID

See Also:

Constant Field Values

KEY_PREFIX

protected static final String KEY_PREFIX

See Also:

Constant Field Values

KEY_TITLE_SUFFIX

protected static final String KEY_TITLE_SUFFIX

See Also:

Constant Field Values

KEY_MESSAGE_SUFFIX

protected static final String KEY_MESSAGE_SUFFIX

See Also:

Constant Field Values

id

protected String id

isLiveWebAvailable

protected boolean isLiveWebAvailable

Constructor Detail

WaybackException

public WaybackException(String message)

Constructor with message only

Parameters:

message -

WaybackException

public WaybackException(String message,
                String title)

Constructor with message, and title

Parameters:

message -

title -

WaybackException

public WaybackException(String message,
                String title,
                String details)

Constructor with message, title, and details

Parameters:

message -

title -

details -

Method Detail

getTitle

public String getTitle()

Returns:

Returns the title.

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

Returns:

Returns the message.

getDetails

public String getDetails()

Returns:

Returns the details.

getTitleKey

public String getTitleKey()

Returns:

The localization key name of the title of this WaybackException

getMessageKey

public String getMessageKey()

Returns:

The localization key name of the message of this WaybackException

getStatus

public int getStatus()

Returns:

the HTTP status code appropriate to this exception class.

setupResponse

public void setupResponse(javax.servlet.http.HttpServletResponse response)

isLiveWebAvailable

public boolean isLiveWebAvailable()

setLiveWebAvailable

public void setLiveWebAvailable(boolean isLiveWebAvailable)

Set if target URL is available on live Web.

Used by page template to generate a special message suggesting user to archive the live web.

TODO: I believe this is specific to not-in-archive situation, not WaybackException in general which covers broader type of failures.

Parameters:

isLiveWebAvailable - true if available