Class SubjectClearingLogoutService<U>

java.lang.Object

com.svenruppert.jsentinel.logout.SubjectClearingLogoutService<U>

Type Parameters:

U - subject type (only used when scope is CurrentSession, for the SubjectStore wipe)

All Implemented Interfaces:

LogoutService

public final class SubjectClearingLogoutService<U>
extends Object
implements LogoutService

Adapter-neutral default LogoutService implementation.

Clears the current subject from the SubjectStore (when the scope is LogoutScope.CurrentSession), enumerates active sessions via the SubjectSessionRegistry, fans the notification out to every registered LogoutListener, and emits a LogoutPerformed audit event per logged-out session.

Listener exceptions are swallowed — a misbehaving listener cannot block the logout flow.

Constructor Summary

Constructors

Constructor	Description
SubjectClearingLogoutService(SubjectStore subjectStore, Class<U> subjectType)	Constructs a logout service that only clears the subject store; uses SubjectSessionRegistry no-op behaviour.
SubjectClearingLogoutService(SubjectStore subjectStore, Class<U> subjectType, SubjectSessionRegistry registry, JSentinelAuditService auditService)

Method Summary

Modifier and Type	Method	Description
void	addListener(LogoutListener listener)	Registers a listener that gets notified once per logged-out session id.
void	logout(SubjectId subjectId, LogoutScope scope)	Performs the logout.
void	removeListener(LogoutListener listener)	Removes a previously registered listener.

Methods inherited from class Object

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

Constructor Details

SubjectClearingLogoutService

public SubjectClearingLogoutService(SubjectStore subjectStore,
 Class<U> subjectType)

Constructs a logout service that only clears the subject store; uses SubjectSessionRegistry no-op behaviour. Suitable for applications that don't need multi-session logout.

Parameters:

subjectStore - subject store to clear on CurrentSession scope

subjectType - subject type token

SubjectClearingLogoutService

public SubjectClearingLogoutService(SubjectStore subjectStore,
 Class<U> subjectType,
 SubjectSessionRegistry registry,
 JSentinelAuditService auditService)

Parameters:

subjectStore - subject store to clear on CurrentSession scope

subjectType - subject type token

registry - session registry consulted for LogoutScope.AllSessionsOfSubject

auditService - audit sink, or null to resolve from JSentinelServiceResolver.securityAuditService() at logout time

Method Details

logout

public void logout(SubjectId subjectId,
 LogoutScope scope)

Description copied from interface: LogoutService

Performs the logout.

Specified by:

logout in interface LogoutService

Parameters:

subjectId - subject to log out; non-null

scope - scope of the logout; non-null

addListener

public void addListener(LogoutListener listener)

Description copied from interface: LogoutService

Registers a listener that gets notified once per logged-out session id. Idempotent — registering the same listener twice is a no-op.

Specified by:

addListener in interface LogoutService

Parameters:

listener - non-null

removeListener

public void removeListener(LogoutListener listener)

Description copied from interface: LogoutService

Removes a previously registered listener. No-op when the listener was never registered.

Specified by:

removeListener in interface LogoutService

Parameters:

listener - listener to remove