Module org.apache.wicket.core

Package org.apache.wicket

Class DefaultPageManagerProvider

java.lang.Object

org.apache.wicket.DefaultPageManagerProvider

All Implemented Interfaces:

Supplier<IPageManager>, IPageManagerProvider

public class DefaultPageManagerProvider
extends Object
implements IPageManagerProvider

A provider of a PageManager managing @link IManageablePage}s with a default chain of IPageStores:

1. RequestPageStore keeping pages until end of the request
2. CachingPageStore caching with an ...
3. InSessionPageStore keeping the last accessed page in the session
4. SerializingPageStore serializing all pages (so they are available for back-button)
5. AsynchronousPageStore moving storage of pages to an asynchronous worker thread (enabled by default with StoreSettings.isAsynchronous())
6. CryptingPageStore encrypting all pages (disabled by default in StoreSettings.isEncrypted())
7. DiskPageStore persisting all pages, configured according to StoreSettings

An alternative chain with all pages held in-memory could be:

1. RequestPageStore keeping pages until end of the request
2. CachingPageStore caching with an ...
3. InSessionPageStore keeping the last accessed page in the session
4. SerializingPageStore serializing all pages (so they are available for back-button)
5. AsynchronousPageStore moving storage of pages to a worker thread
6. InMemoryPageStore keeping all pages in memory

... or if all pages should be kept in the session only, without any serialization (no back-button support though):

• RequestPageStore caching pages until end of the request
• InSessionPageStore keeping a limited count of pages in the session, e.g. 10

The chain's initial store should always be a RequestPageStore, buffering all adding of pages until the end of the request. Several stores accept SerializedPage only, these have to be preceded by a SerializingPageStore.

For back-button support at least one store in the chain must create copies of stored pages (usually through serialization), otherwise any following request will work on an identical page instance and the previous state of page is no longer accessible.

Other stores be may inserted ad libitum, e.g.

• NoopPageStore discards all pages
• GroupingPageStore groups pages, e.g. to limit storage size on a per-group basis
• FilePageStore as an alternative to the trusted DiskPageStore
• other implementations from wicketstuff-datastores

Field Summary

Fields

Modifier and Type	Field	Description
protected final Application	application

Constructor Summary

Constructors

Constructor	Description
DefaultPageManagerProvider(Application application)	Constructor.

Method Summary

Modifier and Type	Method	Description
IPageManager	get()
protected ISerializer	getSerializer()	Get the ISerializer to use for serializing of pages.
protected IPageStore	newAsynchronousStore(IPageStore pageStore)	Store pages asynchronously into the persistent store, if enabled in StoreSettings.isAsynchronous().
protected IPageStore	newCachingStore(IPageStore pageStore)	Cache last page non-serialized in the session for fast access.
protected IPageStore	newCryptingStore(IPageStore pageStore)	Crypt all pages, if enabled in StoreSettings.isEncrypted().
protected IPageStore	newPersistentStore()	Keep persistent copies of all pages on disk.
protected IPageStore	newRequestStore(IPageStore pageStore)	Keep pages in the request until it is finished.
protected IPageStore	newSerializingStore(IPageStore pageStore)	Serialize pages.

Methods inherited from class java.lang.Object

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

Field Details

application

protected final Application application

Constructor Details

DefaultPageManagerProvider

public DefaultPageManagerProvider(Application application)

Constructor.

Parameters:

application - The application instance

Method Details

get

public IPageManager get()

Specified by:

get in interface Supplier<IPageManager>

getSerializer

protected ISerializer getSerializer()

Get the ISerializer to use for serializing of pages.

By default the serializer of the applications FrameworkSettings.

Returns:

how to serialize pages if needed for any IPageStore

See Also:

• FrameworkSettings.getSerializer()

newRequestStore

protected IPageStore newRequestStore(IPageStore pageStore)

Keep pages in the request until it is finished.

See Also:

• RequestPageStore

newCachingStore

protected IPageStore newCachingStore(IPageStore pageStore)

Cache last page non-serialized in the session for fast access.

On session serialization the cached page will be dropped and re-acquired from a persistent store.

See Also:

• InSessionPageStore

newAsynchronousStore

protected IPageStore newAsynchronousStore(IPageStore pageStore)

Store pages asynchronously into the persistent store, if enabled in StoreSettings.isAsynchronous().

See Also:

• AsynchronousPageStore

newSerializingStore

protected IPageStore newSerializingStore(IPageStore pageStore)

Serialize pages.

See Also:

• SerializingPageStore

newCryptingStore

protected IPageStore newCryptingStore(IPageStore pageStore)

Crypt all pages, if enabled in StoreSettings.isEncrypted().

See Also:

• CryptingPageStore

newPersistentStore

protected IPageStore newPersistentStore()

Keep persistent copies of all pages on disk.

See Also:

• DiskPageStore
• StoreSettings.getMaxSizePerSession()
• StoreSettings.getFileStoreFolder()