org.sandev.basics.structs
Class CacheActionStruct

java.lang.Object
  org.sandev.basics.structs.CacheActionStruct

Direct Known Subclasses:

CacheAction

public class CacheActionStruct
extends java.lang.Object

A CacheAction is used for notification registration, and notifications, of changes to persistent message instances. By tracking changes, an application can ensure that its cached information remains in synch with the information recorded in the DataManager. CacheActions are sourced from, and registered with, a CacheManager, which is configured to work directly with the DataManager (or another CacheManager). For overview information on cache management, see Persist.html in the top level documentation.

CacheActions do not contain instance data. They are a notification that an instance has been changed. On receiving a CacheAction, most applications simply drop that instance from their cache.

Wildcard specification is allowed only for UNREGISTER actions. See the struct fields for details.

This message can be transmitted directly outside of a verb form.
This message implements the AuthUser interface using email as the username.
help text: NOHELPDISPLAY

Field Summary

protected int	action The caching action being done.
protected java.lang.String	messageClass The fully qualified classname of the message being being tracked.
protected long	revisionNumber The current revision number of the instance.
protected java.lang.String[]	sources The instance names of the sources requesting tracking updates.
protected long	uniqueID The uniqueID of the message instance being tracked.

Constructor Summary

CacheActionStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

action

protected int action

The caching action being done. Note that while REGISTER guarantees that a change notification will be sent, UNREGISTER does not guarantee notifications will not arrive. Notifications will stop being broadcast only after the last registered listener unregisters.

enumerated constant values:

• UNDEFINED("please specify a value") = 0
  Invalid value
• CHANGED("changed") = 1
  The instance has been modified
• DELETED("deleted") = 2
  The instance has been deleted
• DUMPED("dumped") = 3
  For CacheManager processing reasons, this instance has been dumped from tracking. It must be registered again if tracking is still necessary.
• REGISTER("register") = 4
  This source requests broadcast any updates of the specified instance.
• UNREGISTER("unregister") = 5
  This source no longer requires notification of changes to the specified instance.

uniqueID

protected long uniqueID

The uniqueID of the message instance being tracked.

Wildcarding: For UNREGISTER actions only, this field may be set to -1, meaning that any registrations matching the messageClass and source will be removed.

Wildcard matching on REGISTER actions is not allowed because the CacheManager would need to iterate and match instead of using a direct lookup. It also tends to cause unnecessary messaging. If your application requires significant pre-fetch caching, we recommend creating an appropriate struct declaration to hold the working set, and then handle cache registration local to the CacheManagerNode so that the multiple registration calls are handled locally.

messageClass

protected java.lang.String messageClass

The fully qualified classname of the message being being tracked.

Wildcarding: For UNREGISTER actions only, this field may be set to null or "", meaning that any registrations matching the source will be removed.

Length in characters, normal: 50 max: 255

revisionNumber

protected long revisionNumber

The current revision number of the instance. This is filled in with the latest revisionNumber by the CacheManager when an instance is CHANGED. There are no cache notifications sent when a new instance is added (since without a uniqueID it can't have been cached yet), and when an instance is deleted it doesn't matter what the revision number is anymore. This field is ignored on registration.

sources

protected java.lang.String[] sources

The instance names of the sources requesting tracking updates. For a REGISTER or UNREGISTER action, this array must have exactly one element in it, which is the instance name of the requesting node. A node can retrieve its instance name by calling

      getNodeInstance().getNodeInstanceName();
 

Within the CacheManager, this field serves as a reference count for the number of subscribers for a given notification, while supporting wildcard deregistration.

Constructor Detail

CacheActionStruct

public CacheActionStruct()