org.apache.wicket.page

Class AbstractPageManager

java.lang.Object

org.apache.wicket.page.AbstractPageManager

All Implemented Interfaces:

IPageManager

Direct Known Subclasses:

PageStoreManager

public abstract class AbstractPageManager
extends Object
implements IPageManager

Convenience class for IPageManager implementations. Subclass should extend RequestAdapter and override newRequestAdapter(IPageManagerContext) method to return it's RequestAdapter implementation.

Author:

Matej Knopp

Constructor Summary

Constructors

Constructor and Description
AbstractPageManager(IPageManagerContext context) Construct.

Method Summary

Modifier and Type	Method and Description
void	commitRequest() Commits the changes to external storage if the manager uses it.
void	endRequest() End the current request.
IPageManagerContext	getContext()
IManageablePage	getPage(int id) Retrieve page instance with given id.
protected RequestAdapter	getRequestAdapter()
protected abstract RequestAdapter	newRequestAdapter(IPageManagerContext context)
void	newSessionCreated() Invoked when new session has been created.
void	removePage(IManageablePage page) Removes a page from the IPageStore and IDataStore.
void	touchPage(IManageablePage page) Marks page as changed.
void	untouchPage(IManageablePage page) Marks page as non-changed.

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.page.IPageManager

clear, destroy, supportsVersioning

Constructor Detail

AbstractPageManager

public AbstractPageManager(IPageManagerContext context)

Construct.

Parameters:

context -

Method Detail

newRequestAdapter

protected abstract RequestAdapter newRequestAdapter(IPageManagerContext context)

Parameters:

context -

Returns:

a new request adapter

getContext

public IPageManagerContext getContext()

Specified by:

getContext in interface IPageManager

Returns:

The page manager context

getRequestAdapter

protected RequestAdapter getRequestAdapter()

Returns:

the request adapter

See Also:

newRequestAdapter(IPageManagerContext)

endRequest

public void endRequest()

Description copied from interface: IPageManager

End the current request.

Specified by:

endRequest in interface IPageManager

commitRequest

public void commitRequest()

Description copied from interface: IPageManager

Commits the changes to external storage if the manager uses it. Should also detach all pages that were touched during this request.

Specified by:

commitRequest in interface IPageManager

getPage

public IManageablePage getPage(int id)

Description copied from interface: IPageManager

Retrieve page instance with given id.

Specified by:

getPage in interface IPageManager

Parameters:

id - the id of the page to load

Returns:

page instance or null

removePage

public void removePage(IManageablePage page)

Description copied from interface: IPageManager

Removes a page from the IPageStore and IDataStore. Any attempt to access it later will lead to PageExpiredException

Specified by:

removePage in interface IPageManager

Parameters:

page - The page instance to remove from the stores

newSessionCreated

public void newSessionCreated()

Description copied from interface: IPageManager

Invoked when new session has been created.

Specified by:

newSessionCreated in interface IPageManager

touchPage

public void touchPage(IManageablePage page)

Description copied from interface: IPageManager

Marks page as changed.

Note:Only stateful pages are stored.

Specified by:

touchPage in interface IPageManager

Parameters:

page - the page that should be stored in the page stores at the end of the request.

untouchPage

public void untouchPage(IManageablePage page)

Description copied from interface: IPageManager

Marks page as non-changed. Could be used in Ajax requests to avoid storing the page if no changes have happened.

Specified by:

untouchPage in interface IPageManager

Parameters:

page - the page that should not be stored in the page stores at the end of the request.