|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IConfigStore
An interface represents a configuration store. A configuration store is an abstraction of a hierarchical store to keep arbitrary data indexed by string names.
In the following example:
param1=value1 configStore1.param11=value11 configStore1.param12=value12 configStore1.subStore1.param111=value111 configStore1.subStore1.param112=value112 configStore2.param21=value21The top config store has parameters param1 and sub-stores configStore1 and configStore2.
// the top config store is passed to the following method. public void init(IConfigStore config) throws EBaseException { IConfigStore store = config; String valx = config.getString("param1"); // valx is "value1"IConfigStore substore1 = config.getSubstore("configStore1"); String valy = substore1.getString("param11"); // valy is "value11"
IConfigStore substore2 = config.getSubstore("configStore2"); String valz = substore2.getString("param21"); // valz is "value21"
}
Method Summary | |
---|---|
void |
commit(boolean createBackup)
Commits all the data into file immediately. |
java.math.BigInteger |
getBigInteger(java.lang.String name)
Retrieves the given property as a big integer. |
java.math.BigInteger |
getBigInteger(java.lang.String name,
java.math.BigInteger defval)
Retrieves the given property as a big integer. |
boolean |
getBoolean(java.lang.String name)
Retrieves the given property as a boolean. |
boolean |
getBoolean(java.lang.String name,
boolean defval)
Retrieves the given property as a boolean. |
byte[] |
getByteArray(java.lang.String name)
Retrieves the value of a property as a byte array. |
byte[] |
getByteArray(java.lang.String name,
byte[] defval)
Retrieves the value of a property as a byte array, using the given default value if property is not present. |
int |
getInteger(java.lang.String name)
Retrieves the given property as an integer. |
int |
getInteger(java.lang.String name,
int defval)
Retrieves the given property as an integer. |
java.lang.String |
getName()
Gets the name of this Configuration Store. |
java.util.Enumeration |
getPropertyNames()
Retrives and enumeration of all properties in this config-store. |
java.lang.String |
getString(java.lang.String name)
Retrieves the value of the given property as a string. |
java.lang.String |
getString(java.lang.String name,
java.lang.String defval)
Retrieves the value of a given property as a string or the given default value if the property is not present. |
IConfigStore |
getSubStore(java.lang.String name)
Retrieves the given sub-store. |
java.util.Enumeration |
getSubStoreNames()
Returns an enumeration of the names of the substores of this config-store. |
IConfigStore |
makeSubStore(java.lang.String name)
Creates a nested sub-store with the specified name. |
void |
putBigInteger(java.lang.String name,
java.math.BigInteger value)
Sets a property and its value as an integer. |
void |
putBoolean(java.lang.String name,
boolean value)
Stores the given property and its value as a boolean. |
void |
putByteArray(java.lang.String name,
byte[] value)
Stores the given property and value as a byte array. |
void |
putInteger(java.lang.String name,
int value)
Sets a property and its value as an integer. |
void |
putString(java.lang.String name,
java.lang.String value)
Stores a property and its value as a string. |
void |
remove(java.lang.String name)
|
void |
removeSubStore(java.lang.String name)
Removes sub-store with the given name. |
int |
size()
Return the number of items in this substore |
Methods inherited from interface com.netscape.certsrv.base.ISourceConfigStore |
---|
get, keys, load, put, save |
Method Detail |
---|
java.lang.String getName()
java.lang.String getString(java.lang.String name) throws EPropertyNotFound, EBaseException
name
- The name of the property to get
EPropertyNotFound
- If the property is not present
EBaseException
- If an internal error occurredjava.lang.String getString(java.lang.String name, java.lang.String defval) throws EBaseException
name
- The property to retrivedefval
- The default value to return if the property is not present
EBaseException
- If an internal error occurredvoid putString(java.lang.String name, java.lang.String value)
name
- The name of the propertyvalue
- The value as a stringbyte[] getByteArray(java.lang.String name) throws EPropertyNotFound, EBaseException
name
- The property name
EPropertyNotFound
- If the property is not present
EBaseException
- If an internal error occurredbyte[] getByteArray(java.lang.String name, byte[] defval) throws EBaseException
name
- The name of the propertydefval
- The default value if the property is not present.
EBaseException
- If an internal error occurredvoid putByteArray(java.lang.String name, byte[] value)
name
- The property namevalue
- The value as a byte array to storeboolean getBoolean(java.lang.String name) throws EPropertyNotFound, EBaseException
name
- The name of the property as a string.
EPropertyNotFound
- If the property is not present
EBaseException
- If an internal error occurredboolean getBoolean(java.lang.String name, boolean defval) throws EBaseException
name
- The name of the propertydefval
- The default value to turn as a boolean if
property is not present
EBaseException
- If an internal error occurredvoid putBoolean(java.lang.String name, boolean value)
name
- The property namevalue
- The value as a booleanint getInteger(java.lang.String name) throws EPropertyNotFound, EBaseException
name
- The property name
EPropertyNotFound
- If property is not found
EBaseException
- If an internal error occurredint getInteger(java.lang.String name, int defval) throws EBaseException
name
- The property name
EBaseException
- If the value cannot be converted to a
integervoid putInteger(java.lang.String name, int value)
name
- parameter namevalue
- integer valuejava.math.BigInteger getBigInteger(java.lang.String name) throws EPropertyNotFound, EBaseException
name
- The property name
EPropertyNotFound
- If property is not found
EBaseException
- If an internal error occurredjava.math.BigInteger getBigInteger(java.lang.String name, java.math.BigInteger defval) throws EBaseException
name
- The property name
EBaseException
- If the value cannot be converted to a
integervoid putBigInteger(java.lang.String name, java.math.BigInteger value)
name
- parameter namevalue
- big integer valueIConfigStore makeSubStore(java.lang.String name)
name
- The name of the sub-store
IConfigStore getSubStore(java.lang.String name)
name
- The name of the sub-store
void removeSubStore(java.lang.String name)
name
- The name of the sub-store to removevoid remove(java.lang.String name)
java.util.Enumeration getPropertyNames()
java.util.Enumeration getSubStoreNames()
void commit(boolean createBackup) throws EBaseException
createBackup
- true if a backup file should be created
EBaseException
- failed to commitint size()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |