com.ibm.ras.mgr
Class RASPropertyDataStore

java.lang.Object
  |
  +--com.ibm.ras.mgr.RASPropertyDataStore

public class RASPropertyDataStore
extends java.lang.Object
implements RASIDataStore

RASPropertyDataStore is an implementation of the RASIDataStore interface which uses a properties file of a specific format to contain the RAS configuration. The file com.ibm.ras.samples.RASSampleDataStore.properties describes this format.

See Also:
RASIDataStore

Constructor Summary
RASPropertyDataStore(java.util.Properties props)
          Creates a RASPropertyDataStore.
RASPropertyDataStore(java.lang.String name)
          Creates a RASPropertyDataStore.
 
Method Summary
 java.util.Properties getPropertyDataStore()
          Gets the properties file used as the persistent data store.
 void restoreConfig(RASBaseGroup baseGroup)
          Restores the RASManager configuration from persistent storage.
 void saveConfig(RASBaseGroup baseGroup)
          Saves the RASManager configuration to persistent storage.
 void setPropertyDataStore(java.util.Properties props)
          Sets the properties file used as the persistent data store.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RASPropertyDataStore

public RASPropertyDataStore(java.util.Properties props)
Creates a RASPropertyDataStore.
Parameters:
props - The persistent store, a Properties file.

RASPropertyDataStore

public RASPropertyDataStore(java.lang.String name)
                     throws java.io.IOException
Creates a RASPropertyDataStore.
Parameters:
name - The name of the properties file containing the configuration. The properties file is loaded through the method Class.getResourceAsStream. The name must conform to the conventions of this method.
Throws:
java.io.IOException - An IOException is thrown if the file cannot be opened.
Method Detail

getPropertyDataStore

public java.util.Properties getPropertyDataStore()
Gets the properties file used as the persistent data store.
Returns:
The properties file

setPropertyDataStore

public void setPropertyDataStore(java.util.Properties props)
Sets the properties file used as the persistent data store.
Parameters:
props - The properties file

restoreConfig

public void restoreConfig(RASBaseGroup baseGroup)
Restores the RASManager configuration from persistent storage. This method is called automatically when the RASManager is created and can be called anytime the stored configuration should be reloaded.
Specified by:
restoreConfig in interface RASIDataStore
Parameters:
baseGroup - The RASBaseGroup which holds the configuration loaded from persistent store.

saveConfig

public void saveConfig(RASBaseGroup baseGroup)
Saves the RASManager configuration to persistent storage.

This particular implementation assumes that the persistent store is static -- it cannot be updated. This method does nothing.

Specified by:
saveConfig in interface RASIDataStore
Parameters:
baseGroup - The RASBaseGroup which holds the configuration to be saved in persistent store.