railo.runtime.exp
Class PageServletException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by javax.servlet.ServletException
              extended by railo.runtime.exp.PageServletException
All Implemented Interfaces:
Serializable, Dumpable, IPageException, PageExceptionBox

public final class PageServletException
extends javax.servlet.ServletException
implements IPageException, PageExceptionBox

by definition a JSP Tag can only throw JSPExceptions, for that case the PageException is a Subclass of the JSPExceptions, but when a PageException, is escaleted to a parent page, this goes over the include method of the PageContext Object, but this can only throw ServletException. For that this class can Box a JSPException (PageException) in a ServletException (PageServletException)

See Also:
Serialized Form

Constructor Summary
PageServletException(PageException pe)
          constructor of the class
 
Method Summary
 void addContext(PageSource template, int line, int column, StackTraceElement ste)
          add a template to the context of the error
 Struct getAddional()
           
 Struct getAdditional()
           
 CatchBlock getCatchBlock(Config config)
          return detailed catch block of the error
 Struct getCatchBlock(PageContext pc)
          return detailed catch block of the error
 String getCustomTypeAsString()
          Error custom type as String
 String getDetail()
          return detailed error message
 Struct getErrorBlock(PageContext pc, ErrorPage ep)
          return detailed error block of the error
 String getErrorCode()
          Error Code
 String getExtendedInfo()
          return extended info to the error
 PageException getPageException()
           
 String getStackTraceAsString()
          returns the java stracktrace as a String
 int getTracePointer()
           
 String getTypeAsString()
          Error type as String
 void setDetail(String detail)
          sets detailed error message
 void setErrorCode(String errorCode)
          sets the Error Code
 void setExtendedInfo(String extendedInfo)
          sets extended info to the error
 void setTracePointer(int tracePointer)
           
 DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties dp)
          method to print out information to a object as HTML
 boolean typeEqual(String type)
          compare error type as String
 
Methods inherited from class javax.servlet.ServletException
getRootCause
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PageServletException

public PageServletException(PageException pe)
constructor of the class

Parameters:
pe - page exception to hold
Method Detail

getPageException

public PageException getPageException()
Specified by:
getPageException in interface PageExceptionBox
Returns:
returns the inner page exception
See Also:
PageExceptionBox.getPageException()

getDetail

public String getDetail()
Description copied from interface: IPageException
return detailed error message

Specified by:
getDetail in interface IPageException
Returns:
detailed error message
See Also:
IPageException.getDetail()

getErrorCode

public String getErrorCode()
Description copied from interface: IPageException
Error Code

Specified by:
getErrorCode in interface IPageException
Returns:
Error Code
See Also:
IPageException.getErrorCode()

getExtendedInfo

public String getExtendedInfo()
Description copied from interface: IPageException
return extended info to the error

Specified by:
getExtendedInfo in interface IPageException
Returns:
extended info
See Also:
IPageException.getExtendedInfo()

getCatchBlock

public Struct getCatchBlock(PageContext pc)
Description copied from interface: IPageException
return detailed catch block of the error

Specified by:
getCatchBlock in interface IPageException
Returns:
catch block
See Also:
IPageException.getCatchBlock(railo.runtime.PageContext)

getCatchBlock

public CatchBlock getCatchBlock(Config config)
Description copied from interface: IPageException
return detailed catch block of the error

Specified by:
getCatchBlock in interface IPageException
Returns:
catch block
See Also:
IPageException.getCatchBlock(railo.runtime.PageContext)

getErrorBlock

public Struct getErrorBlock(PageContext pc,
                            ErrorPage ep)
Description copied from interface: IPageException
return detailed error block of the error

Specified by:
getErrorBlock in interface IPageException
Parameters:
pc - page context of the request
ep - error page
Returns:
catch block
See Also:
IPageException.getErrorBlock(PageContext pc,ErrorPage ep)

addContext

public void addContext(PageSource template,
                       int line,
                       int column,
                       StackTraceElement ste)
Description copied from interface: IPageException
add a template to the context of the error

Specified by:
addContext in interface IPageException
Parameters:
template - new template context
line - line of the error
column - column of the error
See Also:
IPageException.addContext(railo.runtime.PageSource, int, int, java.lang.StackTraceElement)

toDumpData

public DumpData toDumpData(PageContext pageContext,
                           int maxlevel,
                           DumpProperties dp)
Description copied from interface: Dumpable
method to print out information to a object as HTML

Specified by:
toDumpData in interface Dumpable
Returns:
HTML print out
See Also:
Dumpable.toDumpData(railo.runtime.PageContext, int, railo.runtime.dump.DumpProperties)

setDetail

public void setDetail(String detail)
Description copied from interface: IPageException
sets detailed error message

Specified by:
setDetail in interface IPageException
See Also:
IPageException.setDetail(java.lang.String)

setErrorCode

public void setErrorCode(String errorCode)
Description copied from interface: IPageException
sets the Error Code

Specified by:
setErrorCode in interface IPageException
See Also:
IPageException.setErrorCode(java.lang.String)

setExtendedInfo

public void setExtendedInfo(String extendedInfo)
Description copied from interface: IPageException
sets extended info to the error

Specified by:
setExtendedInfo in interface IPageException
See Also:
IPageException.setExtendedInfo(java.lang.String)

getTypeAsString

public String getTypeAsString()
Description copied from interface: IPageException
Error type as String

Specified by:
getTypeAsString in interface IPageException
Returns:
error type
See Also:
IPageException.getTypeAsString()

typeEqual

public boolean typeEqual(String type)
Description copied from interface: IPageException
compare error type as String

Specified by:
typeEqual in interface IPageException
Parameters:
type - other error type
Returns:
is same error type
See Also:
IPageException.typeEqual(java.lang.String)

getCustomTypeAsString

public String getCustomTypeAsString()
Description copied from interface: IPageException
Error custom type as String

Specified by:
getCustomTypeAsString in interface IPageException
Returns:
error type
See Also:
IPageException.getCustomTypeAsString()

getTracePointer

public int getTracePointer()
Specified by:
getTracePointer in interface IPageException
Returns:
Returns the tracePointer.
See Also:
IPageException.getTracePointer()

setTracePointer

public void setTracePointer(int tracePointer)
Specified by:
setTracePointer in interface IPageException
Parameters:
tracePointer - The tracePointer to set.
See Also:
IPageException.setTracePointer(int)

getAdditional

public Struct getAdditional()
Specified by:
getAdditional in interface IPageException
Returns:
Returns the additional.
See Also:
IPageException.getAdditional()

getAddional

public Struct getAddional()
Specified by:
getAddional in interface IPageException
Returns:
Returns the additional.

getStackTraceAsString

public String getStackTraceAsString()
Description copied from interface: IPageException
returns the java stracktrace as a String

Specified by:
getStackTraceAsString in interface IPageException
Returns:
stack trace
See Also:
IPageException.getStackTraceAsString()


Copyright © 2012 Railo