com.sapportals.portal.navigation

Class NavigationConnectorProfile

java.lang.Object
  com.sapportals.portal.navigation.NavigationConnectorProfile

public class NavigationConnectorProfile
extends Object

The NavigationConnectorProfile is a representation of the connector configuration, i.e. it reflects its cache behaviour meaning if it is cacheable,its cache region configuration, its specific attributes to load on cache when saving connector nodes to cache.

Constructor Summary

NavigationConnectorProfile()

Method Summary

int	getCacheLifeTime()
int	getCacheMaxSize()
List	getConnectorNodeCachedAttributes()
boolean	isCachable()
boolean	isCachePersisted()
boolean	isCacheSynchronizeSupported() Notice that synchronize operation on cache connector nodes is performed with technical user.
void	setCachable(boolean isCachable)
void	setCacheLifeTime(int cacheLifeTime)
void	setCacheMaxSize(int cacheMaxSize)
void	setCachePersisted(boolean isCachePersisted)
void	setCacheSynchronizeSupported(boolean isCacheSynchronizeSupported) set true if the cache synchronize operation for the cache connector node is supported, Notice that synchronize operation on cache connector nodes is performed with technical user.
void	setConnectorNodeCachedAttributes(List connectorNodeCachedAttributes)

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationConnectorProfile

public NavigationConnectorProfile()

Method Detail

getCacheLifeTime

public int getCacheLifeTime()

Returns:

cache life time in minutes

setCacheLifeTime

public void setCacheLifeTime(int cacheLifeTime)

Parameters:

cacheLifeTime - in minutes,if not set by default negative value is returned

getCacheMaxSize

public int getCacheMaxSize()

Returns:

the cache region max size of connector,if not set by default negative value is returned

setCacheMaxSize

public void setCacheMaxSize(int cacheMaxSize)

Parameters:

cacheMaxSize - - define the max size of the connector cache region

getConnectorNodeCachedAttributes

public List getConnectorNodeCachedAttributes()

Returns:

List of attribute names to extract for the connector nodes when save the nodes in cache or null if no special attributes were set.

setConnectorNodeCachedAttributes

public void setConnectorNodeCachedAttributes(List connectorNodeCachedAttributes)

Parameters:

connectorNodeCachedAttributes - - List of attribute names to extract for the connector nodes when save the nodes

isCachePersisted

public boolean isCachePersisted()

Returns:

true if the cache should be persisted,by default cache is not persisted.

setCachePersisted

public void setCachePersisted(boolean isCachePersisted)

isCachable

public boolean isCachable()

Returns:

true if the connector declares that it is cachable, by default each connector is cachable

setCachable

public void setCachable(boolean isCachable)

Parameters:

isCachable - - set true if the connector is cachable

isCacheSynchronizeSupported

public boolean isCacheSynchronizeSupported()

Notice that synchronize operation on cache connector nodes is performed with technical user.

Returns:

true if the connector supports the synchronize operation on its cached connector nodes, by default the synchronize is not supported.

setCacheSynchronizeSupported

public void setCacheSynchronizeSupported(boolean isCacheSynchronizeSupported)

set true if the cache synchronize operation for the cache connector node is supported, Notice that synchronize operation on cache connector nodes is performed with technical user.

Parameters:

isCacheSynchronizeSupported -

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/navigation/api	api	EP-PIN