Package org.craftercms.engine.plugin.impl

Class PluginServiceImpl

java.lang.Object

org.craftercms.engine.plugin.impl.PluginServiceImpl

All Implemented Interfaces:

PluginService

public class PluginServiceImpl
extends Object
implements PluginService

Default implementation for PluginService

Since:

4.0.0

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected String	configurationPathPattern
protected org.craftercms.commons.config.EncryptionAwareConfigurationReader	configurationReader
protected org.craftercms.core.service.ContentStoreService	contentStoreService
protected Pattern	pattern
static final String	PLUGIN_CONFIG_KEY
static final String	PLUGIN_ID_KEY
static final String	PLUGIN_ID_PLACEHOLDER

Constructor Summary

Constructors

Constructor	Description
PluginServiceImpl(org.craftercms.core.service.ContentStoreService contentStoreService, org.craftercms.commons.config.EncryptionAwareConfigurationReader configurationReader, String configurationPathPattern)

Method Summary

Modifier and Type	Method	Description
void	addPluginVariables(String url, BiConsumer<String,Object> setter)	Adds variables related to plugins if the given URL belongs to a plugin
protected org.craftercms.core.service.Context	getCurrentContext()
org.apache.commons.configuration2.HierarchicalConfiguration<?>	getPluginConfig(String pluginId)	Loads the configuration for a given plugin
protected String	getPluginConfigPath(String pluginPath)
protected String	getPluginId(String pluginPath)
protected org.apache.commons.configuration2.HierarchicalConfiguration<?>	loadPluginConfiguration(org.craftercms.core.service.Context context, String pluginPath)
protected boolean	pluginConfigExists(String path)

Methods inherited from class java.lang.Object

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

Field Details

PLUGIN_ID_KEY

public static final String PLUGIN_ID_KEY

See Also:

• Constant Field Values

PLUGIN_CONFIG_KEY

public static final String PLUGIN_CONFIG_KEY

See Also:

• Constant Field Values

PLUGIN_ID_PLACEHOLDER

public static final String PLUGIN_ID_PLACEHOLDER

See Also:

• Constant Field Values

pattern

protected Pattern pattern

contentStoreService

protected org.craftercms.core.service.ContentStoreService contentStoreService

configurationReader

protected org.craftercms.commons.config.EncryptionAwareConfigurationReader configurationReader

configurationPathPattern

protected String configurationPathPattern

Constructor Details

PluginServiceImpl

@ConstructorProperties({"contentStoreService","configurationReader","configurationPathPattern"})
public PluginServiceImpl(org.craftercms.core.service.ContentStoreService contentStoreService,
 org.craftercms.commons.config.EncryptionAwareConfigurationReader configurationReader,
 String configurationPathPattern)

Method Details

getPluginConfig

public org.apache.commons.configuration2.HierarchicalConfiguration<?> getPluginConfig(String pluginId)

Description copied from interface: PluginService

Loads the configuration for a given plugin

Specified by:

getPluginConfig in interface PluginService

Parameters:

pluginId - the id of the plugin

Returns:

the configuration object

loadPluginConfiguration

protected org.apache.commons.configuration2.HierarchicalConfiguration<?> loadPluginConfiguration(org.craftercms.core.service.Context context,
 String pluginPath)

addPluginVariables

public void addPluginVariables(String url,
 BiConsumer<String,Object> setter)

Description copied from interface: PluginService

Adds variables related to plugins if the given URL belongs to a plugin

Specified by:

addPluginVariables in interface PluginService

Parameters:

url - the URL to check

setter - the setter for the variables

pluginConfigExists

protected boolean pluginConfigExists(String path)

getPluginId

protected String getPluginId(String pluginPath)

getPluginConfigPath

protected String getPluginConfigPath(String pluginPath)

getCurrentContext

protected org.craftercms.core.service.Context getCurrentContext()