com.sap.netweaver.bc.rf.common.exception

Class ServiceNotAvailableException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended bycom.sap.exception.BaseException
              extended bycom.sap.netweaver.bc.rf.util.exception.BaseException
                  extended bycom.sap.netweaver.bc.rf.common.exception.RepositoryException
                      extended bycom.sap.netweaver.bc.rf.common.exception.ResourceException
                          extended bycom.sap.netweaver.bc.rf.common.exception.ServiceNotAvailableException
All Implemented Interfaces:
IBaseException, Serializable

public class ServiceNotAvailableException
extends ResourceException

Indicates that the repository (the service provided by a method call) is not available at this time but may available later. Examples:
- The repository has a fixed amount of available resources to process a request (e.g. backend connections) and all resources are in use by other threads.
- The repository backend system is overloaded (e.g. a WebDAV Server that reports HTTP Status 503). This exception may be used by a repository implementation as an alternative to blocking the calling thread until enough resources are avialable to process the request. The caller may use this exception to retry the method call at a later time (see #getRetryAfter).

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.sap.exception.IBaseException
audit, defaultLocale
 
Constructor Summary
  ServiceNotAvailableException(IRid rid, Date retryAfterDate)
          Constructs a new exception.
  ServiceNotAvailableException(IRid rid, Date retryAfterDate, boolean logExceptionOnCreation)
          Constructs a new exception.
protected ServiceNotAvailableException(IRid rid, Date retryAfterDate, ResourceAccessor resourceAccessor, String key)
          Constructs a new exception.
protected ServiceNotAvailableException(IRid rid, Date retryAfterDate, ResourceAccessor resourceAccessor, String key, boolean logExceptionOnCreation)
          Constructs a new exception.
protected ServiceNotAvailableException(IRid rid, Date retryAfterDate, ResourceAccessor resourceAccessor, String key, Object[] args)
          Constructs a new exception.
protected ServiceNotAvailableException(IRid rid, Date retryAfterDate, ResourceAccessor resourceAccessor, String key, Object[] args, boolean logExceptionOnCreation)
          Constructs a new exception.
protected ServiceNotAvailableException(IRid rid, Date retryAfterDate, ResourceAccessor resourceAccessor, String key, Object[] args, Throwable rootCause)
          Constructs a new exception.
protected ServiceNotAvailableException(IRid rid, Date retryAfterDate, ResourceAccessor resourceAccessor, String key, Object[] args, Throwable rootCause, boolean logExceptionOnCreation)
          Constructs a new exception.
protected ServiceNotAvailableException(IRid rid, Date retryAfterDate, ResourceAccessor resourceAccessor, String key, Throwable rootCause)
          Constructs a new exception.
protected ServiceNotAvailableException(IRid rid, Date retryAfterDate, ResourceAccessor resourceAccessor, String key, Throwable rootCause, boolean logExceptionOnCreation)
          Constructs a new exception.
protected ServiceNotAvailableException(IRid rid, Date retryAfterDate, ResourceMessage message)
          Constructs a new exception.
protected ServiceNotAvailableException(IRid rid, Date retryAfterDate, ResourceMessage message, boolean logExceptionOnCreation)
          Constructs a new exception.
protected ServiceNotAvailableException(IRid rid, Date retryAfterDate, ResourceMessage message, Throwable rootCause)
          Constructs a new exception.
protected ServiceNotAvailableException(IRid rid, Date retryAfterDate, ResourceMessage message, Throwable rootCause, boolean logExceptionOnCreation)
          Constructs a new exception.
  ServiceNotAvailableException(IRid rid, Date retryAfterDate, String message)
          Constructs a new exception.
  ServiceNotAvailableException(IRid rid, Date retryAfterDate, String message, boolean logExceptionOnCreation)
          Constructs a new exception.
  ServiceNotAvailableException(IRid rid, Date retryAfterDate, String message, Object[] args)
          Constructs a new exception.
  ServiceNotAvailableException(IRid rid, Date retryAfterDate, String message, Object[] args, boolean logExceptionOnCreation)
          Constructs a new exception.
  ServiceNotAvailableException(IRid rid, Date retryAfterDate, String message, Object[] args, Throwable rootCause)
          Constructs a new exception.
  ServiceNotAvailableException(IRid rid, Date retryAfterDate, String message, Object[] args, Throwable rootCause, boolean logExceptionOnCreation)
          Constructs a new exception.
  ServiceNotAvailableException(IRid rid, Date retryAfterDate, String message, Throwable rootCause)
          Constructs a new exception.
  ServiceNotAvailableException(IRid rid, Date retryAfterDate, String message, Throwable rootCause, boolean logExceptionOnCreation)
          Constructs a new exception.
  ServiceNotAvailableException(IRid rid, Date retryAfterDate, Throwable rootCause)
          Constructs a new exception.
  ServiceNotAvailableException(IRid rid, Date retryAfterDate, Throwable rootCause, boolean logExceptionOnCreation)
          Constructs a new exception.
 
Method Summary
 Date getRetryAfterDate()
          Returns the time when retries of the operation are recommended.
 
Methods inherited from class com.sap.netweaver.bc.rf.common.exception.ResourceException
getRID
 
Methods inherited from class com.sap.exception.BaseException
finallyLocalize, finallyLocalize, finallyLocalize, finallyLocalize, getCause, getLocalizableMessage, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getLogCategory, getLogLocation, getLogSeverity, getMessage, getNestedLocalizedMessage, getNestedLocalizedMessage, getNestedLocalizedMessage, getNestedLocalizedMessage, getNestedStackTraceString, getStackTraceString, getSystemStackTraceString, initCause, log, printStackTrace, printStackTrace, printStackTrace, restoreLogSettings, setLogSettings, trace, trace
 
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

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    Date retryAfterDate)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    Date retryAfterDate,
                                    boolean logExceptionOnCreation)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
logExceptionOnCreation - when true log the exception now during its construction

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    Date retryAfterDate,
                                    Throwable rootCause)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
rootCause - throwable object which caused this exception

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    Date retryAfterDate,
                                    Throwable rootCause,
                                    boolean logExceptionOnCreation)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
rootCause - throwable object which caused this exception
logExceptionOnCreation - when true log the exception now during its construction

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    Date retryAfterDate,
                                    String message)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
message - not localized message

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    Date retryAfterDate,
                                    String message,
                                    Object[] args)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
message - not localized message
args - message arguments inserted by MessageFormat means

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    Date retryAfterDate,
                                    String message,
                                    Throwable rootCause)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
message - not localized message
rootCause - throwable object which caused this exception

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    Date retryAfterDate,
                                    String message,
                                    Object[] args,
                                    Throwable rootCause)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
message - not localized message
args - message arguments inserted by MessageFormat means
rootCause - throwable object which caused this exception

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    Date retryAfterDate,
                                    String message,
                                    boolean logExceptionOnCreation)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
message - not localized message
logExceptionOnCreation - when true log the exception now during its construction

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    Date retryAfterDate,
                                    String message,
                                    Object[] args,
                                    boolean logExceptionOnCreation)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
message - not localized message
args - message arguments inserted by MessageFormat means
logExceptionOnCreation - when true log the exception now during its construction

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    Date retryAfterDate,
                                    String message,
                                    Throwable rootCause,
                                    boolean logExceptionOnCreation)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
message - not localized message
rootCause - throwable object which caused this exception
logExceptionOnCreation - when true log the exception now during its construction

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    Date retryAfterDate,
                                    String message,
                                    Object[] args,
                                    Throwable rootCause,
                                    boolean logExceptionOnCreation)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
message - not localized message
args - message arguments inserted by MessageFormat means
rootCause - throwable object which caused this exception
logExceptionOnCreation - when true log the exception now during its construction

ServiceNotAvailableException

protected ServiceNotAvailableException(IRid rid,
                                       Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       String key)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
resourceAccessor - resource accessor
key - resource identifier for localized message

ServiceNotAvailableException

protected ServiceNotAvailableException(IRid rid,
                                       Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       String key,
                                       Object[] args)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
resourceAccessor - resource accessor
key - resource identifier for localized message
args - message arguments inserted by MessageFormat means

ServiceNotAvailableException

protected ServiceNotAvailableException(IRid rid,
                                       Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       String key,
                                       Throwable rootCause)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
resourceAccessor - resource accessor
key - resource identifier for localized message
rootCause - throwable object which caused this exception

ServiceNotAvailableException

protected ServiceNotAvailableException(IRid rid,
                                       Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       String key,
                                       Object[] args,
                                       Throwable rootCause)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
resourceAccessor - resource accessor
key - resource identifier for localized message
args - message arguments inserted by MessageFormat means
rootCause - throwable object which caused this exception

ServiceNotAvailableException

protected ServiceNotAvailableException(IRid rid,
                                       Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       String key,
                                       boolean logExceptionOnCreation)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
resourceAccessor - resource accessor
key - resource identifier for localized message
logExceptionOnCreation - when true log the exception now during its construction

ServiceNotAvailableException

protected ServiceNotAvailableException(IRid rid,
                                       Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       String key,
                                       Object[] args,
                                       boolean logExceptionOnCreation)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
resourceAccessor - resource accessor
key - resource identifier for localized message
args - message arguments inserted by MessageFormat means
logExceptionOnCreation - when true log the exception now during its construction

ServiceNotAvailableException

protected ServiceNotAvailableException(IRid rid,
                                       Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       String key,
                                       Throwable rootCause,
                                       boolean logExceptionOnCreation)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
resourceAccessor - resource accessor
key - resource identifier for localized message
rootCause - throwable object which caused this exception
logExceptionOnCreation - when true log the exception now during its construction

ServiceNotAvailableException

protected ServiceNotAvailableException(IRid rid,
                                       Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       String key,
                                       Object[] args,
                                       Throwable rootCause,
                                       boolean logExceptionOnCreation)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
resourceAccessor - resource accessor
key - resource identifier for localized message
args - message arguments inserted by MessageFormat means
rootCause - throwable object which caused this exception
logExceptionOnCreation - when true log the exception now during its construction

ServiceNotAvailableException

protected ServiceNotAvailableException(IRid rid,
                                       Date retryAfterDate,
                                       ResourceMessage message)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
message - not localized message

ServiceNotAvailableException

protected ServiceNotAvailableException(IRid rid,
                                       Date retryAfterDate,
                                       ResourceMessage message,
                                       Throwable rootCause)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
message - not localized message
rootCause - throwable object which caused this exception

ServiceNotAvailableException

protected ServiceNotAvailableException(IRid rid,
                                       Date retryAfterDate,
                                       ResourceMessage message,
                                       boolean logExceptionOnCreation)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
message - not localized message
logExceptionOnCreation - when true log the exception now during its construction

ServiceNotAvailableException

protected ServiceNotAvailableException(IRid rid,
                                       Date retryAfterDate,
                                       ResourceMessage message,
                                       Throwable rootCause,
                                       boolean logExceptionOnCreation)
Constructs a new exception.

Parameters:
rid - resource id of the resource this exception is associated with (if any)
retryAfterDate - retry interval, can be null (see #getRetryAfter).
message - not localized message
rootCause - throwable object which caused this exception
logExceptionOnCreation - when true log the exception now during its construction
Method Detail

getRetryAfterDate

public Date getRetryAfterDate()
Returns the time when retries of the operation are recommended. Repeating the operation before this time, will most likely raise this exception again. If the best time for retry is unknown, null is retuned.

Returns:
time of first recommended retry or null if not known


Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.