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

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.common_api.jar]

com.sap.netweaver.bc.rf.util.exception.BaseException
  |
  +--com.sap.netweaver.bc.rf.common.exception.RepositoryException
        |
        +--com.sap.netweaver.bc.rf.common.exception.ResourceException
              |
              +--com.sap.netweaver.bc.rf.common.exception.ServiceNotAvailableException

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).

Constructor Summary

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

Method Summary

java.util.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

Constructor Detail

ServiceNotAvailableException

public ServiceNotAvailableException(IRid rid,
                                    java.util.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,
                                    java.util.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,
                                    java.util.Date retryAfterDate,
                                    java.lang.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,
                                    java.util.Date retryAfterDate,
                                    java.lang.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,
                                    java.util.Date retryAfterDate,
                                    java.lang.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,
                                    java.util.Date retryAfterDate,
                                    java.lang.String message,
                                    java.lang.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,
                                    java.util.Date retryAfterDate,
                                    java.lang.String message,
                                    java.lang.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,
                                    java.util.Date retryAfterDate,
                                    java.lang.String message,
                                    java.lang.Object[] args,
                                    java.lang.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,
                                    java.util.Date retryAfterDate,
                                    java.lang.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,
                                    java.util.Date retryAfterDate,
                                    java.lang.String message,
                                    java.lang.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,
                                    java.util.Date retryAfterDate,
                                    java.lang.String message,
                                    java.lang.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,
                                    java.util.Date retryAfterDate,
                                    java.lang.String message,
                                    java.lang.Object[] args,
                                    java.lang.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,
                                       java.util.Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       java.lang.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,
                                       java.util.Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       java.lang.String key,
                                       java.lang.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,
                                       java.util.Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       java.lang.String key,
                                       java.lang.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,
                                       java.util.Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       java.lang.String key,
                                       java.lang.Object[] args,
                                       java.lang.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,
                                       java.util.Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       java.lang.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,
                                       java.util.Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       java.lang.String key,
                                       java.lang.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,
                                       java.util.Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       java.lang.String key,
                                       java.lang.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,
                                       java.util.Date retryAfterDate,
                                       ResourceAccessor resourceAccessor,
                                       java.lang.String key,
                                       java.lang.Object[] args,
                                       java.lang.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,
                                       java.util.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,
                                       java.util.Date retryAfterDate,
                                       ResourceMessage message,
                                       java.lang.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,
                                       java.util.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,
                                       java.util.Date retryAfterDate,
                                       ResourceMessage message,
                                       java.lang.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 java.util.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