com.sapportals.wcm.rendering.base

Class NavigationMemorizer

java.lang.Object
  com.sapportals.wcm.rendering.base.NavigationMemorizer

All Implemented Interfaces:

INavigationMemorizer

public final class NavigationMemorizer

extends Object

implements INavigationMemorizer

acts as a layer between each instance of a NavigationMemory and the ICache that acts as persistence layer to keep the navigation memory across http-requests. For each IUser, there will be only one entry in this memorizer. Entries will be deleted over time. See the ICache for details. This class is implemented as a singleton. The method getId of the class IUser should be used to add, modify and delete entries within this class.

Since:

EP6, SP1

Method Summary

boolean	addMemory(NavigationMemory memory, String key, boolean overwrite)
void	configEvent(ConfigEvent arg0)
String	getConfigListenerId()
static NavigationMemorizer	getInstance()
NavigationMemory	getMemory(String key) returns the NavigationMemory instance that has been added with the given key via this class' addMemory method.
IRidList	getRecent(IResource resource) Gets session navigation information for a user
boolean	isExcluded(RID rid)
boolean	removeMemory(String key)

Methods inherited from class java.lang.Object

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

Method Detail

isExcluded

public boolean isExcluded(RID rid)

getInstance

public static NavigationMemorizer getInstance()

getMemory

public NavigationMemory getMemory(String key)

returns the NavigationMemory instance that has been added with the given key via this class' addMemory method. If the NavigationMemorizer has not been initialized properly or no entry is available for the given key, the method will return null.

Parameters:

key - the key that has been used to add the requested object via this class' addMemory method. Must not be null.

Returns:

the mapped NavigationMemory for the given key or null.

addMemory

public boolean addMemory(NavigationMemory memory,
                         String key,
                         boolean overwrite)

removeMemory

public boolean removeMemory(String key)

getRecent

public IRidList getRecent(IResource resource)

Description copied from interface: INavigationMemorizer

Gets session navigation information for a user

Specified by:

getRecent in interface INavigationMemorizer

Parameters:

resource - current resource

Returns:

resource IDs that are stored as navigation information

getConfigListenerId

public String getConfigListenerId()

configEvent

public void configEvent(ConfigEvent arg0)