Package org.apache.wicket.mock
Class MockSessionStore
java.lang.Object
org.apache.wicket.mock.MockSessionStore
- All Implemented Interfaces:
ISessionStore
Session store that holds one session.
- Author:
- Matej Knopp
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.wicket.session.ISessionStore
ISessionStore.BindListener, ISessionStore.UnboundListener
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the provided new session to this facade using the provided request.void
destroy()
Called when the WebApplication is destroyed.void
flushSession
(Request request, Session session) Flushes the session.getAttribute
(Request request, String name) Gets the attribute value with the given namegetAttributeNames
(Request request) getSessionId
(Request request, boolean create) Get the session id for the provided request.final Set<ISessionStore.UnboundListener>
void
invalidate
(Request request) Invalidates the session.Retrieves the session for the provided request from this facade.void
Registers listener invoked when session is bound.void
Registers listener invoked when session is unbound.void
removeAttribute
(Request request, String name) Removes the attribute with the given name.void
setAttribute
(Request request, String name, Serializable value) Adds or replaces the attribute with the given name and value.void
Unregisters listener invoked when session is bound.void
Unregisters listener invoked when session is unbound.
-
Constructor Details
-
MockSessionStore
public MockSessionStore()Construct.
-
-
Method Details
-
bind
Description copied from interface:ISessionStore
Adds the provided new session to this facade using the provided request.- Specified by:
bind
in interfaceISessionStore
- Parameters:
request
- The request that triggered making a new sessionnewSession
- The new session
-
destroy
Description copied from interface:ISessionStore
Called when the WebApplication is destroyed.- Specified by:
destroy
in interfaceISessionStore
-
getAttribute
Description copied from interface:ISessionStore
Gets the attribute value with the given name- Specified by:
getAttribute
in interfaceISessionStore
- Parameters:
request
- the current requestname
- The name of the attribute to store- Returns:
- The value of the attribute
-
getAttributeNames
- Specified by:
getAttributeNames
in interfaceISessionStore
- Parameters:
request
- the current request- Returns:
- List of attributes for this session
-
getSessionId
Description copied from interface:ISessionStore
Get the session id for the provided request. If create is false and the creation of the actual session is deferred, this method should return null to reflect it doesn't have one.- Specified by:
getSessionId
in interfaceISessionStore
- Parameters:
request
- The requestcreate
- Whether to create an actual session (typically an instance ofHttpSession
) when not already done so- Returns:
- The session id for the provided request, possibly null if create is false and the creation of the actual session was deferred
-
invalidate
Description copied from interface:ISessionStore
Invalidates the session.- Specified by:
invalidate
in interfaceISessionStore
- Parameters:
request
- the current request
-
lookup
Description copied from interface:ISessionStore
Retrieves the session for the provided request from this facade.This method should return null if it is not bound yet, so that Wicket can recognize that it should create a session and call
ISessionStore.bind(Request, Session)
right after that.- Specified by:
lookup
in interfaceISessionStore
- Parameters:
request
- The current request- Returns:
- The session for the provided request or null if the session was not bound
-
registerUnboundListener
Description copied from interface:ISessionStore
Registers listener invoked when session is unbound.- Specified by:
registerUnboundListener
in interfaceISessionStore
-
removeAttribute
Description copied from interface:ISessionStore
Removes the attribute with the given name.- Specified by:
removeAttribute
in interfaceISessionStore
- Parameters:
request
- the current requestname
- the name of the attribute to remove
-
getUnboundListener
- Specified by:
getUnboundListener
in interfaceISessionStore
- Returns:
- The list of registered unbound listeners
-
setAttribute
Description copied from interface:ISessionStore
Adds or replaces the attribute with the given name and value.- Specified by:
setAttribute
in interfaceISessionStore
- Parameters:
request
- the current requestname
- the name of the attributevalue
- the value of the attribute
-
unregisterUnboundListener
Description copied from interface:ISessionStore
Unregisters listener invoked when session is unbound.- Specified by:
unregisterUnboundListener
in interfaceISessionStore
-
registerBindListener
Description copied from interface:ISessionStore
Registers listener invoked when session is bound.- Specified by:
registerBindListener
in interfaceISessionStore
-
unregisterBindListener
Description copied from interface:ISessionStore
Unregisters listener invoked when session is bound.- Specified by:
unregisterBindListener
in interfaceISessionStore
-
getBindListeners
- Specified by:
getBindListeners
in interfaceISessionStore
- Returns:
- The list of registered bind listeners
-
flushSession
Description copied from interface:ISessionStore
Flushes the session. Flushing the session generally means setting the attribute with the value of the current session. Some servlet containers use the setAttribute() as a signal that the value is dirty and needs to be replicated. Essentially this call comes down to:String attr=getSessionAttributeName(); Session session=getAttribute(attr); setAttribute(attr, session);
If the session is not yet bound it will be.- Specified by:
flushSession
in interfaceISessionStore
- Parameters:
request
- current requestsession
- session to be flushed
-