lumis.portal.xslcache
Interface IXslCacheManager

All Known Implementing Classes:

XslCacheManager

public interface IXslCacheManager

Since:

4.0.0

Method Summary

void	add(SessionConfig sessionConfig, XslCacheConfig xslCacheConfig, ITransaction transaction) Add a cache of the XSL.
void	clearXslCache(ITransaction transaction) Clears all XSL cache.
void	clearXslCache(SessionConfig sessionConfig, String fileName, ITransaction transaction) Clear the cache for the specified xsl file.
void	clearXslConfigCache(SessionConfig sessionConfig, ITransaction transaction) Clear the XslConfigCache.
void	clearXslConfigCache(SessionConfig sessionConfig, String fileName, ITransaction transaction) Clear the XslConfigCache.
Transformer	createTransformer(String resourcePath) Creates a transformer for a XSL in the specified path.
Transformer	createTransformer(String resourcePath, List<? extends ITheme> themes) Creates a transformer for a XSL in the specified path, with the given themes applied.
Transformer	createTransformer(String xslStringDocument, String resourcePath) Creates a transformer for a specified XSL document string.
Transformer	createTransformer(String xslStringDocument, String resourcePath, List<? extends ITheme> themes) Creates a transformer for a specified XSL document string.
void	delete(SessionConfig sessionConfig, String fileName, ITransaction transaction) Delete de cache of the XSL.
XslCacheConfig	get(SessionConfig sessionConfig, String fileName, ITransaction transaction) Get the XslCacheConfig.
boolean	getDefaultCache() Get the default cache.
Transformer	getTransformer(SessionConfig sessionConfig, String fileName, ITransaction transaction) Get a Transformer.
Transformer	getTransformer(SessionConfig sessionConfig, String xslPath, List<? extends ITheme> themes, ITransaction transaction) Returns a transformer for a XSL in the specified path, with the given themes applied.
boolean	isXslCached(String fileName) Verify if the xsl file is cached.
void	setDefaultCache(boolean enable) Set the default cache.
void	update(SessionConfig sessionConfig, XslCacheConfig xslCacheConfig, ITransaction transaction) Update the cache of the XSL.

Method Detail

setDefaultCache

void setDefaultCache(boolean enable)

Set the default cache.

Parameters:

enable -

getDefaultCache

boolean getDefaultCache()

Get the default cache.

Returns:

add

void add(SessionConfig sessionConfig,
         XslCacheConfig xslCacheConfig,
         ITransaction transaction)
         throws PortalException,
                ManagerException

Add a cache of the XSL.

Parameters:

sessionConfig -

xslCacheConfig -

transaction -

Throws:

PortalException

ManagerException

delete

void delete(SessionConfig sessionConfig,
            String fileName,
            ITransaction transaction)
            throws PortalException,
                   ManagerException

Delete de cache of the XSL.

Parameters:

sessionConfig -

fileName -

transaction -

Throws:

PortalException

ManagerException

update

void update(SessionConfig sessionConfig,
            XslCacheConfig xslCacheConfig,
            ITransaction transaction)
            throws PortalException,
                   ManagerException

Update the cache of the XSL.

Parameters:

sessionConfig -

xslCacheConfig -

transaction -

Throws:

PortalException

ManagerException

get

XslCacheConfig get(SessionConfig sessionConfig,
                   String fileName,
                   ITransaction transaction)
                   throws PortalException,
                          ManagerException

Get the XslCacheConfig.

Parameters:

sessionConfig -

fileName -

transaction -

Returns:

a XslCacheConfig.

Throws:

PortalException

ManagerException

clearXslConfigCache

void clearXslConfigCache(SessionConfig sessionConfig,
                         String fileName,
                         ITransaction transaction)
                         throws PortalException,
                                ManagerException

Clear the XslConfigCache.

Parameters:

sessionConfig -

fileName -

transaction -

Throws:

PortalException

ManagerException

clearXslConfigCache

void clearXslConfigCache(SessionConfig sessionConfig,
                         ITransaction transaction)
                         throws PortalException,
                                ManagerException

Clear the XslConfigCache.

Parameters:

sessionConfig -

transaction -

Throws:

PortalException

ManagerException

getTransformer

Transformer getTransformer(SessionConfig sessionConfig,
                           String fileName,
                           ITransaction transaction)
                           throws PortalException,
                                  ManagerException

Get a Transformer.

Parameters:

sessionConfig -

fileName -

transaction -

Returns:

a Transformer.

Throws:

PortalException

ManagerException

getTransformer

Transformer getTransformer(SessionConfig sessionConfig,
                           String xslPath,
                           List<? extends ITheme> themes,
                           ITransaction transaction)
                           throws PortalException

Returns a transformer for a XSL in the specified path, with the given themes applied. This methods uses this manager's XSL caching feature.

Parameters:

sessionConfig - user session information.

xslPath - the classpath relative resource path where the XSL is present.

themes - a list with the themes,in the same order they are applied.

transaction - the transaction for persistence access.

Returns:

the transformer.

Throws:

PortalException - if the transformer could not be created.

Since:

7.0.0

createTransformer

Transformer createTransformer(String resourcePath)
                              throws PortalException

Creates a transformer for a XSL in the specified path.

Parameters:

resourcePath - the relative classpath resource path where the document is present.

Returns:

the transformer.

Throws:

PortalException - if the transformer could not be created.

Since:

6.0.0

See Also:

createTransformer(String, List)

createTransformer

Transformer createTransformer(String resourcePath,
                              List<? extends ITheme> themes)
                              throws PortalException

Creates a transformer for a XSL in the specified path, with the given themes applied.

Parameters:

resourcePath - the relative classpath resource path where the document is present.

themes - a list with the themes,in the same order they are applied.

Returns:

the transformer.

Throws:

PortalException - if the transformer could not be created.

Since:

7.0.0

clearXslCache

void clearXslCache(SessionConfig sessionConfig,
                   String fileName,
                   ITransaction transaction)
                   throws PortalException,
                          ManagerException

Clear the cache for the specified xsl file.

Parameters:

sessionConfig - the user session information.

fileName - the xsl file path.

transaction - the transaction for persistence access.

Throws:

PortalException

ManagerException

clearXslCache

void clearXslCache(ITransaction transaction)
                   throws PortalException

Clears all XSL cache.

Parameters:

transaction - the transaction for persistence access. If null, the cache is just cleared, else it is cleared as a transactional operation as specified in PortalCache.clear(ITransaction).

Throws:

PortalException

Since:

4.1.0

isXslCached

boolean isXslCached(String fileName)

Verify if the xsl file is cached.

Parameters:

fileName - the xsl file path.

Returns:

true if any variant of the xsl is being cached, or false otherwise.

createTransformer

Transformer createTransformer(String xslStringDocument,
                              String resourcePath)
                              throws PortalException

Creates a transformer for a specified XSL document string. This method creates a Transformer for a XSL document that is not required to physically exist on the server.

Parameters:

xslStringDocument - the XSL document as a string.

resourcePath - the relative classpath resource path where the document is considered to exist, for URI resolution purposes.

Returns:

the transformer.

Throws:

PortalException - if the transformer could not be created.

Since:

6.0.0

createTransformer

Transformer createTransformer(String xslStringDocument,
                              String resourcePath,
                              List<? extends ITheme> themes)
                              throws PortalException

Creates a transformer for a specified XSL document string. This method creates a Transformer for a XSL document that is not required to physically exist on the server.

Parameters:

xslStringDocument - the XSL document as a string.

resourcePath - the relative classpath resource path where the document is considered to exist, for URI resolution purposes.

themes - the applied themes.

Returns:

the transformer.

Throws:

PortalException - if the transformer could not be created.

Since:

7.0.0