Package org.springframework.ai.session

Class DefaultSessionService

java.lang.Object

org.springframework.ai.session.DefaultSessionService

All Implemented Interfaces:

SessionService

public final class DefaultSessionService
extends Object
implements SessionService

The SessionService on a SessionRepository.

Since:

2.1.0

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultSessionService.Builder

Method Summary

Modifier and Type	Method	Description
void	appendEvent(SessionEvent event)	Appends an event to the session named by SessionEvent.getSessionId().
static DefaultSessionService.Builder	builder()
CompactionResult	compact(String sessionId, CompactionTrigger trigger, CompactionStrategy strategy)	Evaluates the trigger on the active view and, when it fires, runs the strategy and records its result: one EventType.COMPACTION boundary event followed by the summary events, in one version-checked append.
Session	create(CreateSessionRequest request)	Creates a session with the request's id, a random UUID when it has none, its time to live and its metadata.
void	delete(String sessionId)	Deletes the session and its events.
int	deleteExpiredSessions(Instant before)	Deletes every session that expired before the given instant, with their events, and returns how many.
@Nullable Session	findById(String sessionId)
List<Session>	findByMetadata(String name, String value)	The sessions whose metadata holds value under name, oldest first, for the keys the store indexes; see SessionRepository.findByMetadata(java.lang.String, java.lang.String).
List<SessionEvent>	getEvents(String sessionId, EventFilter filter)	The events the filter selects, oldest first; see EventFilter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.session.SessionService

appendMessage, findOrCreate, getActiveMessages, getEvents, getMessages

Method Details

create

public Session create(CreateSessionRequest request)

Description copied from interface: SessionService

Creates a session with the request's id, a random UUID when it has none, its time to live and its metadata.

Specified by:

create in interface SessionService

findById

public @Nullable Session findById(String sessionId)

Specified by:

findById in interface SessionService

findByMetadata

public List<Session> findByMetadata(String name,
 String value)

Description copied from interface: SessionService

The sessions whose metadata holds value under name, oldest first, for the keys the store indexes; see SessionRepository.findByMetadata(java.lang.String, java.lang.String). The sessions of a principal are findByMetadata(SessionAttributes.PRINCIPAL_NAME, name).

Specified by:

findByMetadata in interface SessionService

delete

public void delete(String sessionId)

Description copied from interface: SessionService

Deletes the session and its events.

Specified by:

delete in interface SessionService

deleteExpiredSessions

public int deleteExpiredSessions(Instant before)

Description copied from interface: SessionService

Deletes every session that expired before the given instant, with their events, and returns how many. Nothing calls this on its own: call it from a scheduler, every hour for example.

Specified by:

deleteExpiredSessions in interface SessionService

appendEvent

public void appendEvent(SessionEvent event)

Description copied from interface: SessionService

Appends an event to the session named by SessionEvent.getSessionId().

Specified by:

appendEvent in interface SessionService

getEvents

public List<SessionEvent> getEvents(String sessionId,
 EventFilter filter)

Description copied from interface: SessionService

The events the filter selects, oldest first; see EventFilter.

Specified by:

getEvents in interface SessionService

compact

public CompactionResult compact(String sessionId,
 CompactionTrigger trigger,
 CompactionStrategy strategy)

Description copied from interface: SessionService

Evaluates the trigger on the active view and, when it fires, runs the strategy and records its result: one EventType.COMPACTION boundary event followed by the summary events, in one version-checked append. The log is never changed; the boundary defines the view from then on. An append that lands in between does not waste the summary: the new events join the view verbatim and the write is retried, a bounded number of times. Pass request -> true to compact unconditionally.

Specified by:

compact in interface SessionService

Returns:

the result as written, the events appended meanwhile added to its preserved tail; CompactionResult.isUnchanged() when nothing was written: the trigger did not fire, the strategy covered nothing, another compaction landed first, or appends kept overtaking the write

builder

public static DefaultSessionService.Builder builder()