Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractSessionEvent - Class in io.micronaut.session.event
- AbstractSessionEvent(Session) - Constructor for class io.micronaut.session.event.AbstractSessionEvent
-
Constructs a prototypical Event.
- argumentType() - Method in class io.micronaut.session.binder.OptionalSessionArgumentBinder
- argumentType() - Method in class io.micronaut.session.binder.OptionalSessionValueArgumentBinder
- argumentType() - Method in class io.micronaut.session.binder.SessionArgumentBinder
- attributeMap - Variable in class io.micronaut.session.InMemorySession
- attributes - Variable in class io.micronaut.session.InMemorySession
B
- bind(ArgumentConversionContext<Session>, HttpRequest<?>) - Method in class io.micronaut.session.binder.SessionArgumentBinder
- bind(ArgumentConversionContext<Object>, HttpRequest<?>) - Method in class io.micronaut.session.binder.SessionValueArgumentBinder
- bind(ArgumentConversionContext<Optional<Session>>, HttpRequest<?>) - Method in class io.micronaut.session.binder.OptionalSessionArgumentBinder
- bind(ArgumentConversionContext<Optional>, HttpRequest<?>) - Method in class io.micronaut.session.binder.OptionalSessionValueArgumentBinder
- build(String, String) - Method in class io.micronaut.session.http.SessionLogElementBuilder
C
- clear() - Method in class io.micronaut.session.InMemorySession
- CookieHttpSessionIdGenerator - Class in io.micronaut.session.http
-
Utility to generate a session id from a cookie value or builds a cookie value from session.
- CookieHttpSessionIdGenerator(HttpSessionConfiguration) - Constructor for class io.micronaut.session.http.CookieHttpSessionIdGenerator
-
Constructor.
- CookieHttpSessionStrategy - Class in io.micronaut.session.http
-
Resolves
Session
identifiers from cookies. - CookieHttpSessionStrategy(HttpSessionConfiguration) - Constructor for class io.micronaut.session.http.CookieHttpSessionStrategy
-
Constructor.
- CookieHttpSessionStrategy(HttpSessionConfiguration, CookieHttpSessionIdGenerator) - Constructor for class io.micronaut.session.http.CookieHttpSessionStrategy
-
Constructor.
- cookieValueFromSession(Session) - Method in class io.micronaut.session.http.CookieHttpSessionIdGenerator
- copy() - Method in class io.micronaut.session.http.SessionLogElement
- create(SessionStore, HttpRequest<?>) - Static method in class io.micronaut.session.http.SessionForRequest
-
Creates a session and stores it in the request attributes.
D
- DEFAULT_BASE64ENCODE - Static variable in class io.micronaut.session.http.HttpSessionConfiguration
-
The default base64 encode value.
- DEFAULT_COOKIENAME - Static variable in class io.micronaut.session.http.HttpSessionConfiguration
-
Cookie name.
- DEFAULT_COOKIEPATH - Static variable in class io.micronaut.session.http.HttpSessionConfiguration
-
Default Cookie Path.
- DEFAULT_MAXINACTIVEINTERVAL_MINUTES - Static variable in class io.micronaut.session.SessionConfiguration
-
The default max inactive interval in minutes.
- DEFAULT_REMEMBERME - Static variable in class io.micronaut.session.http.HttpSessionConfiguration
-
The default remember me value.
- DefaultSessionIdGenerator - Class in io.micronaut.session
-
Default session ID generator that uses
UUID
. - DefaultSessionIdGenerator() - Constructor for class io.micronaut.session.DefaultSessionIdGenerator
- defaultValue() - Element in annotation interface io.micronaut.session.annotation.SessionValue
- deleteSession(String) - Method in class io.micronaut.session.InMemorySessionStore
- deleteSession(String) - Method in interface io.micronaut.session.SessionStore
-
Delete a session for the given ID.
- doFilter(HttpRequest<?>, ServerFilterChain) - Method in class io.micronaut.session.http.HttpSessionFilter
E
- encodeId(HttpRequest<?>, MutableHttpResponse<?>, Session) - Method in class io.micronaut.session.http.CookieHttpSessionStrategy
- encodeId(HttpRequest<?>, MutableHttpResponse<?>, Session) - Method in class io.micronaut.session.http.HeadersHttpSessionIdStrategy
- encodeId(HttpRequest<?>, MutableHttpResponse<?>, Session) - Method in interface io.micronaut.session.http.HttpSessionIdEncoder
-
Encode the given Session into the response.
- events() - Method in class io.micronaut.session.http.SessionLogElement
F
- find(HttpRequest<?>) - Static method in class io.micronaut.session.http.SessionForRequest
-
Finds a session.
- findOrCreate(HttpRequest<?>, SessionStore) - Static method in class io.micronaut.session.http.SessionForRequest
-
Finds a session or creates a new one and stores it in the request attributes.
- findSession(String) - Method in class io.micronaut.session.InMemorySessionStore
- findSession(String) - Method in interface io.micronaut.session.SessionStore
-
Find a session for the given ID.
G
- generateId() - Method in class io.micronaut.session.DefaultSessionIdGenerator
- generateId() - Method in interface io.micronaut.session.SessionIdGenerator
- get(CharSequence) - Method in interface io.micronaut.session.Session
-
Retrieve an attribute for the given name.
- get(CharSequence, ArgumentConversionContext<T>) - Method in class io.micronaut.session.InMemorySession
- getAnnotationType() - Method in class io.micronaut.session.binder.OptionalSessionValueArgumentBinder
- getAnnotationType() - Method in class io.micronaut.session.binder.SessionValueArgumentBinder
- getConfiguration() - Method in class io.micronaut.session.http.CookieHttpSessionStrategy
- getCookieDomain() - Method in class io.micronaut.session.http.HttpSessionConfiguration
- getCookieMaxAge() - Method in class io.micronaut.session.http.HttpSessionConfiguration
- getCookieName() - Method in class io.micronaut.session.http.HttpSessionConfiguration
- getCookiePath() - Method in class io.micronaut.session.http.HttpSessionConfiguration
- getCookieSameSite() - Method in class io.micronaut.session.http.HttpSessionConfiguration
- getCreationTime() - Method in class io.micronaut.session.InMemorySession
- getCreationTime() - Method in interface io.micronaut.session.Session
-
Returns the time when this session was created.
- getDomainName() - Method in class io.micronaut.session.http.HttpSessionConfiguration
- getExecutorService() - Method in class io.micronaut.session.SessionConfiguration
- getHeaderNames() - Method in class io.micronaut.session.http.HeadersHttpSessionIdStrategy
- getHeaderNames() - Method in class io.micronaut.session.http.HttpSessionConfiguration
- getId() - Method in class io.micronaut.session.InMemorySession
- getId() - Method in interface io.micronaut.session.Session
-
A unique identifier for the session.
- getLastAccessedTime() - Method in class io.micronaut.session.InMemorySession
- getLastAccessedTime() - Method in interface io.micronaut.session.Session
-
Returns the last time the client sent a request associated with this session as an
Instant
. - getMaxActiveSessions() - Method in class io.micronaut.session.SessionConfiguration
- getMaxInactiveInterval() - Method in class io.micronaut.session.InMemorySession
- getMaxInactiveInterval() - Method in interface io.micronaut.session.Session
-
Returns the maximum time interval as a
Duration
that sessions will be kept open between client accesses. - getMaxInactiveInterval() - Method in class io.micronaut.session.SessionConfiguration
- getOrder() - Method in class io.micronaut.session.http.HttpSessionFilter
- getPrefix() - Method in class io.micronaut.session.http.CookieHttpSessionIdGenerator
- getPrefix() - Method in class io.micronaut.session.http.HttpSessionConfiguration
- getSource() - Method in class io.micronaut.session.event.AbstractSessionEvent
H
- HeadersHttpSessionIdStrategy - Class in io.micronaut.session.http
-
Implementation that uses common HTTP headers to resolve the
Session
ID. - HeadersHttpSessionIdStrategy(HttpSessionConfiguration) - Constructor for class io.micronaut.session.http.HeadersHttpSessionIdStrategy
-
Constructor.
- HTTP - Static variable in interface io.micronaut.session.SessionSettings
-
The property name for HTTP session configuration.
- HTTP_COOKIE_STRATEGY - Static variable in interface io.micronaut.session.SessionSettings
-
The property name for HTTP session cookie configuration.
- HTTP_HEADER_STRATEGY - Static variable in interface io.micronaut.session.SessionSettings
-
The property name for HTTP session header configuration.
- HttpSessionConfiguration - Class in io.micronaut.session.http
-
Allows configuration of the session.
- HttpSessionConfiguration() - Constructor for class io.micronaut.session.http.HttpSessionConfiguration
- HttpSessionFilter - Class in io.micronaut.session.http
-
A
HttpServerFilter
that resolves the current userSession
if present and encodes the Session ID in the response. - HttpSessionFilter(SessionStore<Session>, HttpSessionIdResolver[], HttpSessionIdEncoder[]) - Constructor for class io.micronaut.session.http.HttpSessionFilter
-
Constructor.
- HttpSessionIdEncoder - Interface in io.micronaut.session.http
-
Strategy interface for encoding
Session
IDs so they are represented in the response. - HttpSessionIdResolver - Interface in io.micronaut.session.http
-
Strategy interface for resolving
Session
IDs. - HttpSessionIdStrategy - Interface in io.micronaut.session.http
-
Combines
HttpSessionIdResolver
andHttpSessionIdEncoder
.
I
- InMemorySession - Class in io.micronaut.session
-
A
Session
that is help in-memory. - InMemorySession(String, Duration) - Constructor for class io.micronaut.session.InMemorySession
-
Constructor.
- InMemorySession(String, Instant, Duration) - Constructor for class io.micronaut.session.InMemorySession
-
Constructor.
- InMemorySessionStore - Class in io.micronaut.session
-
Default implementation that stores sessions in-memory.
- InMemorySessionStore(SessionIdGenerator, SessionConfiguration, ApplicationEventPublisher<? super AbstractSessionEvent>) - Constructor for class io.micronaut.session.InMemorySessionStore
-
Constructor.
- io.micronaut.session - package io.micronaut.session
-
Micronaut session handling.
- io.micronaut.session.annotation - package io.micronaut.session.annotation
-
Micronaut session annotations.
- io.micronaut.session.binder - package io.micronaut.session.binder
-
Session argument and value binding.
- io.micronaut.session.event - package io.micronaut.session.event
-
Session events that are fired in the lifecycle.
- io.micronaut.session.http - package io.micronaut.session.http
-
HTTP session configuration and strategies.
- io.micronaut.session.websocket - package io.micronaut.session.websocket
-
Classes specific to WebSocket's and sessions.
- isBase64Decode() - Method in class io.micronaut.session.http.CookieHttpSessionIdGenerator
- isBase64Encode() - Method in class io.micronaut.session.http.HttpSessionConfiguration
- isCookieHttpOnly() - Method in class io.micronaut.session.http.HttpSessionConfiguration
- isCookieSecure() - Method in class io.micronaut.session.http.HttpSessionConfiguration
- isExpired() - Method in interface io.micronaut.session.Session
- isModified() - Method in class io.micronaut.session.InMemorySession
- isModified() - Method in interface io.micronaut.session.Session
- isNew() - Method in class io.micronaut.session.InMemorySession
- isNew() - Method in interface io.micronaut.session.Session
- isPromptExpiration() - Method in class io.micronaut.session.SessionConfiguration
- isRememberMe() - Method in class io.micronaut.session.http.HttpSessionConfiguration
L
- lastAccessTime - Variable in class io.micronaut.session.InMemorySession
N
- names() - Method in class io.micronaut.session.InMemorySession
- newSession() - Method in class io.micronaut.session.InMemorySessionStore
- newSession() - Method in interface io.micronaut.session.SessionStore
-
Create a new unsaved session.
- newSessionCache(SessionConfiguration) - Method in class io.micronaut.session.InMemorySessionStore
-
Creates a new session cache.
O
- onApplicationEvent(WebSocketEvent) - Method in class io.micronaut.session.websocket.SessionWebSocketEventListener
- onResponseHeaders(ChannelHandlerContext, HttpHeaders, String) - Method in class io.micronaut.session.http.SessionLogElement
- OptionalSessionArgumentBinder - Class in io.micronaut.session.binder
- OptionalSessionArgumentBinder() - Constructor for class io.micronaut.session.binder.OptionalSessionArgumentBinder
- OptionalSessionValueArgumentBinder - Class in io.micronaut.session.binder
- OptionalSessionValueArgumentBinder() - Constructor for class io.micronaut.session.binder.OptionalSessionValueArgumentBinder
- ORDER - Static variable in class io.micronaut.session.http.HttpSessionFilter
-
The order of the filter.
P
- PREFIX - Static variable in interface io.micronaut.session.SessionSettings
-
The prefix to use for all session configuration.
- put(CharSequence, Object) - Method in class io.micronaut.session.InMemorySession
R
- remove(CharSequence) - Method in class io.micronaut.session.InMemorySession
- resolve(HttpRequest<?>) - Method in class io.micronaut.session.http.SessionLocaleResolver
- resolveIds(HttpRequest<?>) - Method in class io.micronaut.session.http.CookieHttpSessionStrategy
- resolveIds(HttpRequest<?>) - Method in class io.micronaut.session.http.HeadersHttpSessionIdStrategy
- resolveIds(HttpRequest<?>) - Method in interface io.micronaut.session.http.HttpSessionIdResolver
-
Resolve the Session ID from the given HTTP message.
S
- save(InMemorySession) - Method in class io.micronaut.session.InMemorySessionStore
- save(S) - Method in interface io.micronaut.session.SessionStore
-
Save the given session.
- Session - Interface in io.micronaut.session
-
An interface representing a user session.
- SESSION - Static variable in class io.micronaut.session.http.SessionLogElement
-
The session marker.
- SESSION_ATTRIBUTE - Static variable in class io.micronaut.session.http.HttpSessionFilter
-
Constant for Micronaut SESSION attribute.
- SessionArgumentBinder - Class in io.micronaut.session.binder
-
Binds an argument of type
Session
for controllers. - SessionArgumentBinder(SessionStore<Session>) - Constructor for class io.micronaut.session.binder.SessionArgumentBinder
-
Constructor.
- SessionConfiguration - Class in io.micronaut.session
-
Base configuration properties for session handling.
- SessionConfiguration() - Constructor for class io.micronaut.session.SessionConfiguration
- SessionCreatedEvent - Class in io.micronaut.session.event
-
Fired when a session is created.
- SessionCreatedEvent(Session) - Constructor for class io.micronaut.session.event.SessionCreatedEvent
-
Constructs a Session created event.
- SessionDeletedEvent - Class in io.micronaut.session.event
-
Fired when an
Session
is deleted. - SessionDeletedEvent(Session) - Constructor for class io.micronaut.session.event.SessionDeletedEvent
-
Constructs a prototypical Event.
- SessionDestroyedEvent - Class in io.micronaut.session.event
-
Fired when a session is destroyed.
- SessionDestroyedEvent(Session) - Constructor for class io.micronaut.session.event.SessionDestroyedEvent
-
Constructs a Session destroyed event.
- SessionExpiredEvent - Class in io.micronaut.session.event
-
Fired when a
Session
expires. - SessionExpiredEvent(Session) - Constructor for class io.micronaut.session.event.SessionExpiredEvent
-
Constructs a Session expired event.
- SessionForRequest - Class in io.micronaut.session.http
-
Utility class with methods to create or retrieve a session associated to a request.
- SessionForRequest() - Constructor for class io.micronaut.session.http.SessionForRequest
- sessionIdFromCookie(Cookie) - Method in class io.micronaut.session.http.CookieHttpSessionIdGenerator
- SessionIdGenerator - Interface in io.micronaut.session
-
Strategy interface for generating
Session
IDs. - SessionLocaleResolver - Class in io.micronaut.session.http
-
Resolves the locale from a property in a session.
- SessionLocaleResolver(HttpLocaleResolutionConfiguration) - Constructor for class io.micronaut.session.http.SessionLocaleResolver
- SessionLogElement - Class in io.micronaut.session.http
-
SessionLogElement LogElement.
- SessionLogElementBuilder - Class in io.micronaut.session.http
-
Builder for SessionLogElement.
- SessionLogElementBuilder() - Constructor for class io.micronaut.session.http.SessionLogElementBuilder
- SessionSettings - Interface in io.micronaut.session
-
Settings for session configuration.
- SessionStore<S extends Session> - Interface in io.micronaut.session
-
Interface for locating and saving sessions.
- SessionValue - Annotation Interface in io.micronaut.session.annotation
-
Used to bind value from a
Session
. - SessionValueArgumentBinder - Class in io.micronaut.session.binder
-
Handles binding of the
SessionValue
annotation. - SessionValueArgumentBinder() - Constructor for class io.micronaut.session.binder.SessionValueArgumentBinder
- SessionWebSocketEventListener - Class in io.micronaut.session.websocket
-
Persists the session in the background on web socket events.
- setBase64Encode(boolean) - Method in class io.micronaut.session.http.HttpSessionConfiguration
-
Default value (true).
- setCookieDomain(String) - Method in class io.micronaut.session.http.HttpSessionConfiguration
- setCookieMaxAge(TemporalAmount) - Method in class io.micronaut.session.http.HttpSessionConfiguration
-
Sets the maximum age of the cookie.
- setCookieName(String) - Method in class io.micronaut.session.http.HttpSessionConfiguration
-
Default value ("SESSION").
- setCookiePath(String) - Method in class io.micronaut.session.http.HttpSessionConfiguration
- setCookieSameSite(SameSite) - Method in class io.micronaut.session.http.HttpSessionConfiguration
-
Determines if this this
Cookie
can be sent along cross-site requests. - setCookieSecure(Boolean) - Method in class io.micronaut.session.http.HttpSessionConfiguration
-
Sets the secure status of the cookie.
- setDomainName(String) - Method in class io.micronaut.session.http.HttpSessionConfiguration
- setExecutorService(BeanProvider<ExecutorService>) - Method in class io.micronaut.session.SessionConfiguration
-
Set the executor service.
- setHeaderNames(String[]) - Method in class io.micronaut.session.http.HttpSessionConfiguration
-
Default values (["Authorization-Info", "X-Auth-Token"]).
- setLastAccessedTime(Instant) - Method in class io.micronaut.session.InMemorySession
- setLastAccessedTime(Instant) - Method in interface io.micronaut.session.Session
-
Sets the last accessed time on the session.
- setMaxActiveSessions(Integer) - Method in class io.micronaut.session.SessionConfiguration
-
Sets the maximum number of active sessions.
- setMaxInactiveInterval(Duration) - Method in class io.micronaut.session.InMemorySession
- setMaxInactiveInterval(Duration) - Method in interface io.micronaut.session.Session
-
Specifies the duration between client requests before session should be invalidated.
- setMaxInactiveInterval(Duration) - Method in class io.micronaut.session.SessionConfiguration
-
Set the maximum inactive interval.
- setNew(boolean) - Method in class io.micronaut.session.InMemorySession
- setPrefix(String) - Method in class io.micronaut.session.http.HttpSessionConfiguration
- setPromptExpiration(boolean) - Method in class io.micronaut.session.SessionConfiguration
-
Set if prompt expiration is enabled.
- setRememberMe(boolean) - Method in class io.micronaut.session.http.HttpSessionConfiguration
-
Default value (false).
T
- toString() - Method in class io.micronaut.session.http.SessionLogElement
V
- value() - Element in annotation interface io.micronaut.session.annotation.SessionValue
- values() - Method in class io.micronaut.session.InMemorySession
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form