Package com.opencloud.sentinel.events

Interface FailedInstruction

  • All Superinterfaces:
    com.opencloud.rhino.cmp.Encodable
    public interface FailedInstruction
extends com.opencloud.rhino.cmp.Encodable
    Interface for FailedInstruction, containing information for Features to determine if action is required when an instruction failed to execute.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String COMPONENT_TYPE_KEY
      Component Type Key in the Instruction Details Map.
      static java.lang.String FAILED_REASON_KEY
      Failed Reason Key in the Instruction Details Map (if set).
      static java.lang.String INSTRUCTION_KEY
      Instruction Key in the Instruction Details Map.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Exception getException()
      Exception if thrown whilst Executing Instruction.
      java.util.Map<java.lang.String,​java.lang.String> getInstructionDetails()
      Returns the failed instruction's details.

      • Methods inherited from interface com.opencloud.rhino.cmp.Encodable

        encode

    • Field Detail

      • COMPONENT_TYPE_KEY

        static final java.lang.String COMPONENT_TYPE_KEY
        Component Type Key in the Instruction Details Map.
        See Also:
        Constant Field Values

      • INSTRUCTION_KEY

        static final java.lang.String INSTRUCTION_KEY
        Instruction Key in the Instruction Details Map.
        See Also:
        Constant Field Values

      • FAILED_REASON_KEY

        static final java.lang.String FAILED_REASON_KEY
        Failed Reason Key in the Instruction Details Map (if set).
        See Also:
        Constant Field Values

    • Method Detail

      • getInstructionDetails

        java.util.Map<java.lang.String,​java.lang.String> getInstructionDetails()
        Returns the failed instruction's details.
        Returns:
        The failed instruction details as a Map of String key value pairs.

      • getException

        java.lang.Exception getException()
        Exception if thrown whilst Executing Instruction.
        Returns:
        Exception Failed Instruction Exeception or null if there wasn't an exception.