Package com.tnsai.hooks.events

Record Class PreAction

java.lang.Object
java.lang.Record
com.tnsai.hooks.events.PreAction
Record Components:
eventId - ULID-shaped correlation id
timestamp - when the event was constructed
context - surrounding hook context
request - typed request about to be dispatched — Modify-able
type - dispatch channel (LLM, TOOL, …)
All Implemented Interfaces:
ActionHookEvent, HookEvent
public record PreAction(String eventId, Instant timestamp, HookContext context, ActionRequest request, ActionType type) extends Record implements ActionHookEvent
Fires before ActionExecutor routes any action (issue #59). Carries the typed ActionRequest and the resolved ActionType so hooks can match on dispatch channel (LLM / MCP_TOOL / WEB_SERVICE / LOCAL) and branch policy per-channel.

Hooks may Block the action outright (tenant quota hit, cost budget exceeded) or Modify the request's parameters via withRequest(ActionRequest) (argument scrub, policy-driven rewrite).

Since:
0.5.0 (issue #59)

  • Constructor Details

    • PreAction

      public PreAction(String eventId, Instant timestamp, HookContext context, ActionRequest request, ActionType type)
      Creates an instance of a PreAction record class.
      Parameters:
      eventId - the value for the eventId record component
      timestamp - the value for the timestamp record component
      context - the value for the context record component
      request - the value for the request record component
      type - the value for the type record component

  • Method Details

    • eventType

      public String eventType()
      Description copied from interface: HookEvent
      Short stable string identifier of the event kind, e.g. "PreToolUse". Default implementation derives it from the concrete record's simple class name; concrete records may override if a different naming is desirable.
      Specified by:
      eventType in interface HookEvent

    • withRequest

      public PreAction withRequest(ActionRequest newRequest)
      Build a copy with newRequest replacing request.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • eventId

      public String eventId()
      Returns the value of the eventId record component.
      Specified by:
      eventId in interface HookEvent
      Returns:
      the value of the eventId record component

    • timestamp

      public Instant timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface HookEvent
      Returns:
      the value of the timestamp record component

    • context

      public HookContext context()
      Returns the value of the context record component.
      Specified by:
      context in interface HookEvent
      Returns:
      the value of the context record component

    • request

      public ActionRequest request()
      Returns the value of the request record component.
      Returns:
      the value of the request record component

    • type

      public ActionType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component