public class Settings extends DefaultFilter implements ExtensionsFilter
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
.
Modifier and Type | Field and Description |
---|---|
private Presets.Preset |
disabledExtensionPoints |
private Presets.Preset |
disabledExtensions |
private java.io.File |
file |
private boolean |
hasChanged |
private Presets.Preset |
ignoredFiles |
private Presets.Preset |
installedFiles |
private ExtensionsManager |
manager |
private Presets |
presets |
private Presets.Preset |
settings |
INDEX_COMPARATOR_CTX, INDEX_COMPARATOR_EXT
Constructor and Description |
---|
Settings(ExtensionsManager manager,
java.io.File file)
Create a new Settings object.
|
Modifier and Type | Method and Description |
---|---|
void |
enableExtension(java.lang.String extensionId,
boolean enable)
Enable/disable an extension.
|
void |
enableExtensionPoint(java.lang.String extensionPointId,
boolean enable)
Enable/disable an extension point.
|
java.util.List<java.io.File> |
getIgnoredFiles()
Get a list with all files that are ignored.
|
java.util.List<java.io.File> |
getInstalledFiles()
Get a list with all files that are installed.
|
java.lang.String |
getSetting(java.lang.String extensionId,
java.lang.String key)
Get a configuration setting for an extension.
|
Presets.Preset |
getSettingsForExtension(java.lang.String extensionId)
Get a preset containing settings for the given extesion.
|
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 |
isIgnoredFile(java.io.File file)
Check if the given file is marked as ignored.
|
boolean |
isInstalledFile(java.io.File file)
Check if the given file is marked as installed.
|
void |
save()
Save the settings to disk.
|
void |
setIgnoredFile(java.io.File file,
boolean ignore)
Mark the given file as ignored/not ignored by the extension system.
|
void |
setInstalledFile(java.io.File file)
Mark the given file as installed by the extension system.
|
void |
setSetting(java.lang.String extensionId,
java.lang.String key,
java.lang.String value)
Set a configuration setting for an extension.
|
void |
setUninstalledFile(java.io.File file)
Mark the given file as uninstalled.
|
sort
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
sort
private final java.io.File file
private final ExtensionsManager manager
private boolean hasChanged
private Presets presets
private Presets.Preset settings
private Presets.Preset installedFiles
private Presets.Preset ignoredFiles
private Presets.Preset disabledExtensions
private Presets.Preset disabledExtensionPoints
Settings(ExtensionsManager manager, java.io.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.public boolean isEnabled(ExtensionPoint<?> extensionPoint)
ExtensionsFilter
isEnabled
in interface ExtensionsFilter
isEnabled
in class DefaultFilter
extensionPoint
- The extension point to checkpublic boolean isEnabled(Extension<?> extension)
ExtensionsFilter
isEnabled
in interface ExtensionsFilter
isEnabled
in class DefaultFilter
extension
- The extension to checkpublic void enableExtension(java.lang.String extensionId, boolean enable)
extensionId
- The ID of the extension to enable/disableenable
- TRUE to enable the extension, FALSE to disable itpublic void enableExtensionPoint(java.lang.String extensionPointId, boolean enable)
extensionPointId
- The ID of the extension point to enable/disableenable
- TRUE to enable the extension point, FALSE to disable itpublic Presets.Preset getSettingsForExtension(java.lang.String extensionId)
setSetting(String, String, String)
to set values.public void setSetting(java.lang.String extensionId, java.lang.String key, java.lang.String value)
save()
.extensionId
- The ID of the extension to save a setting forkey
- The name of the settingvalue
- The value of the setting, use null to removepublic java.lang.String getSetting(java.lang.String extensionId, java.lang.String key)
extensionId
- The ID of the extension to save a setting forkey
- The name of the settingpublic boolean isInstalledFile(java.io.File file)
public void setInstalledFile(java.io.File file)
public void setUninstalledFile(java.io.File file)
public java.util.List<java.io.File> getInstalledFiles()
public boolean isIgnoredFile(java.io.File file)
public void setIgnoredFile(java.io.File file, boolean ignore)
public java.util.List<java.io.File> getIgnoredFiles()
public void save()