com.ibm.commerce.pagelayout.cache

Class PageLayoutTagHelper

java.lang.Object

com.ibm.commerce.pagelayout.cache.PageLayoutTagHelper

public class PageLayoutTagHelper
extends java.lang.Object

Helper class for dyna cache related tag handlers.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_NAME The name of this class.
static java.lang.String	COPYRIGHT COPYRIGHT

Constructor Summary

Constructors

Constructor and Description
PageLayoutTagHelper()

Method Summary

Modifier and Type	Method and Description
static com.ibm.websphere.servlet.cache.FragmentInfo	getCachedObjectFragmentInfo(javax.servlet.http.HttpServletRequest request) This method returns the FragmentInfo object for the current request object.
static com.ibm.ws.cache.servlet.FragmentComposer	getFragmentComposer(javax.servlet.http.HttpServletRequest request) This method returns the FragmentComposer object for the current request object.
static com.ibm.ws.cache.servlet.FragmentComposer	getParentFragmentComposer(javax.servlet.http.HttpServletRequest request) This method returns the top most FragmentComposer object for the current request object.
static void	setCachedObjectDependency(java.lang.String dependencyName, java.lang.String id, com.ibm.websphere.servlet.cache.FragmentInfo coFragmentInfo) This method dynamically creates a dependency for a cached page.
static void	setUnconsumable(boolean consumeFlag, javax.servlet.http.HttpServletResponse response) This method sets do-not-consume flag on the response object

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

COPYRIGHT

See Also:

Constant Field Values

CLASS_NAME

public static final java.lang.String CLASS_NAME

The name of this class.

Constructor Detail

PageLayoutTagHelper

public PageLayoutTagHelper()

Method Detail

getCachedObjectFragmentInfo

public static com.ibm.websphere.servlet.cache.FragmentInfo getCachedObjectFragmentInfo(javax.servlet.http.HttpServletRequest request)

This method returns the FragmentInfo object for the current request object.

Parameters:

request - The request object.

Returns:

The FragmentInfo object in which to add variables unique to externally cacheable pages.

getFragmentComposer

public static com.ibm.ws.cache.servlet.FragmentComposer getFragmentComposer(javax.servlet.http.HttpServletRequest request)

This method returns the FragmentComposer object for the current request object.

Parameters:

request - The request object.

Returns:

The FragmentComposer object

setUnconsumable

public static void setUnconsumable(boolean consumeFlag,
                                   javax.servlet.http.HttpServletResponse response)

This method sets do-not-consume flag on the response object

Parameters:

consumeFlag - - True if the response can be consumed with parent cache entry, false otherwise

response - - HTTPServletResponse object

getParentFragmentComposer

public static com.ibm.ws.cache.servlet.FragmentComposer getParentFragmentComposer(javax.servlet.http.HttpServletRequest request)

This method returns the top most FragmentComposer object for the current request object.

Parameters:

request - The request object.

Returns:

The FragmentComposer object

setCachedObjectDependency

public static void setCachedObjectDependency(java.lang.String dependencyName,
                                             java.lang.String id,
                                             com.ibm.websphere.servlet.cache.FragmentInfo coFragmentInfo)

This method dynamically creates a dependency for a cached page. The dependency will have the format dependencyName:id

Parameters:

dependencyName - The dependency name.

id - The dependency value.

coFragmentInfo - The FragmentInfo object in which to add variables unique to externally cacheable pages.