Package ortus.boxlang.runtime.events

Enum Class BoxEvent

java.lang.Object
java.lang.Enum<BoxEvent>
ortus.boxlang.runtime.events.BoxEvent
All Implemented Interfaces:
Serializable, Comparable<BoxEvent>, Constable
public enum BoxEvent extends Enum<BoxEvent>
These are all the core BoxLang interception events that can be intercepted by the BoxLang runtime.

  • Enum Constant Details

    • ON_RUNTIME_START

      public static final BoxEvent ON_RUNTIME_START
      Runtime Events

    • ON_RUNTIME_SHUTDOWN

      public static final BoxEvent ON_RUNTIME_SHUTDOWN

    • ON_RUNTIME_CONFIGURATION_LOAD

      public static final BoxEvent ON_RUNTIME_CONFIGURATION_LOAD

    • ON_RUNTIME_BOX_CONTEXT_STARTUP

      public static final BoxEvent ON_RUNTIME_BOX_CONTEXT_STARTUP

    • ON_SERVER_SCOPE_CREATION

      public static final BoxEvent ON_SERVER_SCOPE_CREATION

    • ON_CONFIGURATION_LOAD

      public static final BoxEvent ON_CONFIGURATION_LOAD

    • ON_CONFIGURATION_OVERRIDE_LOAD

      public static final BoxEvent ON_CONFIGURATION_OVERRIDE_LOAD

    • ON_PARSE

      public static final BoxEvent ON_PARSE

    • ON_MISSING_MAPPING

      public static final BoxEvent ON_MISSING_MAPPING

    • ON_BIF_INSTANCE

      public static final BoxEvent ON_BIF_INSTANCE
      Lifecycle Methods for Components and BIFS

    • ON_BIF_INVOCATION

      public static final BoxEvent ON_BIF_INVOCATION

    • ON_COMPONENT_INSTANCE

      public static final BoxEvent ON_COMPONENT_INSTANCE

    • ON_COMPONENT_INVOCATION

      public static final BoxEvent ON_COMPONENT_INVOCATION

    • ON_FILECOMPONENT_ACTION

      public static final BoxEvent ON_FILECOMPONENT_ACTION

    • ON_CREATEOBJECT_REQUEST

      public static final BoxEvent ON_CREATEOBJECT_REQUEST

    • AFTER_DYNAMIC_OBJECT_CREATION

      public static final BoxEvent AFTER_DYNAMIC_OBJECT_CREATION
      Dynamic Object Events

    • ON_APPLICATION_START

      public static final BoxEvent ON_APPLICATION_START
      Application Related Events

    • ON_APPLICATION_END

      public static final BoxEvent ON_APPLICATION_END

    • ON_APPLICATION_RESTART

      public static final BoxEvent ON_APPLICATION_RESTART

    • ON_APPLICATION_DEFINED

      public static final BoxEvent ON_APPLICATION_DEFINED

    • BEFORE_APPLICATION_LISTENER_LOAD

      public static final BoxEvent BEFORE_APPLICATION_LISTENER_LOAD

    • AFTER_APPLICATION_LISTENER_LOAD

      public static final BoxEvent AFTER_APPLICATION_LISTENER_LOAD

    • ON_REQUEST_FLUSH_BUFFER

      public static final BoxEvent ON_REQUEST_FLUSH_BUFFER

    • ON_SESSION_CREATED

      public static final BoxEvent ON_SESSION_CREATED

    • ON_SESSION_DESTROYED

      public static final BoxEvent ON_SESSION_DESTROYED

    • ON_REQUEST

      public static final BoxEvent ON_REQUEST

    • ON_REQUEST_START

      public static final BoxEvent ON_REQUEST_START

    • ON_REQUEST_END

      public static final BoxEvent ON_REQUEST_END

    • ON_CLASS_REQUEST

      public static final BoxEvent ON_CLASS_REQUEST

    • ON_SESSION_START

      public static final BoxEvent ON_SESSION_START

    • ON_SESSION_END

      public static final BoxEvent ON_SESSION_END

    • ON_ERROR

      public static final BoxEvent ON_ERROR

    • ON_MISSING_TEMPLATE

      public static final BoxEvent ON_MISSING_TEMPLATE

    • ON_ABORT

      public static final BoxEvent ON_ABORT

    • ON_REQUEST_CONTEXT_CONFIG

      public static final BoxEvent ON_REQUEST_CONTEXT_CONFIG
      Request Context Events

    • PRE_TEMPLATE_INVOKE

      public static final BoxEvent PRE_TEMPLATE_INVOKE
      Template Invocations

    • POST_TEMPLATE_INVOKE

      public static final BoxEvent POST_TEMPLATE_INVOKE

    • PRE_FUNCTION_INVOKE

      public static final BoxEvent PRE_FUNCTION_INVOKE
      Function Invocations

    • POST_FUNCTION_INVOKE

      public static final BoxEvent POST_FUNCTION_INVOKE

    • ON_QUERY_BUILD

      public static final BoxEvent ON_QUERY_BUILD
      Query Invocations

    • PRE_QUERY_EXECUTE

      public static final BoxEvent PRE_QUERY_EXECUTE

    • POST_QUERY_EXECUTE

      public static final BoxEvent POST_QUERY_EXECUTE

    • QUERY_ADD_ROW

      public static final BoxEvent QUERY_ADD_ROW

    • ON_TRANSACTION_BEGIN

      public static final BoxEvent ON_TRANSACTION_BEGIN
      Transaction Events

    • ON_TRANSACTION_END

      public static final BoxEvent ON_TRANSACTION_END

    • ON_TRANSACTION_ACQUIRE

      public static final BoxEvent ON_TRANSACTION_ACQUIRE

    • ON_TRANSACTION_RELEASE

      public static final BoxEvent ON_TRANSACTION_RELEASE

    • ON_TRANSACTION_COMMIT

      public static final BoxEvent ON_TRANSACTION_COMMIT

    • ON_TRANSACTION_ROLLBACK

      public static final BoxEvent ON_TRANSACTION_ROLLBACK

    • ON_TRANSACTION_SET_SAVEPOINT

      public static final BoxEvent ON_TRANSACTION_SET_SAVEPOINT

    • AFTER_CACHE_ELEMENT_INSERT

      public static final BoxEvent AFTER_CACHE_ELEMENT_INSERT
      Cache Store Events

    • BEFORE_CACHE_ELEMENT_REMOVED

      public static final BoxEvent BEFORE_CACHE_ELEMENT_REMOVED

    • AFTER_CACHE_ELEMENT_REMOVED

      public static final BoxEvent AFTER_CACHE_ELEMENT_REMOVED

    • AFTER_CACHE_ELEMENT_UPDATED

      public static final BoxEvent AFTER_CACHE_ELEMENT_UPDATED

    • AFTER_CACHE_CLEAR_ALL

      public static final BoxEvent AFTER_CACHE_CLEAR_ALL
      Cache Provider Events

    • AFTER_CACHE_REGISTRATION

      public static final BoxEvent AFTER_CACHE_REGISTRATION

    • AFTER_CACHE_REMOVAL

      public static final BoxEvent AFTER_CACHE_REMOVAL

    • BEFORE_CACHE_REMOVAL

      public static final BoxEvent BEFORE_CACHE_REMOVAL

    • BEFORE_CACHE_REPLACEMENT

      public static final BoxEvent BEFORE_CACHE_REPLACEMENT

    • BEFORE_CACHE_SHUTDOWN

      public static final BoxEvent BEFORE_CACHE_SHUTDOWN

    • AFTER_CACHE_SHUTDOWN

      public static final BoxEvent AFTER_CACHE_SHUTDOWN

    • AFTER_CACHE_SERVICE_STARTUP

      public static final BoxEvent AFTER_CACHE_SERVICE_STARTUP
      Cache Service Events

    • BEFORE_CACHE_SERVICE_SHUTDOWN

      public static final BoxEvent BEFORE_CACHE_SERVICE_SHUTDOWN

    • AFTER_CACHE_SERVICE_SHUTDOWN

      public static final BoxEvent AFTER_CACHE_SERVICE_SHUTDOWN

    • LOG_MESSAGE

      public static final BoxEvent LOG_MESSAGE
      Log Events

    • ON_DATASOURCE_SERVCE_STARTUP

      public static final BoxEvent ON_DATASOURCE_SERVCE_STARTUP
      Datasource Service Events

    • ON_DATASOURCE_SERVICE_SHUTDOWN

      public static final BoxEvent ON_DATASOURCE_SERVICE_SHUTDOWN

    • ON_DATASOURCE_STARTUP

      public static final BoxEvent ON_DATASOURCE_STARTUP

    • ON_SCHEDULER_STARTUP

      public static final BoxEvent ON_SCHEDULER_STARTUP
      Scheduler Events

    • ON_SCHEDULER_SHUTDOWN

      public static final BoxEvent ON_SCHEDULER_SHUTDOWN

    • ON_SCHEDULER_RESTART

      public static final BoxEvent ON_SCHEDULER_RESTART

    • SCHEDULER_BEFORE_ANY_TASK

      public static final BoxEvent SCHEDULER_BEFORE_ANY_TASK

    • SCHEDULER_AFTER_ANY_TASK

      public static final BoxEvent SCHEDULER_AFTER_ANY_TASK

    • SCHEDULER_ON_ANY_TASK_SUCCESS

      public static final BoxEvent SCHEDULER_ON_ANY_TASK_SUCCESS

    • SCHEDULER_ON_ANY_TASK_ERROR

      public static final BoxEvent SCHEDULER_ON_ANY_TASK_ERROR

    • ON_SCHEDULER_SERVICE_STARTUP

      public static final BoxEvent ON_SCHEDULER_SERVICE_STARTUP
      Scheduler Service Events

    • ON_SCHEDULER_SERVICE_SHUTDOWN

      public static final BoxEvent ON_SCHEDULER_SERVICE_SHUTDOWN

    • ON_ALL_SCHEDULERS_STARTED

      public static final BoxEvent ON_ALL_SCHEDULERS_STARTED

    • ON_SCHEDULER_REMOVAL

      public static final BoxEvent ON_SCHEDULER_REMOVAL

    • ON_SCHEDULER_REGISTRATION

      public static final BoxEvent ON_SCHEDULER_REGISTRATION

    • BEFORE_OBJECT_MARSHALL_SERIALIZE

      public static final BoxEvent BEFORE_OBJECT_MARSHALL_SERIALIZE
      Object Marshaller Events

    • AFTER_OBJECT_MARSHALL_SERIALIZE

      public static final BoxEvent AFTER_OBJECT_MARSHALL_SERIALIZE

    • BEFORE_OBJECT_MARSHALL_DESERIALIZE

      public static final BoxEvent BEFORE_OBJECT_MARSHALL_DESERIALIZE

    • AFTER_OBJECT_MARSHALL_DESERIALIZE

      public static final BoxEvent AFTER_OBJECT_MARSHALL_DESERIALIZE

    • ON_BXDUMP

      public static final BoxEvent ON_BXDUMP
      Dump Events

    • ON_MISSING_DUMP_OUTPUT

      public static final BoxEvent ON_MISSING_DUMP_OUTPUT

    • AFTER_MODULE_REGISTRATIONS

      public static final BoxEvent AFTER_MODULE_REGISTRATIONS
      Module Events

    • PRE_MODULE_REGISTRATION

      public static final BoxEvent PRE_MODULE_REGISTRATION

    • POST_MODULE_REGISTRATION

      public static final BoxEvent POST_MODULE_REGISTRATION

    • AFTER_MODULE_ACTIVATIONS

      public static final BoxEvent AFTER_MODULE_ACTIVATIONS

    • PRE_MODULE_LOAD

      public static final BoxEvent PRE_MODULE_LOAD

    • POST_MODULE_LOAD

      public static final BoxEvent POST_MODULE_LOAD

    • PRE_MODULE_UNLOAD

      public static final BoxEvent PRE_MODULE_UNLOAD

    • POST_MODULE_UNLOAD

      public static final BoxEvent POST_MODULE_UNLOAD

    • ON_HTTP_REQUEST

      public static final BoxEvent ON_HTTP_REQUEST
      HTTP Events

    • ON_HTTP_RAW_RESPONSE

      public static final BoxEvent ON_HTTP_RAW_RESPONSE

    • ON_HTTP_RESPONSE

      public static final BoxEvent ON_HTTP_RESPONSE

    • ON_MODULE_SERVICE_STARTUP

      public static final BoxEvent ON_MODULE_SERVICE_STARTUP
      Module Service Events

    • ON_MODULE_SERVICE_SHUTDOWN

      public static final BoxEvent ON_MODULE_SERVICE_SHUTDOWN

  • Method Details

    • values

      public static BoxEvent[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static BoxEvent valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • key

      public Key key()
      Returns the key representing the event name.
      Returns:
      The key representing the event name.

    • toArray

      public static Key[] toArray()
      Returns an array of all the event keys.
      Returns:
      An array of all the event keys.