Content Engine Java API: EventExternalFailureException

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.lang.RuntimeException
    - - com.filenet.api.exception.EngineRuntimeException
      - com.filenet.api.engine.EventExternalFailureException

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable
```
public class EventExternalFailureException
extends EngineRuntimeException
```
Intended for implementations of the EventActionHandler interface in asynchronous event processing. Throw this exception to indicate an external failure, and specify wait time for the next retry. The wait time that you pass into the constructor overwrites the default retry wait time from the system configuration (set in GCD).

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_WAIT_TIME_SECONDS

static int MIN_WAIT_TIME_SECONDS

Constructor Summary

Constructors
Constructor and Description

EventExternalFailureException(int waitTimeInSecond)
Constructs the exception with a retry wait time.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getWaitTimeInSecond()` Gets the value set in the constructor that specifies the wait time before retrying an external operation that previously failed.

Methods inherited from class com.filenet.api.exception.EngineRuntimeException
getAsErrorStack, getExceptionCode, getLocalizedMessage, getMessage, mergeStackTraces, readExternal, toString, writeExternal

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MIN_WAIT_TIME_SECONDS
```
public static final int MIN_WAIT_TIME_SECONDS
```
    See Also:
    Constant Field Values
  - MAX_WAIT_TIME_SECONDS
```
public static final int MAX_WAIT_TIME_SECONDS
```
    See Also:
    Constant Field Values
- Constructor Detail
  - EventExternalFailureException
```
public EventExternalFailureException(int waitTimeInSecond)
```
    Constructs the exception with a retry wait time.
    
    Parameters:
    waitTimeInSecond - The number of seconds to wait before retrying the external operation that previously failed. Set this parameter to a value of 1 to 86400 seconds.
- Method Detail
  - getWaitTimeInSecond
```
public int getWaitTimeInSecond()
```
    Gets the value set in the constructor that specifies the wait time before retrying an external operation that previously failed.
    
    Returns:
    The number of seconds to wait.