Class Session

java.lang.Object

uno.anahata.asi.agi.tool.ToolContext

uno.anahata.asi.agi.tool.AnahataToolkit

uno.anahata.asi.toolkit.Session

All Implemented Interfaces:

ContextProvider, PropertyChangeSource, Rebindable

public class Session
extends AnahataToolkit

The definitive toolkit for managing the current agi session's metadata, tool capabilities, and context pruning policies.

This toolkit provides high-level control over the session environment, allowing the model to optimize its own context window, toggle available toolkits, and manage the lifecycle of stateful resources.

Author:

anahata-ai

Field Summary

Fields

Modifier and Type	Field	Description
private Date	sessionRestored	The last time the session got deserialized.
private Date	sessionStart	The time when the session started.

Fields inherited from class AnahataToolkit

childrenProviders, propertyChangeSupport

Modifier and Type	Field	Description
protected List<ContextProvider>	childrenProviders	The list of child context providers managed by this toolkit.
protected PropertyChangeSupport	propertyChangeSupport	Support for firing property change events.

Fields inherited from class ToolContext

toolkit

Modifier and Type	Field	Description
protected JavaObjectToolkit	toolkit	The toolkit instance that owns this context.

Constructor Summary

Constructors

Constructor	Description
Session()

Method Summary

Modifier and Type	Method	Description
String	enableHostedTools()	Switches the session to server-side tool mode.
List<String>	getSystemInstructions()	Gets a list of system instruction strings provided by this context provider.
String	killRunningTools(List<Long> toolCallIds)	Signals one or more currently executing background tools to stop.
void	populateMessage(RagMessage ragMessage)	Populates the RAG message with comprehensive session metadata.
void	postActivate()	Captures the sessionRestored time during deserialization;
void	setContextProviderProviding(boolean providing, List<String> providerIds)	Enables or disables specific context providers within the session hierarchy.
void	setToolkitEnabled(boolean enabled, List<String> toolkitNames)	Enables or disables multiple toolkits by their names.
String	updateSessionNickname(String nickName)	Updates the AGIs nickname.
String	updateSessionSummary(String summary)	Updates the human-readable summary of the current session.

Methods inherited from class AnahataToolkit

getChildrenProviders, getDescription, getId, getName, getParentProvider, getPropertyChangeSupport, initialize, isEffectivelyProviding, rebind

Modifier and Type	Method	Description
List<ContextProvider>	getChildrenProviders()	Gets the list of immediate child context providers.
String	getDescription()	Gets a detailed description of what this context provider does.
String	getId()	Gets the unique identifier for this context provider.
String	getName()	Gets the human-readable name of this context provider.
ContextProvider	getParentProvider()	Gets the parent context provider in the hierarchy, if any.
PropertyChangeSupport	getPropertyChangeSupport()	Gets the PropertyChangeSupport instance for this object.
void	initialize()	Performs initial setup for a newly created toolkit instance.
boolean	isEffectivelyProviding()	Override to also take into consideration the AbstractToolkit.enabled
void	rebind()	Rebinds the toolkit after deserialization.

Methods inherited from class ToolContext

addAttachment, addAttachment, addAttachment, error, getAgi, getApplicationMap, getAsiContainer, getAsiContainerMap, getCall, getExecutorService, getModelId, getModelMessage, getResourceManager, getResponse, getSessionMap, getThreadSafeLogger, getTool, getToolContext, getToolkit, getToolManager, getTurnMap, isToolExecution, log, peekResponse, runAsync

Modifier and Type	Method	Description
void	addAttachment(byte[] data, String mimeType)	Attaches a binary blob to the current tool's response.
void	addAttachment(File file)	Convenience method to attach a file to the current tool's response.
void	addAttachment(Path path)	Convenience method to attach a file from a Path to the current tool's response.
void	error(String message)	Adds an error message to the current tool's response.
Agi	getAgi()	Convenience method to get the parent agi container for the current execution.
Map	getApplicationMap()	Gets a static, application-scoped map for sharing objects across all containers in the current JVM.
AbstractAsiContainer	getAsiContainer()	Gets the current ASI container hosting this Agi container is running.
Map	getAsiContainerMap()	Gets a map for sharing objects across all sessions within the current ASI container.
JavaMethodToolCall	getCall()	Convenience method to get the current tool call that initiated this execution.
ExecutorService	getExecutorService()	Convenience method to get the executor service for the current agi session.
String	getModelId()	The id of model that is executing the tool.
AbstractModelMessage	getModelMessage()	The id of model that is executing the tool.
ResourceManager	getResourceManager()	Convenience method to get the application's ResourceManager.
JavaMethodToolResponse	getResponse()	Gets the current tool response from the thread-local context.
Map	getSessionMap()	Gets a shared map for storing state across turns within the current agi session.
Consumer<String>	getThreadSafeLogger()	Gets a thread-safe logging consumer that automatically propagates the current tool execution context whenever a message is logged.
JavaMethodTool	getTool()	Convenience method to get the metadata for the tool currently being executed.
ToolContext	getToolContext()	Returns a thread-safe snapshot of this context.
<T> T	getToolkit(Class<T> toolkitClass)	Retrieves the singleton instance of a registered toolkit class.
ToolManager	getToolManager()	Convenience method to get the application's global ToolManager.
Map	getTurnMap()	Gets a shared map for storing state across turns within the current agi session.
boolean	isToolExecution()	Checks if the current thread or this context instance is associated with an active tool execution.
void	log(String message)	Adds a standard log message to the current tool's response.
protected JavaMethodToolResponse	peekResponse()	Internal helper to retrieve the response if it exists, without throwing an exception.
void	runAsync(String taskName, Runnable task)	Executes a task asynchronously in the session's executor service, automatically propagating the current tool execution context to the background thread.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ContextProvider

getAgi, getContextPosition, getFlattenedHierarchy, getFullyQualifiedId, getHeader, getIconId, getInstructionsTokenCount, getRagTokenCount, isProviding, setParentProvider, setProviding

Modifier and Type	Method	Description
Agi	getAgi()	Gets the parent AGI session this context provider is registered under.
default ContextPosition	getContextPosition()	Gets the designated position of this provider's content in the AI prompt.
default List<ContextProvider>	getFlattenedHierarchy(boolean providingOnly)	Gets a flattened list of this provider and all its descendants in the hierarchy.
default String	getFullyQualifiedId()	Gets the fully qualified ID of this provider, reflecting its position in the hierarchy.
default String	getHeader()	Generates a machine-readable header string for this context provider, used to identify the source of injected context in the final prompt.
default String	getIconId()	Gets an optional icon identifier for this provider.
default int	getInstructionsTokenCount()	Calculates the token count for the system instructions provided by this instance using the active model.
default int	getRagTokenCount()	Calculates the token count for the RAG content provided by this instance using the active model.
boolean	isProviding()	Checks if this context provider is currently active and providing context.
default void	setParentProvider(ContextProvider parent)	Sets the parent context provider for this instance.
default void	setProviding(boolean enabled)	Sets whether this context provider is enabled.

Field Details

sessionStart

private Date sessionStart

The time when the session started.

sessionRestored

private Date sessionRestored

The last time the session got deserialized.

Constructor Details

Session

public Session()

Method Details

postActivate

public void postActivate()

Captures the sessionRestored time during deserialization;

Overrides:

postActivate in class AnahataToolkit

getSystemInstructions

public List<String> getSystemInstructions()
                                   throws Exception

Description copied from interface: ContextProvider

Gets a list of system instruction strings provided by this context provider. These are typically prepended to the conversation as high-level guidance.

Returns:

A list of system instruction strings.

Throws:

Exception - if an error occurs during instruction generation.

updateSessionNickname

public String updateSessionNickname(String nickName)

Updates the AGIs nickname.

Parameters:

nickName - the new nickname

Returns:

a confirmation message

updateSessionSummary

public String updateSessionSummary(String summary)

Updates the human-readable summary of the current session.

STRICT USAGE RULE: This tool MUST ONLY be called if there are other "task-related" tool calls (e.g., file manipulation, shell commands, pruning) being made in the same turn. It should NEVER be called as the sole tool in a turn.

The summary is visible to the user in the container dashboard and the parent agi if spawned by another agi.

Parameters:

summary - A concise summary of the conversation's current state or topic.

Returns:

A confirmation message.

setContextProviderProviding

public void setContextProviderProviding(boolean providing,
 List<String> providerIds)

Enables or disables specific context providers within the session hierarchy.

This tool allows the model to surgically control which providers contribute to the RAG message, helping to reduce noise and optimize token usage.

Parameters:

providing - Whether to enable or disable the providers.

providerIds - The fully qualified IDs of the context providers to update.

setToolkitEnabled

public void setToolkitEnabled(boolean enabled,
 List<String> toolkitNames)

Enables or disables multiple toolkits by their names.

Disabling a toolkit makes its tools invisible to the model and can reduce complexity when certain capabilities are no longer needed.

Parameters:

enabled - Whether to enable or disable the toolkits.

toolkitNames - The names (IDs) of the toolkits to update (e.g., 'Audio', 'Chrome').

killRunningTools

public String killRunningTools(List<Long> toolCallIds)

Signals one or more currently executing background tools to stop.

This is useful for cancelling long-running tasks like large file reads, complex shell commands, or audio recording.

Parameters:

toolCallIds - The unique IDs of the tool calls to stop.

Returns:

A detailed report of the stopping operations.

enableHostedTools

public String enableHostedTools()

Switches the session to server-side tool mode.

CRITICAL: After calling this, local Java tools are disabled until manually re-enabled by the user. Use this only when a capability provided by the model host (e.g., Google Search) is explicitly required.

Returns:

Confirmation message describing the impact.

populateMessage

public void populateMessage(RagMessage ragMessage)
                     throws Exception

Populates the RAG message with comprehensive session metadata.

Provides a Markdown summary of session identity, model configuration, context window usage, and the status of executing tools.

Parameters:

ragMessage - The target RAG message.

Throws:

Exception - if metadata extraction fails.