com.sap.security.api

Class UMRuntimeException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              com.sap.security.api.UMRuntimeException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FeatureNotAvailableException, NoSuchPCDRoleException, PrincipalNotAccessibleException

public class UMRuntimeException
extends RuntimeException

This is the superclass of all runtime exceptions employed in the user management; it indicates error conditions that can occur during the normal operation of the JVM.

See Also:

Serialized Form

Field Summary

protected List

mMessageBuffer Message Buffer

Constructor Summary

UMRuntimeException()

UMRuntimeException(String message)

UMRuntimeException(Throwable nestedException)

UMRuntimeException(Throwable nestedException, String message)

Method Summary

void	addMessage(IMessage message) Adds a message to the message buffer of this exception.
Iterator	getMessages(boolean clearPermanentMessages) Returns an iterator which contains the IMessage objects assigned to this IPrincipal or null if no messages are assigned.
Throwable	getNestedException()

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

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

Field Detail

mMessageBuffer

protected transient List mMessageBuffer

Message Buffer

Constructor Detail

UMRuntimeException

public UMRuntimeException(Throwable nestedException,
                          String message)

UMRuntimeException

public UMRuntimeException(Throwable nestedException)

UMRuntimeException

public UMRuntimeException(String message)

UMRuntimeException

public UMRuntimeException()

Method Detail

getMessages

public Iterator getMessages(boolean clearPermanentMessages)

Returns an iterator which contains the IMessage objects assigned to this IPrincipal or null if no messages are assigned. If the method is called with parameter true, every subsequent call will return null if no new message was assigned to this IPrincipal.

Parameters:

clearPermanentMessages - Specifies whether permanent messages with life time IMessage.LIFETIME_PERMANENT should be removed from the message buffer.

Returns:

The messages assigned to this IPrincipal object or null.

addMessage

public void addMessage(IMessage message)

Adds a message to the message buffer of this exception.

Parameters:

message - The message to add at the end of the message buffer.

getNestedException

public Throwable getNestedException()

Access Rights

This class can be accessed from:

SC	DC
[sap.com] ENGINEAPI	[sap.com] com.sap.security.api.sda
[sap.com] ENGFACADE	[sap.com] tc/je/usermanagement/api
[sap.com] CORE-TOOLS	[sap.com] com.sap.engine.client.lib