Class PropertiesPluginDescriptorFinder

java.lang.Object

org.pf4j.PropertiesPluginDescriptorFinder

All Implemented Interfaces:

PluginDescriptorFinder

public class PropertiesPluginDescriptorFinder
extends Object
implements PluginDescriptorFinder

Find a plugin descriptor in a properties file (in plugin repository).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PROPERTIES_FILE_NAME
private static final org.slf4j.Logger	log
static final String	PLUGIN_CLASS
static final String	PLUGIN_DEPENDENCIES
static final String	PLUGIN_DESCRIPTION
static final String	PLUGIN_ID
static final String	PLUGIN_LICENSE
static final String	PLUGIN_PROVIDER
static final String	PLUGIN_REQUIRES
static final String	PLUGIN_VERSION
protected String	propertiesFileName

Constructor Summary

Constructors

Constructor	Description
PropertiesPluginDescriptorFinder()
PropertiesPluginDescriptorFinder(String propertiesFileName)

Method Summary

Modifier and Type	Method	Description
protected PluginDescriptor	createPluginDescriptor(Properties properties)
protected DefaultPluginDescriptor	createPluginDescriptorInstance()
PluginDescriptor	find(Path pluginPath)
protected Path	getPropertiesPath(Path pluginPath, String propertiesFileName)
boolean	isApplicable(Path pluginPath)	Returns true if this finder is applicable to the given Path.
protected Properties	readProperties(Path pluginPath)

Methods inherited from class Object

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

Field Details

log

private static final org.slf4j.Logger log

DEFAULT_PROPERTIES_FILE_NAME

public static final String DEFAULT_PROPERTIES_FILE_NAME

See Also:

• Constant Field Values

PLUGIN_ID

public static final String PLUGIN_ID

See Also:

• Constant Field Values

PLUGIN_DESCRIPTION

public static final String PLUGIN_DESCRIPTION

See Also:

• Constant Field Values

PLUGIN_CLASS

public static final String PLUGIN_CLASS

See Also:

• Constant Field Values

PLUGIN_VERSION

public static final String PLUGIN_VERSION

See Also:

• Constant Field Values

PLUGIN_PROVIDER

public static final String PLUGIN_PROVIDER

See Also:

• Constant Field Values

PLUGIN_DEPENDENCIES

public static final String PLUGIN_DEPENDENCIES

See Also:

• Constant Field Values

PLUGIN_REQUIRES

public static final String PLUGIN_REQUIRES

See Also:

• Constant Field Values

PLUGIN_LICENSE

public static final String PLUGIN_LICENSE

See Also:

• Constant Field Values

propertiesFileName

protected String propertiesFileName

Constructor Details

PropertiesPluginDescriptorFinder

public PropertiesPluginDescriptorFinder()

PropertiesPluginDescriptorFinder

public PropertiesPluginDescriptorFinder(String propertiesFileName)

Method Details

isApplicable

public boolean isApplicable(Path pluginPath)

Description copied from interface: PluginDescriptorFinder

Returns true if this finder is applicable to the given Path.

Specified by:

isApplicable in interface PluginDescriptorFinder

find

public PluginDescriptor find(Path pluginPath)

Specified by:

find in interface PluginDescriptorFinder

readProperties

protected Properties readProperties(Path pluginPath)

getPropertiesPath

protected Path getPropertiesPath(Path pluginPath,
 String propertiesFileName)

createPluginDescriptor

protected PluginDescriptor createPluginDescriptor(Properties properties)

createPluginDescriptorInstance

protected DefaultPluginDescriptor createPluginDescriptorInstance()