org.apache.wicket.pageStore

Class AbstractPageStore

java.lang.Object

org.apache.wicket.pageStore.AbstractPageStore

All Implemented Interfaces:

IPageStore

Direct Known Subclasses:

AbstractCachingPageStore

public abstract class AbstractPageStore
extends Object
implements IPageStore

Field Summary

Fields

Modifier and Type	Field and Description
protected IDataStore	dataStore
protected ISerializer	pageSerializer The ISerializer that will be used to convert pages from/to byte arrays

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPageStore(ISerializer pageSerializer, IDataStore dataStore)

Method Summary

Modifier and Type	Method and Description
protected IManageablePage	deserializePage(byte[] data)
void	destroy() Destroy the store.
protected byte[]	getPageData(String sessionId, int pageId)
Serializable	prepareForSerialization(String sessionId, Serializable page) Process the page before the it gets serialized.
protected void	removePageData(String sessionId)
protected void	removePageData(String sessionId, int pageId)
Object	restoreAfterSerialization(Serializable serializable) This method should restore the serialized page to intermediate object that can be converted to real page instance using IPageStore.convertToPage(Object).
protected byte[]	serializePage(IManageablePage page) Serializes the passed page to byte[]
protected void	storePageData(String sessionId, int pageId, byte[] data)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.pageStore.IPageStore

canBeAsynchronous, convertToPage, getPage, removePage, storePage, unbind

Field Detail

dataStore

protected final IDataStore dataStore

pageSerializer

protected final ISerializer pageSerializer

The ISerializer that will be used to convert pages from/to byte arrays

Constructor Detail

AbstractPageStore

protected AbstractPageStore(ISerializer pageSerializer,
                            IDataStore dataStore)

Method Detail

destroy

public void destroy()

Description copied from interface: IPageStore

Destroy the store.

Specified by:

destroy in interface IPageStore

prepareForSerialization

public Serializable prepareForSerialization(String sessionId,
                                            Serializable page)

Description copied from interface: IPageStore

Process the page before the it gets serialized. The page can be either real page instance or object returned by IPageStore.restoreAfterSerialization(Serializable).

Specified by:

prepareForSerialization in interface IPageStore

Parameters:

sessionId - The session of the page that must be removed

Returns:

The Page itself or a SerializedContainer for that page

restoreAfterSerialization

public Object restoreAfterSerialization(Serializable serializable)

Description copied from interface: IPageStore

This method should restore the serialized page to intermediate object that can be converted to real page instance using IPageStore.convertToPage(Object).

Specified by:

restoreAfterSerialization in interface IPageStore

Returns:

Page

getPageData

protected byte[] getPageData(String sessionId,
                             int pageId)

Parameters:

sessionId - The id of the http session

pageId - The id of page which serialized data should be got

Returns:

page data

See Also:

IDataStore.getData(String, int)

removePageData

protected void removePageData(String sessionId,
                              int pageId)

Parameters:

sessionId - The id of the http session

pageId - The id of page which serialized data should be removed

See Also:

IDataStore.removeData(String, int)

removePageData

protected void removePageData(String sessionId)

Parameters:

sessionId - The id of the http session for which all data should be removed

See Also:

IDataStore.removeData(String)

storePageData

protected void storePageData(String sessionId,
                             int pageId,
                             byte[] data)

Parameters:

sessionId - The id of the http session

pageId - The id of the page to store

data - The serialized view of the page

See Also:

IDataStore.storeData(String, int, byte[])

serializePage

protected byte[] serializePage(IManageablePage page)

Serializes the passed page to byte[]

Parameters:

page - The page to serialize

Returns:

the serialized view of the passed page

deserializePage

protected IManageablePage deserializePage(byte[] data)

Parameters:

data - The serialized view of the page

Returns:

page data deserialized