com.ibm.portal.resolver.exceptions
Class RedirectResolutionException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.portal.resolver.exceptions.ResolutionException
              extended by com.ibm.portal.resolver.exceptions.RedirectResolutionException
All Implemented Interfaces:
Localized, LocalizedStatus, Constants, java.io.Serializable

public abstract class RedirectResolutionException
extends ResolutionException

Exception that indicates to the caller of the resolution process that it should redirect to the URL produced in writeRedirectURL(Writer) to complete the resolution process.

Since:
7.0
See Also:
Serialized Form
Note:
This interface is designed to be implemented by clients.

Field Summary
 
Fields inherited from interface com.ibm.portal.resolver.exceptions.Constants
SC_BAD_REQUEST, SC_GONE, SC_INTERNAL_SERVER_ERROR, SC_NOT_FOUND, SC_REQUEST_TIMEOUT, SC_SERVICE_UNAVAILABLE, SC_UNAUTHORIZED
 
Constructor Summary
protected RedirectResolutionException()
          Default exception without a cause
protected RedirectResolutionException(java.lang.Throwable th)
          Exception that contains a root cause
 
Method Summary
 int getStatus()
          Returns as a hint to the client the recommended HTTP status code.
abstract  java.io.Writer writeRedirectURL(java.io.Writer out)
          Writes the redirect URL onto the target writer
 
Methods inherited from class com.ibm.portal.resolver.exceptions.ResolutionException
findLocalized, findLocalizedStatus, getDescription, getLocales, getLocalized, getLocalized, getLocalizedMessage, getLocalizedStatus, getMessage, getTitle
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.portal.Localized
getTitle
 

Constructor Detail

RedirectResolutionException

protected RedirectResolutionException()
Default exception without a cause


RedirectResolutionException

protected RedirectResolutionException(java.lang.Throwable th)
Exception that contains a root cause

Parameters:
th - root cause of the exception
Method Detail

getStatus

public int getStatus()
Description copied from class: ResolutionException
Returns as a hint to the client the recommended HTTP status code. Subclasses of this exception are advised to override this method to provide for more refined error codes.

Specified by:
getStatus in interface LocalizedStatus
Overrides:
getStatus in class ResolutionException
Returns:
HTTP status code

writeRedirectURL

public abstract java.io.Writer writeRedirectURL(java.io.Writer out)
                                         throws java.io.IOException,
                                                StateException
Writes the redirect URL onto the target writer

Returns:
the original exception
Throws:
java.io.IOException
StateException