Package com.atlassian.velocity.allowlist.impl.internal

Class PluginAllowlistConfigurator

java.lang.Object

com.atlassian.velocity.allowlist.impl.internal.PluginAllowlistConfigurator

All Implemented Interfaces:

PluginAllowlist

public class PluginAllowlistConfigurator
extends Object
implements PluginAllowlist

Holds, and can check against, all methods, classes and packages allowlisted for use in Velocity templates.

Since:

6.0.0

Constructor Summary

Constructors

Constructor	Description
PluginAllowlistConfigurator()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.1.0, use PluginAllowlistConfigurator(PluginAccessor) instead.
PluginAllowlistConfigurator(com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Summary

Modifier and Type	Method	Description
boolean	isAllowlistedClassPackage(Class<?> clazz)	Only returns true if the actual class is allowlisted, irrespective of whether all methods declared in the class are individually allowlisted.
boolean	isAllowlistedMethod(Method method)	Only returns true if the specific method is allowlisted, irrespective of whether its declaring class is allowlisted.
void	reload()	Reloads the allowlist from the plugin module descriptors.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.velocity.allowlist.api.internal.PluginAllowlist

isAllowlisted

Constructor Details

PluginAllowlistConfigurator

@Deprecated(forRemoval=true)
public PluginAllowlistConfigurator()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.1.0, use PluginAllowlistConfigurator(PluginAccessor) instead.

PluginAllowlistConfigurator

public PluginAllowlistConfigurator(com.atlassian.plugin.PluginAccessor pluginAccessor)

Method Details

reload

public void reload()

Description copied from interface: PluginAllowlist

Reloads the allowlist from the plugin module descriptors.

Specified by:

reload in interface PluginAllowlist

isAllowlistedClassPackage

public boolean isAllowlistedClassPackage(Class<?> clazz)

Description copied from interface: PluginAllowlist

Only returns true if the actual class is allowlisted, irrespective of whether all methods declared in the class are individually allowlisted.

Specified by:

isAllowlistedClassPackage in interface PluginAllowlist

isAllowlistedMethod

public boolean isAllowlistedMethod(Method method)

Description copied from interface: PluginAllowlist

Only returns true if the specific method is allowlisted, irrespective of whether its declaring class is allowlisted. Call PluginAllowlist.isAllowlisted(java.lang.reflect.Method) to consider both method and class/package allowlist configuration.

Specified by:

isAllowlistedMethod in interface PluginAllowlist