com.sap.exception.remote

Class SAPRemoteException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.io.IOException
              java.rmi.RemoteException
                  com.sap.exception.remote.SAPRemoteException

All Implemented Interfaces:

IBaseException, Serializable

public class SAPRemoteException

extends RemoteException

implements IBaseException

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.RemoteException

detail

Fields inherited from interface com.sap.exception.IBaseException

audit, defaultLocale

Constructor Summary

SAPRemoteException(Location loc)

SAPRemoteException(Location loc, LocalizableText locMessage)

SAPRemoteException(Location loc, LocalizableText locMessage, Throwable rootCause)

SAPRemoteException(Location loc, ResourceAccessor accessor, String patternKey)

SAPRemoteException(Location loc, ResourceAccessor accessor, String patternKey, Object[] parameters)

SAPRemoteException(Location loc, ResourceAccessor accessor, String patternKey, Object[] parameters, Throwable rootCause)

SAPRemoteException(Location loc, ResourceAccessor accessor, String patternKey, Throwable rootCause)

SAPRemoteException(Location loc, Throwable rootCause)

Method Summary

void	finallyLocalize() Finally localizes the LocalizableText message (if there is one attached).
void	finallyLocalize(Locale loc) Finally localizes the LocalizableText message (if there is one attached).
void	finallyLocalize(Locale loc, TimeZone timeZone) Finally localizes the LocalizableText message (if there is one attached).
void	finallyLocalize(TimeZone timeZone) Finally localizes the LocalizableText message (if there is one attached).
Throwable	getCause() Getter method for root cause.
LocalizableText	getLocalizableMessage() Getter method for localizable message.
String	getLocalizedMessage() Gets localized message.
String	getLocalizedMessage(Locale loc) Gets localized message.
String	getLocalizedMessage(Locale loc, TimeZone timeZone) Gets localized message.
String	getLocalizedMessage(TimeZone timeZone) Gets localized message.
Category	getLogCategory()
Location	getLogLocation()
int	getLogSeverity()
String	getMessage()
String	getNestedLocalizedMessage() Chains localized messages of the nested exceptions.
String	getNestedLocalizedMessage(Locale loc) Chains localized messages of the nested exceptions.
String	getNestedLocalizedMessage(Locale loc, TimeZone timeZone) Chains localized message of the nested exceptions.
String	getNestedLocalizedMessage(TimeZone timeZone) Chains localized message of the nested exceptions.
String	getNestedStackTraceString() Chains the stack trace information of nested exceptions.
String	getStackTraceString() Gets stack trace information of this exception only.
String	getSystemStackTraceString() Gets the stack information of this exception in respect of the current system environment.
Throwable	initCause(Throwable cause) Initializes the cause of this exception to the specified value.
void	log() Logs the exception message.
void	printStackTrace() Prints this exception and its backtrace to the standard error stream.
void	printStackTrace(PrintStream s) Prints this exception and its backtrace to the specified print stream.
void	printStackTrace(PrintWriter s) Prints the action object and its backtrace to the specified print writer.
void	setLogSettings(Category cat, int severity, Location loc) Setter method for logging information.
void	trace(int severity, Location loc) Deprecated.
void	trace(int severity, Location loc, String subloc) Deprecated.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SAPRemoteException

public SAPRemoteException(Location loc)

SAPRemoteException

public SAPRemoteException(Location loc,
                          Throwable rootCause)

SAPRemoteException

public SAPRemoteException(Location loc,
                          LocalizableText locMessage)

SAPRemoteException

public SAPRemoteException(Location loc,
                          LocalizableText locMessage,
                          Throwable rootCause)

SAPRemoteException

public SAPRemoteException(Location loc,
                          ResourceAccessor accessor,
                          String patternKey)

SAPRemoteException

public SAPRemoteException(Location loc,
                          ResourceAccessor accessor,
                          String patternKey,
                          Throwable rootCause)

SAPRemoteException

public SAPRemoteException(Location loc,
                          ResourceAccessor accessor,
                          String patternKey,
                          Object[] parameters)

SAPRemoteException

public SAPRemoteException(Location loc,
                          ResourceAccessor accessor,
                          String patternKey,
                          Object[] parameters,
                          Throwable rootCause)

Method Detail

initCause

public Throwable initCause(Throwable cause)

Description copied from interface: IBaseException

Initializes the cause of this exception to the specified value. (The cause is the throwable that caused this exception to get thrown.)

This method can be called at most once. That means the cause can be specified only once.

Specified by:

initCause in interface IBaseException

getCause

public Throwable getCause()

Description copied from interface: IBaseException

Getter method for root cause.

Specified by:

getCause in interface IBaseException

getLocalizableMessage

public LocalizableText getLocalizableMessage()

Description copied from interface: IBaseException

Getter method for localizable message.

Specified by:

getLocalizableMessage in interface IBaseException

Returns:

localizable message or null

getLocalizedMessage

public String getLocalizedMessage()

Description copied from interface: IBaseException

Gets localized message.

The default locale and default time zone are used for localization.

These values have no effect if the finallyLocalize method has already been called.

Specified by:

getLocalizedMessage in interface IBaseException

getLocalizedMessage

public String getLocalizedMessage(Locale loc)

Description copied from interface: IBaseException

Gets localized message.

The specified locale and the default time zone are used for localization. The default locale will be used if the locale parameter is null.

These values have no effect if the finallyLocalize method has been already called.

Specified by:

getLocalizedMessage in interface IBaseException

Parameters:

loc - locale

Returns:

message string or null

getLocalizedMessage

public String getLocalizedMessage(TimeZone timeZone)

Description copied from interface: IBaseException

Gets localized message.

The specified time zone and the default locale are used for localization. The default time zone will be used, if the time zone parameter is null.

These values have no effect if the finallyLocalize method has been already called.

Specified by:

getLocalizedMessage in interface IBaseException

Parameters:

timeZone - time zone

Returns:

message string or null

getLocalizedMessage

public String getLocalizedMessage(Locale loc,
                                  TimeZone timeZone)

Description copied from interface: IBaseException

Gets localized message.

The specified time zone and locale are used for localization. The default time zone and the default locale will be used, if the time zone parameter or the locale are null respectively.

These values have no effect if the finallyLocalize method has been already called.

Specified by:

getLocalizedMessage in interface IBaseException

Parameters:

loc - locale

timeZone - time zone

Returns:

message string or null

getNestedLocalizedMessage

public String getNestedLocalizedMessage()

Description copied from interface: IBaseException

Chains localized messages of the nested exceptions.

The default locale and the default time zone are used for localization.

These values have no effect if the finallyLocalize method has already been called.

Specified by:

getNestedLocalizedMessage in interface IBaseException

Returns:

message string or null

getNestedLocalizedMessage

public String getNestedLocalizedMessage(Locale loc)

Description copied from interface: IBaseException

Chains localized messages of the nested exceptions.

The specified locale and the default time zone are used for localization. The default locale will be used if the Locale parameter is null.

These values have no effect if the finallyLocalize method has been already called.

Specified by:

getNestedLocalizedMessage in interface IBaseException

Parameters:

loc - locale

Returns:

message string or null

getNestedLocalizedMessage

public String getNestedLocalizedMessage(TimeZone timeZone)

Description copied from interface: IBaseException

Chains localized message of the nested exceptions.

The specified time zone and the default locale are used for localization. The default time zone will be used, if the time zone parameter is null.

These values have no effect if the finallyLocalize method has been already called.

If the localized message is not specified, the non-localizable message is returned (if specified).

Specified by:

getNestedLocalizedMessage in interface IBaseException

Parameters:

timeZone - time zone

Returns:

message string or null

getNestedLocalizedMessage

public String getNestedLocalizedMessage(Locale loc,
                                        TimeZone timeZone)

Description copied from interface: IBaseException

Chains localized message of the nested exceptions.

The specified time zone and locale are used for localization. The default time zone and the default locale will be used, if the time zone parameter or the locale parameter are null respectively.

These values have no effect if the finallyLocalize method has been already called.

Specified by:

getNestedLocalizedMessage in interface IBaseException

Parameters:

loc - locale

timeZone - time zone

Returns:

message string

finallyLocalize

public void finallyLocalize()

Description copied from interface: IBaseException

Finally localizes the LocalizableText message (if there is one attached).

That means no further localization process can be performed on that object. If there is a nested exception implementing IBaseException, it will be localized recursively.

The default locale and the default time zone are used for localization.

Specified by:

finallyLocalize in interface IBaseException

finallyLocalize

public void finallyLocalize(Locale loc)

Description copied from interface: IBaseException

Finally localizes the LocalizableText message (if there is one attached).

That means no further localization process can be performed on that object. If there is a nested exception implementing IBaseException, it will be localized recursively.

The specified locale and the default time zone are used for localization. If the locale parameter is null, the default locale will be used.

Specified by:

finallyLocalize in interface IBaseException

Parameters:

loc - locale

finallyLocalize

public void finallyLocalize(TimeZone timeZone)

Description copied from interface: IBaseException

Finally localizes the LocalizableText message (if there is one attached).

That means no further localization process can be performed on that object. If there is a nested exception implementing IBaseException, it will be localized recursively.

The specified time zone and the default locale are used for localization. If time zone parameter is null, the default time zone will be used.

Specified by:

finallyLocalize in interface IBaseException

Parameters:

timeZone - time zone

finallyLocalize

public void finallyLocalize(Locale loc,
                            TimeZone timeZone)

Description copied from interface: IBaseException

Finally localizes the LocalizableText message (if there is one attached).

That means no further localization process can be performed on that object.If there is a nested exception implementing IBaseException, it will be localized recursively.

The specified locale and the specified time zone are used for localization. If the time zone parameter or the locale parameter are null, the default values will be used respectively.

Specified by:

finallyLocalize in interface IBaseException

Parameters:

loc - locale

timeZone - time zone

getSystemStackTraceString

public String getSystemStackTraceString()

Description copied from interface: IBaseException

Gets the stack information of this exception in respect of the current system environment.

Specified by:

getSystemStackTraceString in interface IBaseException

Returns:

the stack trace as a string in respect of the current system

getStackTraceString

public String getStackTraceString()

Description copied from interface: IBaseException

Gets stack trace information of this exception only.

The stack traces of nested exceptions are not chained.

Specified by:

getStackTraceString in interface IBaseException

Returns:

the stack trace as a string without information of chained exceptions.

getNestedStackTraceString

public String getNestedStackTraceString()

Description copied from interface: IBaseException

Chains the stack trace information of nested exceptions.

The caused stack trace is displayed first.

Specified by:

getNestedStackTraceString in interface IBaseException

Returns:

the stack trace as a string

printStackTrace

public void printStackTrace()

Description copied from interface: IBaseException

Prints this exception and its backtrace to the standard error stream. This method prints a stack trace for this exception object on the error output stream that is the value of the field System.err.

Specified by:

printStackTrace in interface IBaseException

printStackTrace

public void printStackTrace(PrintStream s)

Description copied from interface: IBaseException

Prints this exception and its backtrace to the specified print stream.

Specified by:

printStackTrace in interface IBaseException

printStackTrace

public void printStackTrace(PrintWriter s)

Description copied from interface: IBaseException

Prints the action object and its backtrace to the specified print writer.

Specified by:

printStackTrace in interface IBaseException

getLogCategory

public Category getLogCategory()

getLogSeverity

public int getLogSeverity()

getLogLocation

public Location getLogLocation()

setLogSettings

public void setLogSettings(Category cat,
                           int severity,
                           Location loc)

Deprecated.

Description copied from interface: IBaseException

Setter method for logging information.

Specified by:

setLogSettings in interface IBaseException

Parameters:

cat - logging category

severity - logging severity

loc - logging location

log

public void log()

Deprecated.

Description copied from interface: IBaseException

Logs the exception message. The logging takes only place if the category and location are set properly.

Specified by:

log in interface IBaseException

See Also:

IBaseException.setLogSettings(Category, int, Location)

getMessage

public String getMessage()

trace

public void trace(int severity,
                  Location loc)

Deprecated.

trace

public void trace(int severity,
                  Location loc,
                  String subloc)

Deprecated.