com.filenet.api.engine
Class EventExternalFailureException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by com.filenet.api.exception.EngineRuntimeException
                  extended by 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
static int MAX_WAIT_TIME_SECONDS
           
static int MIN_WAIT_TIME_SECONDS
           
 
Constructor Summary
EventExternalFailureException(int waitTimeInSecond)
          Constructs the exception with a retry wait time.
 
Method Summary
 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
fillInStackTrace, getCause, getStackTrace, 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.


© Copyright IBM Corporation 2006, 2008. All rights reserved.