org.apache.directory.server.core.prefs

Class ServerSystemPreferences

java.lang.Object

java.util.prefs.Preferences

java.util.prefs.AbstractPreferences

org.apache.directory.server.core.prefs.ServerSystemPreferences

public class ServerSystemPreferences
extends AbstractPreferences

A server side system Preferences implementation. This implementation presumes the creation of a root system preferences node in advance. This should be included with the system.ldif that is packaged with the server.

Version:

$Rev: 927839 $

Author:

Apache Directory Project

Field Summary

Fields inherited from class java.util.prefs.AbstractPreferences

lock, newNode

Fields inherited from class java.util.prefs.Preferences

MAX_KEY_LENGTH, MAX_NAME_LENGTH, MAX_VALUE_LENGTH

Constructor Summary

Constructors

Constructor and Description
ServerSystemPreferences(DirectoryService directoryService) Creates a preferences object for the system preferences root.
ServerSystemPreferences(ServerSystemPreferences parent, String name) Creates a preferences object using a relative name.

Method Summary

Methods

Modifier and Type	Method and Description
protected String[]	childrenNamesSpi()
protected AbstractPreferences	childSpi(String name)
void	close()
protected void	flushSpi()
protected String	getSpi(String key)
protected String[]	keysSpi()
protected void	putSpi(String key, String value)
protected void	removeNodeSpi()
protected void	removeSpi(String key)
protected void	syncSpi()
Dictionary<String,String>	wrapAsDictionary() Wraps this ServerPreferences object as a Dictionary.

Methods inherited from class java.util.prefs.AbstractPreferences

absolutePath, addNodeChangeListener, addPreferenceChangeListener, cachedChildren, childrenNames, clear, exportNode, exportSubtree, flush, get, getBoolean, getByteArray, getChild, getDouble, getFloat, getInt, getLong, isRemoved, isUserNode, keys, name, node, nodeExists, parent, put, putBoolean, putByteArray, putDouble, putFloat, putInt, putLong, remove, removeNode, removeNodeChangeListener, removePreferenceChangeListener, sync, toString

Methods inherited from class java.util.prefs.Preferences

importPreferences, systemNodeForPackage, systemRoot, userNodeForPackage, userRoot

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerSystemPreferences

public ServerSystemPreferences(DirectoryService directoryService)

Creates a preferences object for the system preferences root.

Parameters:

directoryService - the directory service core

ServerSystemPreferences

public ServerSystemPreferences(ServerSystemPreferences parent,
                       String name)

Creates a preferences object using a relative name.

Parameters:

name - the name of the preference node to create

parent - the parent of the preferences node to create

Method Detail

close

public void close()
           throws org.apache.directory.shared.ldap.exception.LdapException

Throws:

org.apache.directory.shared.ldap.exception.LdapException

wrapAsDictionary

public Dictionary<String,String> wrapAsDictionary()

Wraps this ServerPreferences object as a Dictionary.

Returns:

a Dictionary that uses this ServerPreferences object as the underlying backing store

flushSpi

protected void flushSpi()
                 throws BackingStoreException

Specified by:

flushSpi in class AbstractPreferences

Throws:

BackingStoreException

removeNodeSpi

protected void removeNodeSpi()
                      throws BackingStoreException

Specified by:

removeNodeSpi in class AbstractPreferences

Throws:

BackingStoreException

syncSpi

protected void syncSpi()
                throws BackingStoreException

Specified by:

syncSpi in class AbstractPreferences

Throws:

BackingStoreException

childrenNamesSpi

protected String[] childrenNamesSpi()
                             throws BackingStoreException

Specified by:

childrenNamesSpi in class AbstractPreferences

Throws:

BackingStoreException

keysSpi

protected String[] keysSpi()
                    throws BackingStoreException

Specified by:

keysSpi in class AbstractPreferences

Throws:

BackingStoreException

removeSpi

protected void removeSpi(String key)

Specified by:

removeSpi in class AbstractPreferences

getSpi

protected String getSpi(String key)

Specified by:

getSpi in class AbstractPreferences

putSpi

protected void putSpi(String key,
          String value)

Specified by:

putSpi in class AbstractPreferences

childSpi

protected AbstractPreferences childSpi(String name)

Specified by:

childSpi in class AbstractPreferences