Package org.bgerp.plugin.kernel

Class Plugin

java.lang.Object

ru.bgcrm.plugin.Plugin

org.bgerp.plugin.kernel.Plugin

public class Plugin
extends Plugin

Special plugin for application's kernel.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ID

Fields inherited from class ru.bgcrm.plugin.Plugin

PATH_CSS, PATH_JS

Constructor Summary

Constructors

Constructor	Description
Plugin()

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	getActionPackages()	Packages for searching annotated actions.
java.util.Set<java.lang.String>	getObjectTypes()	Plugin's entities.
java.util.Set<Table>	getTables()	Used DB tables.
java.util.Set<java.lang.String>	getUnusedPaths()	Outdated path, used by plugin.
boolean	isEnabled(ParameterMap config, java.lang.String defaultValue)	If the plugin enabled.
boolean	isSystem()	System plugins are always loaded, enabled and not show in the list.

Methods inherited from class ru.bgcrm.plugin.Plugin

getDependencies, getDocument, getEndpoints, getId, getLanguages, getLocalizer, getName, getResourcePath, getXml, init, loadEndpoints

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

Plugin

public Plugin()

Method Detail

isSystem

public boolean isSystem()

Description copied from class: Plugin

System plugins are always loaded, enabled and not show in the list.

Overrides:

isSystem in class Plugin

Returns:

isEnabled

public boolean isEnabled(ParameterMap config,
                         java.lang.String defaultValue)

Description copied from class: Plugin

If the plugin enabled.

Overrides:

isEnabled in class Plugin

Parameters:

config - configuration, where the plugin can be explicitly enabled.

defaultValue - default value if not explicitly enabled: '1' - enabled, 'lic' - if presented in license.

Returns:

true or false.

getActionPackages

public java.util.Set<java.lang.String> getActionPackages()

Description copied from class: Plugin

Packages for searching annotated actions.

Overrides:

getActionPackages in class Plugin

Returns:

getTables

public java.util.Set<Table> getTables()

Description copied from class: Plugin

Used DB tables.

Overrides:

getTables in class Plugin

Returns:

getObjectTypes

public java.util.Set<java.lang.String> getObjectTypes()

Description copied from class: Plugin

Plugin's entities.

Overrides:

getObjectTypes in class Plugin

Returns:

getUnusedPaths

public java.util.Set<java.lang.String> getUnusedPaths()

Description copied from class: Plugin

Outdated path, used by plugin. Related to the application's root directory. May be used for cleaning up of old files and directories. TODO: For webapps is used separated logic.

Overrides:

getUnusedPaths in class Plugin

Returns: