forked from jooby-project/jooby
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSessionStore.java
More file actions
186 lines (168 loc) · 5.65 KB
/
SessionStore.java
File metadata and controls
186 lines (168 loc) · 5.65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
/**
* Jooby https://jooby.io
* Apache License Version 2.0 https://jooby.io/LICENSE.txt
* Copyright 2014 Edgar Espina
*/
package io.jooby;
import io.jooby.internal.SignedSessionStore;
import io.jooby.internal.MemorySessionStore;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.time.Instant;
import java.util.Map;
import java.util.function.Function;
/**
* Load and save sessions from store (memory, database, etc.).
*
* @author edgar
* @since 2.0.0
*/
public interface SessionStore {
/**
* Creates a new session. This method must:
*
* - Set session as new {@link Session#setNew(boolean)}
* - Optionally, set session creation time {@link Session#setCreationTime(Instant)}
* - Optionally, set session last accessed time {@link Session#setLastAccessedTime(Instant)}
*
* @param ctx Web context.
* @return A new session.
*/
@Nonnull Session newSession(@Nonnull Context ctx);
/**
* Find an existing session by ID. For existing session this method must:
*
* - Optionally, Retrieve/restore session creation time
* - Optionally, Set session last accessed time {@link Session#setLastAccessedTime(Instant)}
*
* @param ctx Web context.
* @return An existing session or <code>null</code>.
*/
@Nullable Session findSession(@Nonnull Context ctx);
/**
* Delete a session from store. This method must NOT call {@link Session#destroy()}.
*
* @param ctx Web context.
* @param session Current session.
*/
void deleteSession(@Nonnull Context ctx, @Nonnull Session session);
/**
* Session attributes/state has changed. Every time a session attribute is put or removed it,
* this method is executed as notification callback.
*
* @param ctx Web context.
* @param session Current session.
*/
void touchSession(@Nonnull Context ctx, @Nonnull Session session);
/**
* Save a session. This method must save:
*
* - Session attributes/data
* - Optionally set Session metadata like: creationTime, lastAccessed time, etc.
*
* This method is call after response is send to client, so context and response shouldn't be
* modified.
*
* @param ctx Web context.
* @param session Current session.
*/
void saveSession(@Nonnull Context ctx, @Nonnull Session session);
/**
* Renew Session ID. This operation might or might not be implemented by a Session Store.
*
* @param ctx Web Context.
* @param session Session.
*/
void renewSessionId(@Nonnull Context ctx, @Nonnull Session session);
/**
* Creates a cookie based session and store data in memory. Session data is not keep after
* restart.
*
* It uses the default session cookie: {@link SessionToken#SID}.
*
* @return Session store.
*/
static @Nonnull SessionStore memory() {
return memory(SessionToken.SID);
}
/**
* Creates a cookie based session and store data in memory. Session data is not keep after
* restart.
*
* @param cookie Cookie to use.
* @return Session store.
*/
static @Nonnull SessionStore memory(@Nonnull Cookie cookie) {
return memory(SessionToken.cookieId(cookie));
}
/**
* Creates a session store that save data in memory. Session data is not keep after restart.
*
* @param token Session token.
* @return Session store.
*/
static @Nonnull SessionStore memory(@Nonnull SessionToken token) {
return new MemorySessionStore(token);
}
/**
* Creates a session store that uses (un)signed data. Session data is signed it using
* <code>HMAC_SHA256</code>.
*
* See {@link Cookie#sign(String, String)} and {@link Cookie#unsign(String, String)}.
*
* @param secret Secret token to signed data.
* @return A browser session store.
*/
static @Nonnull SessionStore signed(@Nonnull String secret) {
return signed(secret, SessionToken.SID);
}
/**
* Creates a session store that uses (un)signed data. Session data is signed it using
* <code>HMAC_SHA256</code>.
*
* See {@link Cookie#sign(String, String)} and {@link Cookie#unsign(String, String)}.
*
* @param secret Secret token to signed data.
* @param cookie Cookie to use.
* @return A browser session store.
*/
static @Nonnull SessionStore signed(@Nonnull String secret, @Nonnull Cookie cookie) {
return signed(secret, SessionToken.signedCookie(cookie));
}
/**
* Creates a session store that uses (un)signed data. Session data is signed it using
* <code>HMAC_SHA256</code>.
*
* See {@link Cookie#sign(String, String)} and {@link Cookie#unsign(String, String)}.
*
* @param secret Secret token to signed data.
* @param token Session token to use.
* @return A browser session store.
*/
static @Nonnull SessionStore signed(@Nonnull String secret, @Nonnull SessionToken token) {
SneakyThrows.Function<String, Map<String, String>> decoder = value -> {
String unsign = Cookie.unsign(value, secret);
if (unsign == null) {
return null;
}
return Cookie.decode(unsign);
};
SneakyThrows.Function<Map<String, String>, String> encoder = attributes ->
Cookie.sign(Cookie.encode(attributes), secret);
return signed(token, decoder, encoder);
}
/**
* Creates a session store that save data into Cookie. Cookie data is (un)signed it using the given
* decoder and encoder.
*
* @param token Token to use.
* @param decoder Decoder to use.
* @param encoder Encoder to use.
* @return Cookie session store.
*/
static @Nonnull SessionStore signed(@Nonnull SessionToken token,
@Nonnull Function<String, Map<String, String>> decoder,
@Nonnull Function<Map<String, String>, String> encoder) {
return new SignedSessionStore(token, decoder, encoder);
}
}