oracle.syndication
Class OSSException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--oracle.syndication.OSSException

public class OSSException

extends java.lang.Exception

implements OSSExceptionConstants

Superclass of all Exception classes that others of the Syndication(ICE) server modules will subclass from. This supports wrapping of other exceptions within itself so that exceptions can be propagated from the lowest level to the highest. It also supports ResourceBoundles for internationalization of textual messages.

Internalization.

Using getLocalizedMessage(), the error message of this class and all its descendant classes can transform the error message into the local language according to the locale of the Dynamic Service Engine's host.

Internal design

Internalization.

See Also:

Serialized Form

Constructor Summary

OSSException()
Used now by ICE-syndication server

OSSException(java.lang.Exception e)
Used to wrap RuntimeException into a OSSException.

OSSException(int iCode)

OSSException(int iCode, java.lang.Exception e)

OSSException(int iCode, java.lang.Exception e, java.lang.Object oArg)

OSSException(int iCode, java.lang.Exception e, java.lang.Object[] oaArgs)

OSSException(int iCode, java.lang.Exception e, java.lang.Object oArg1, java.lang.Object oArg2)

OSSException(int iCode, java.lang.Exception e, java.lang.Object oArg1, java.lang.Object oArg2, java.lang.Object oArg3)

OSSException(int iCode, java.lang.Object oArg)

OSSException(int iCode, java.lang.Object[] oaArgs)

OSSException(int iCode, java.lang.Object oArg1, java.lang.Object oArg2)

OSSException(int iCode, java.lang.Object oArg1, java.lang.Object oArg2, java.lang.Object oArg3)

OSSException(java.lang.String szMsg)

OSSException(java.lang.String szMsgKey, java.lang.Exception e)

OSSException(java.lang.String szMsgKey, java.lang.Object oArg)

OSSException(java.lang.String szMsgKey, java.lang.Object[] oaParams)

OSSException(java.lang.String szMsgKey, java.lang.Object[] oaParams, java.lang.Exception e)

OSSException(java.lang.String szMsgKey, java.lang.Object oArg, java.lang.Exception e)

Method Summary

Type	Method
java.lang.ClassLoader	getClassLoader() By default use the standard class loader
int	getCode() Returns the error code for this exception (e.g 3).
java.lang.String	getErrorCode() Returns the DS error code (e.g.
java.lang.Exception	getException() Exposes the internal exception
java.lang.String	getLocalizedMessage()
java.lang.String	getLocalizedMessage(java.util.Locale l)
java.lang.String	getMessage() Returns the message associated to this OSSException using the default locale (en_US).
java.lang.Object[]	getParams() Returns the supplied arguments for the error message
java.lang.String	getResourceBundleName() Returns the ResourceBundle to be used by the subclasses of this exceptions.
void	printStackTrace()
void	printStackTrace(java.io.PrintStream s)
void	printStackTrace(java.io.PrintWriter pw)
void	printStackTraceWithNestedException()
void	printStackTraceWithNestedException(java.io.PrintStream s)
void	printStackTraceWithNestedException(java.io.PrintWriter s)
void	setClientSideExceptionParams(java.lang.String szErrorCode, java.lang.String szErrorMessage, java.lang.String szStackTrace)
void	setException(java.lang.Exception e)
void	setParam()
void	setParam(java.lang.Object oParam)
void	setParam(java.lang.Object[] oaParams)
void	setParam(java.lang.Object oParam_1, java.lang.Object oParam_2)
void	setParam(java.lang.Object oParam_1, java.lang.Object oParam_2, java.lang.Object oParam_3)

Methods inherited from class java.lang.Throwable

fillInStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OSSException

public OSSException()

Used now by ICE-syndication server

OSSException

public OSSException(java.lang.Exception e)

Used to wrap RuntimeException into a OSSException. This will allow us to send them over to remote consumers.

OSSException

public OSSException(int iCode)

OSSException

public OSSException(int iCode,
                    java.lang.Object oArg)

OSSException

public OSSException(int iCode,
                    java.lang.Object oArg1,
                    java.lang.Object oArg2)

OSSException

public OSSException(int iCode,
                    java.lang.Object oArg1,
                    java.lang.Object oArg2,
                    java.lang.Object oArg3)

OSSException

public OSSException(int iCode,
                    java.lang.Object[] oaArgs)

OSSException

public OSSException(int iCode,
                    java.lang.Exception e)

OSSException

public OSSException(int iCode,
                    java.lang.Exception e,
                    java.lang.Object oArg)

OSSException

public OSSException(int iCode,
                    java.lang.Exception e,
                    java.lang.Object oArg1,
                    java.lang.Object oArg2)

OSSException

public OSSException(int iCode,
                    java.lang.Exception e,
                    java.lang.Object oArg1,
                    java.lang.Object oArg2,
                    java.lang.Object oArg3)

OSSException

public OSSException(int iCode,
                    java.lang.Exception e,
                    java.lang.Object[] oaArgs)

OSSException

public OSSException(java.lang.String szMsg)

OSSException

public OSSException(java.lang.String szMsgKey,
                    java.lang.Object oArg)

OSSException

public OSSException(java.lang.String szMsgKey,
                    java.lang.Object[] oaParams)

OSSException

public OSSException(java.lang.String szMsgKey,
                    java.lang.Exception e)

OSSException

public OSSException(java.lang.String szMsgKey,
                    java.lang.Object oArg,
                    java.lang.Exception e)

OSSException

public OSSException(java.lang.String szMsgKey,
                    java.lang.Object[] oaParams,
                    java.lang.Exception e)

Method Detail

setException

public void setException(java.lang.Exception e)

getException

public java.lang.Exception getException()

Exposes the internal exception

Returns:

the exception that this exception is wrapping if any. it returns null otherwise.

getParams

public java.lang.Object[] getParams()

Returns the supplied arguments for the error message

getClassLoader

public java.lang.ClassLoader getClassLoader()

By default use the standard class loader

getErrorCode

public java.lang.String getErrorCode()

Returns the DS error code (e.g. DS-303)

getCode

public int getCode()

Returns the error code for this exception (e.g 3). This will be used by the getErrorCode to format the return code (e.g. OSS/ICE-303)

getResourceBundleName

public java.lang.String getResourceBundleName()

Returns the ResourceBundle to be used by the subclasses of this exceptions.

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Overrides:

getLocalizedMessage in class java.lang.Throwable

getLocalizedMessage

public java.lang.String getLocalizedMessage(java.util.Locale l)

getMessage

public java.lang.String getMessage()

Returns the message associated to this OSSException using the default locale (en_US).

Overrides:

getMessage in class java.lang.Throwable

printStackTrace

public void printStackTrace()

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream s)

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintWriter pw)

Overrides:

printStackTrace in class java.lang.Throwable

printStackTraceWithNestedException

public void printStackTraceWithNestedException()

printStackTraceWithNestedException

public void printStackTraceWithNestedException(java.io.PrintStream s)

printStackTraceWithNestedException

public void printStackTraceWithNestedException(java.io.PrintWriter s)

setParam

public void setParam()

setParam

public void setParam(java.lang.Object oParam)

setParam

public void setParam(java.lang.Object oParam_1,
                     java.lang.Object oParam_2)

setParam

public void setParam(java.lang.Object oParam_1,
                     java.lang.Object oParam_2,
                     java.lang.Object oParam_3)

setParam

public void setParam(java.lang.Object[] oaParams)

setClientSideExceptionParams

public void setClientSideExceptionParams(java.lang.String szErrorCode,
                                         java.lang.String szErrorMessage,
                                         java.lang.String szStackTrace)