Class EnterStateVetoException

All Implemented Interfaces:
Serializable

public class EnterStateVetoException extends FlowExecutionException
Exception thrown to veto the entering of a state of a flow. Typically thrown by FlowExecutionListener objects that apply security or other runtime constraint checks to flow executions.
Author:
Keith Donald, Erwin Vervaet
See Also:
  • Constructor Details

    • EnterStateVetoException

      public EnterStateVetoException(String flowId, String sourceStateId, String vetoedStateId, String message)
      Create a new enter state veto exception.
      Parameters:
      flowId - the active flow
      sourceStateId - the current state when the veto operation occured
      vetoedStateId - the state for which entering is vetoed
      message - a descriptive message
    • EnterStateVetoException

      public EnterStateVetoException(String flowId, String sourceStateId, String vetoedStateId, String message, Throwable cause)
      Create a new enter state veto exception.
      Parameters:
      flowId - the active flow
      sourceStateId - the current state when the veto operation occured
      vetoedStateId - the state for which entering is vetoed
      message - a descriptive message
      cause - the underlying cause
    • EnterStateVetoException

      public EnterStateVetoException(RequestContext context, StateDefinition vetoedState, String message)
      Create a new enter state veto exception.
      Parameters:
      context - the flow execution request context
      vetoedState - the state for which entering is vetoed
      message - a descriptive message
    • EnterStateVetoException

      public EnterStateVetoException(RequestContext context, StateDefinition vetoedState, String message, Throwable cause)
      Create a new enter state veto exception.
      Parameters:
      context - the flow execution request context
      vetoedState - the state for which entering is vetoed
      message - a descriptive message
      cause - the underlying cause
  • Method Details

    • getVetoedStateId

      public String getVetoedStateId()
      Returns the state for which entering was vetoed.