Package org.restheart.plugins

Class PluginRecord<T extends Plugin>

java.lang.Object

org.restheart.plugins.PluginRecord<T>

Type Parameters:

T - generic type

public class PluginRecord<T extends Plugin>
extends Object

Author:

Andrea Di Cesare <andrea@softinstigate.com>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PLUGIN_ENABLED_KEY	The key to enable plugins
static final String	PLUGIN_SECURE_KEY

Constructor Summary

Constructors

Constructor	Description
PluginRecord(String name, String description, boolean secure, boolean enabledByDefault, String className, T instance, Map<String,Object> confArgs)

Method Summary

Modifier and Type	Method	Description
String	getClassName()
Map<String,Object>	getConfArgs()
String	getDescription()
T	getInstance()
String	getName()
boolean	isEnabled()
static boolean	isEnabled(boolean enabledByDefault, Map<String,Object> confArgs)
boolean	isSecure()
static boolean	isSecure(boolean secure, Map<String,Object> confArgs)

Methods inherited from class java.lang.Object

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

Field Details

PLUGIN_ENABLED_KEY

public static final String PLUGIN_ENABLED_KEY

The key to enable plugins

See Also:

• Constant Field Values

PLUGIN_SECURE_KEY

public static final String PLUGIN_SECURE_KEY

See Also:

• Constant Field Values

Constructor Details

PluginRecord

public PluginRecord(String name,
 String description,
 boolean secure,
 boolean enabledByDefault,
 String className,
 T instance,
 Map<String,Object> confArgs)

Method Details

getName

public String getName()

Returns:

the name

getDescription

public String getDescription()

Returns:

the description

getClassName

public String getClassName()

Returns:

the className

isSecure

public boolean isSecure()

Returns:

true if secure taking into accout the configuration overrides

isEnabled

public boolean isEnabled()

Returns:

true if enabled taking into accout the configuration overrides

isEnabled

public static boolean isEnabled(boolean enabledByDefault,
 Map<String,Object> confArgs)

Parameters:

enabledByDefault -

confArgs -

Returns:

true if enabled taking into accout the configuration overrides

isSecure

public static boolean isSecure(boolean secure,
 Map<String,Object> confArgs)

Parameters:

secure -

confArgs -

Returns:

true if secure taking into accout the configuration overrides

getConfArgs

public Map<String,Object> getConfArgs()

Returns:

the confArgs

getInstance

public T getInstance()

Returns:

the instance