Package com.tnsai.hooks.events

Record Class OnSessionIdle

java.lang.Object
java.lang.Record
com.tnsai.hooks.events.OnSessionIdle
Record Components:
eventId - ULID-shaped correlation id
timestamp - when the idle threshold tripped
context - surrounding hook context
sessionId - framework session id
idleFor - how long the session has been idle
suggestedAction - framework's recommendation
All Implemented Interfaces:
HookEvent, SessionHookEvent
public record OnSessionIdle(String eventId, Instant timestamp, HookContext context, String sessionId, Duration idleFor, IdleAction suggestedAction) extends Record implements SessionHookEvent
Fires when a session has been idle past the configured threshold (issue #63). The suggestedAction is the framework's default (IdleAction.WARN → IdleAction.SUSPEND → IdleAction.CLOSE as the idle duration grows). Hooks can override the action via withSuggestedAction(IdleAction) or Block to refuse the suggestion (e.g. high-priority sessions never auto-close).
Since:
0.5.0 (issue #63)

  • Constructor Details

    • OnSessionIdle

      public OnSessionIdle(String eventId, Instant timestamp, HookContext context, String sessionId, Duration idleFor, IdleAction suggestedAction)
      Creates an instance of a OnSessionIdle 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
      sessionId - the value for the sessionId record component
      idleFor - the value for the idleFor record component
      suggestedAction - the value for the suggestedAction 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

    • withSuggestedAction

      public OnSessionIdle withSuggestedAction(IdleAction newAction)
      Build a copy with newAction replacing suggestedAction. Used by Modify hooks that override the idle-policy default per-session.

    • 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

    • sessionId

      public String sessionId()
      Returns the value of the sessionId record component.
      Returns:
      the value of the sessionId record component

    • idleFor

      public Duration idleFor()
      Returns the value of the idleFor record component.
      Returns:
      the value of the idleFor record component

    • suggestedAction

      public IdleAction suggestedAction()
      Returns the value of the suggestedAction record component.
      Returns:
      the value of the suggestedAction record component