Package org.springframework.security.core.context

Interface SecurityContextHolderStrategy

All Known Implementing Classes:

ListeningSecurityContextHolderStrategy

public interface SecurityContextHolderStrategy

A strategy for storing security context information against a thread.

The preferred strategy is loaded by SecurityContextHolder.

Method Summary

Modifier and Type	Method	Description
void	clearContext()	Clears the current context.
SecurityContext	createEmptyContext()	Creates a new, empty context implementation, for use by SecurityContextRepository implementations, when creating a new context for the first time.
SecurityContext	getContext()	Obtains the current context.
void	setContext(SecurityContext context)	Sets the current context.

Method Detail

clearContext

void clearContext()

Clears the current context.

getContext

SecurityContext getContext()

Obtains the current context.

Returns:

a context (never null - create a default implementation if necessary)

setContext

void setContext(SecurityContext context)

Sets the current context.

Parameters:

context - to the new argument (should never be null, although implementations must check if null has been passed and throw an IllegalArgumentException in such cases)

createEmptyContext

SecurityContext createEmptyContext()

Creates a new, empty context implementation, for use by SecurityContextRepository implementations, when creating a new context for the first time.

Returns:

the empty context.