User Property Store

The User Property Store is a System Store table used for maintaining serialized Java objects associated with a key value. This is where persistent component parameters and properties, such as the Iterator State Store are maintained, as well as data you store.

For example, when you set the Iterator State Store parameter for the Active Directory Change Detection Connector, you are specifying the key value that the Connector uses to save and restore the Iterator state. If we want the Iteration to start with the first (or last) change entry, simply delete the Iterator State Store entry in the User Property Store; that is, click Delete next to the parameter.

We can persist our own objects with the following system calls:

system.setPersistentObject(keyValue,obj)

Saves the object obj in the User Property Store using the specified keyValue. The object is returned if it was saved successfully, otherwise the function returns null.

system.getPersistentObject(keyValue)

Returns the object with the specified keyValue from the User Property Store. If the keyValue is not found, then the function returns NULL.

system.deletePersistentObject(keyValue)

Delete the object with the specified keyValue in the User Property Store. This function returns the object that was deleted, or NULL if the keyValue was not found.

However, we can create and use our own stores using the Store Factory.

If you view the User Property Store from the System Store window, note that it has the following table definition:

Key

The unique key (512 chars)

Entry

The object associated with the key

Any object to be persisted in the User Property Store must be serializable.

Parent topic: System Store