org.apache.jetspeed.prefs.impl
Class PreferencesImpl

java.lang.Object
  extended by java.util.prefs.Preferences
      extended by java.util.prefs.AbstractPreferences
          extended by org.apache.jetspeed.prefs.impl.PreferencesImpl

public class PreferencesImpl
extends java.util.prefs.AbstractPreferences

S Preferencesimplementation relying on Jetspeed OJB based persistence plugin.

Author:
David Le Strat

Field Summary
protected static PreferencesProvider prefsProvider
           
static int SYSTEM_NODE_TYPE
          System Preferences node type.
static int USER_NODE_TYPE
          User Preferences node type.
 
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
PreferencesImpl(PreferencesImpl parent, java.lang.String nodeName, int nodeType)
           Constructs a root node in the underlying datastore if they have not yet been created.
 
Method Summary
 java.lang.String[] childrenNamesSpi()
           
 java.util.prefs.AbstractPreferences childSpi(java.lang.String name)
           
 void flushSpi()
           
 Node getNode()
           getNode
 java.lang.String getSpi(java.lang.String key)
           
 java.lang.String[] keysSpi()
           
 void putSpi(java.lang.String key, java.lang.String value)
           
 void removeNodeSpi()
           
 void removeSpi(java.lang.String key)
           
static void setPreferencesProvider(PreferencesProvider prefsProvider)
           setPreferencesProvider
 void syncSpi()
           
 
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
 

Field Detail

USER_NODE_TYPE

public static final int USER_NODE_TYPE
User Preferences node type.

See Also:
Constant Field Values

SYSTEM_NODE_TYPE

public static final int SYSTEM_NODE_TYPE
System Preferences node type.

See Also:
Constant Field Values

prefsProvider

protected static PreferencesProvider prefsProvider
Constructor Detail

PreferencesImpl

public PreferencesImpl(PreferencesImpl parent,
                       java.lang.String nodeName,
                       int nodeType)
                throws java.lang.IllegalStateException

Constructs a root node in the underlying datastore if they have not yet been created.

Logs a warning if the underlying datastore is unavailable.

Parameters:
parent - The parent object.
nodeName - The node name.
nodeType - The node type.
Throws:
java.lang.IllegalStateException
Method Detail

childrenNamesSpi

public java.lang.String[] childrenNamesSpi()
                                    throws java.util.prefs.BackingStoreException
Specified by:
childrenNamesSpi in class java.util.prefs.AbstractPreferences
Throws:
java.util.prefs.BackingStoreException
See Also:
java.util.prefs.Preferences#childrenNamesSpi()

childSpi

public java.util.prefs.AbstractPreferences childSpi(java.lang.String name)
Specified by:
childSpi in class java.util.prefs.AbstractPreferences
See Also:
java.util.prefs.Preferences#childSpi(java.lang.String)

flushSpi

public void flushSpi()
              throws java.util.prefs.BackingStoreException
Specified by:
flushSpi in class java.util.prefs.AbstractPreferences
Throws:
java.util.prefs.BackingStoreException
See Also:
java.util.prefs.Preferences#flushSpi()

getSpi

public java.lang.String getSpi(java.lang.String key)
Specified by:
getSpi in class java.util.prefs.AbstractPreferences
See Also:
java.util.prefs.Preferences#getSpi(java.lang.String)

keysSpi

public java.lang.String[] keysSpi()
Specified by:
keysSpi in class java.util.prefs.AbstractPreferences
See Also:
java.util.prefs.Preferences#keysSpi()

putSpi

public void putSpi(java.lang.String key,
                   java.lang.String value)
Specified by:
putSpi in class java.util.prefs.AbstractPreferences
See Also:
java.util.prefs.Preferences#putSpi(java.lang.String, java.lang.String)

removeNodeSpi

public void removeNodeSpi()
                   throws java.util.prefs.BackingStoreException
Specified by:
removeNodeSpi in class java.util.prefs.AbstractPreferences
Throws:
java.util.prefs.BackingStoreException
See Also:
java.util.prefs.Preferences#removeNodeSpi()

removeSpi

public void removeSpi(java.lang.String key)
Specified by:
removeSpi in class java.util.prefs.AbstractPreferences
See Also:
java.util.prefs.Preferences#removeSpi(java.lang.String)

syncSpi

public void syncSpi()
             throws java.util.prefs.BackingStoreException
Specified by:
syncSpi in class java.util.prefs.AbstractPreferences
Throws:
java.util.prefs.BackingStoreException
See Also:
java.util.prefs.Preferences#syncSpi()

getNode

public Node getNode()

getNode

Returns:

setPreferencesProvider

public static void setPreferencesProvider(PreferencesProvider prefsProvider)

setPreferencesProvider

Sets the org.apache.jetspeed.prefs.PreferencesProvider that will support backing store operations for all PreferencesImpls

Parameters:
prefsProvider -


Copyright © 1999-2009 Apache Software Foundation. All Rights Reserved.