|
3.2.1: 2012-12-13 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.basedb.util.extensions.DefaultFilter
net.sf.basedb.util.extensions.manager.Settings
public class Settings
Class for keeping settings for the extensions system. Settings
are kept in the settings.xml
file in the plug-ins
directory.
Extension points and extensions can be disabled/enabled by
enableExtensionPoint(String, boolean)
and
enableExtension(String, boolean)
.
This class also implements the ExtensionsFilter
interface, and can be used on the
Registry.useExtensions(net.sf.basedb.util.extensions.ClientContext, ExtensionsFilter, String...)
method. This means that disabling/enabling extensions and extension points
will immediately be visible in the web interface. Sorting is delegated
to the DefaultFilter
.
Field Summary | |
---|---|
private Presets.Preset |
disabledExtensionPoints
|
private Presets.Preset |
disabledExtensions
|
private File |
file
|
private boolean |
hasChanged
|
private Presets.Preset |
installedFiles
|
private ExtensionsManager |
manager
|
private Presets |
presets
|
private Presets.Preset |
settings
|
Fields inherited from class net.sf.basedb.util.extensions.DefaultFilter |
---|
INDEX_COMPARATOR_CTX, INDEX_COMPARATOR_EXT |
Constructor Summary | |
---|---|
Settings(ExtensionsManager manager,
File file)
Create a new Settings object. |
Method Summary | |
---|---|
void |
enableExtension(String extensionId,
boolean enable)
Enable/disable an extension. |
void |
enableExtensionPoint(String extensionPointId,
boolean enable)
Enable/disable an extension point. |
List<File> |
getInstalledFiles()
Get a list with all files that are installed. |
boolean |
isEnabled(Extension extension)
Check if an extension is enabled or disabled. |
boolean |
isEnabled(ExtensionPoint extensionPoint)
Check if an extension point is enabled or disabled. |
boolean |
isInstalledFile(File file)
Check if the given file is marked as installed. |
void |
save()
Save the settings to disk. |
void |
setInstalledFile(File file)
Mark the given file as installed by the extension system. |
void |
setUninstalledFile(File file)
Mark the given file as uninstalled. |
Methods inherited from class net.sf.basedb.util.extensions.DefaultFilter |
---|
sort |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface net.sf.basedb.util.extensions.ExtensionsFilter |
---|
sort |
Field Detail |
---|
private final File file
private final ExtensionsManager manager
private boolean hasChanged
private Presets presets
private Presets.Preset settings
private Presets.Preset installedFiles
private Presets.Preset disabledExtensions
private Presets.Preset disabledExtensionPoints
Constructor Detail |
---|
Settings(ExtensionsManager manager, File file)
save()
is called. The settings file
must be an XML file that can be read by the Presets
class.
file
- The file to load/save settings in. If null, settings only are
kept in memory and are lost when the server is shutdown.Method Detail |
---|
public boolean isEnabled(ExtensionPoint extensionPoint)
ExtensionsFilter
isEnabled
in interface ExtensionsFilter
isEnabled
in class DefaultFilter
extensionPoint
- The extension point to check
public boolean isEnabled(Extension extension)
ExtensionsFilter
isEnabled
in interface ExtensionsFilter
isEnabled
in class DefaultFilter
extension
- The extension to check
public void enableExtension(String extensionId, boolean enable)
extensionId
- The ID of the extension to enable/disableenable
- TRUE to enable the extension, FALSE to disable itpublic void enableExtensionPoint(String extensionPointId, boolean enable)
extensionPointId
- The ID of the extension point to enable/disableenable
- TRUE to enable the extension point, FALSE to disable itpublic boolean isInstalledFile(File file)
public void setInstalledFile(File file)
public void setUninstalledFile(File file)
public List<File> getInstalledFiles()
public void save()
|
3.2.1: 2012-12-13 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |