Package freemarker.core
Class OptInTemplateClassResolver
java.lang.Object
freemarker.core.OptInTemplateClassResolver
- All Implemented Interfaces:
TemplateClassResolver
A
TemplateClassResolver that resolves only the classes whose name
was specified in the constructor.-
Field Summary
Fields inherited from interface freemarker.core.TemplateClassResolver
ALLOWS_NOTHING_RESOLVER, SAFER_RESOLVER, UNRESTRICTED_RESOLVER -
Constructor Summary
ConstructorsConstructorDescriptionOptInTemplateClassResolver(Set allowedClasses, List trustedTemplates)Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionresolve(String className, Environment env, Template template)Gets aClassbased on the class name.protected StringsafeGetTemplateName(Template template)Extract the template name from the template object which will be matched against the trusted template names and pattern.
-
Constructor Details
-
OptInTemplateClassResolver
Creates a new instance.- Parameters:
allowedClasses- theSetofString-s that contains the full-qualified names of the allowed classes. Can benull(means not class is allowed).trustedTemplates- theListofString-s that contains template names (i.e., template root directory relative paths) and prefix patterns (like"include/*") of templates for whichTemplateClassResolver.SAFER_RESOLVERwill be used (which is not as safe asOptInTemplateClassResolver). The list items need not start with"/"(if they are, it will be removed). List items ending with"*"are treated as prefixes (i.e."foo*"matches"foobar","foo/bar/baaz","foowhatever/bar/baaz", etc.). The"*"has no special meaning anywhere else. The matched template name is the name (template root directory relative path) of the template that directly (lexically) contains the operation (like?new) that wants to get the class. Thus, if a trusted template includes a non-trusted template, theallowedClassesrestriction will apply in the included template. This parameter can benull(means no trusted templates).
-
-
Method Details
-
resolve
public Class resolve(String className, Environment env, Template template) throws TemplateExceptionDescription copied from interface:TemplateClassResolverGets aClassbased on the class name.- Specified by:
resolvein interfaceTemplateClassResolver- Parameters:
className- the full-qualified class nameenv- the environment in which the template executestemplate- the template where the operation that require the class resolution resides in. This isnullif the call doesn't come from a template.- Throws:
TemplateException- if the class can't be found or shouldn't be accessed from a template for security reasons.
-
safeGetTemplateName
Extract the template name from the template object which will be matched against the trusted template names and pattern.
-