org.opencms.loader
Interface I_CmsLoaderIncludeExtension

public interface I_CmsLoaderIncludeExtension

Allows extensions to the default include mechanism, these might be required for the handling of special resource types.

Since:

6.0.0

Version:

$Revision: 1.10 $

Author:

Alexander Kandzior

See Also:

CmsJspTagInclude.includeTagAction(javax.servlet.jsp.PageContext, String, String, boolean, Map, ServletRequest, ServletResponse)

Method Summary

java.lang.String

includeExtension(java.lang.String target, java.lang.String element, boolean editable, java.util.Map paramMap, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) The extension method for the include tag action.

Method Detail

includeExtension

java.lang.String includeExtension(java.lang.String target,
                                  java.lang.String element,
                                  boolean editable,
                                  java.util.Map paramMap,
                                  javax.servlet.ServletRequest req,
                                  javax.servlet.ServletResponse res)
                                  throws CmsException

The extension method for the include tag action.

Parameters:

target - the target for the include, might be null

element - the element to select form the target might be null

editable - the flag to indicate if the target is editable

paramMap - a map of parameters for the include, can be modified, might be null

req - the current request

res - the current response

Returns:

the modified target URI

Throws:

CmsException - in case something goes wrong