Package org.jivesoftware.openfire.pubsub

Class CachingPubsubPersistenceProvider

java.lang.Object

org.jivesoftware.openfire.pubsub.CachingPubsubPersistenceProvider

All Implemented Interfaces:

PubSubPersistenceProvider

public class CachingPubsubPersistenceProvider
extends Object
implements PubSubPersistenceProvider

A persistence provider for Pub/Sub functionality that adds caching behavior. Instead of 'writing through' to the persistence layer, the caching implementation will create batches of operations (optimizing away redundant actions). Additionally, recently accessed published data items are cached. This improves performance when processing many pub/sub operations (node modifications, item publications, etc). This provider itself does not persist data. Instead, it uses a different persistence provider as a delegate to perform these actions.

Author:

Guus der Kinderen, guus@goodbytes.nl

Field Summary

Fields

Modifier and Type	Field	Description
static final SystemProperty<Class>	DELEGATE	The class definition used to instantiate the delegate, used by this instance to interact with persistent data storage.
static final SystemProperty<Duration>	FLUSH_TIMER_DELAY	Flush timer delay is configurable, but not less than 20 seconds (default: 2 mins)
static final SystemProperty<Integer>	MAX_ITEMS_FLUSH	Maximum number of published items allowed in the write cache before being flushed to the database.

Constructor Summary

Constructors

Constructor	Description
CachingPubsubPersistenceProvider()

Method Summary

Modifier and Type	Method	Description
void	bulkPublishedItems(List<PublishedItem> addList, List<PublishedItem> delList)	Writes large changesets, using batches and transactions when available.
void	createAffiliation(Node node, NodeAffiliate affiliate)	Creates a new affiliation of the user in the node.
void	createDefaultConfiguration(PubSubService.UniqueIdentifier serviceIdentifier, DefaultNodeConfiguration config)	Creates a new default node configuration for the specified service.
void	createNode(Node node)	Schedules the node to be created in the database.
void	createSubscription(Node node, NodeSubscription subscription)	Adds the new subscription of the user to the node to the database.
Set<Node.UniqueIdentifier>	findDirectlySubscribedNodes(org.xmpp.packet.JID address)	Returns identifiers for all pubsub nodes to which the provided address is a direct subscriber.
void	flushPendingChanges(boolean sendToCluster)	Persists any changes that have been applied to the caches by invoking the relevant methods of the delegate.
void	flushPendingChanges(Node.UniqueIdentifier nodeUniqueId)
void	flushPendingChanges(Node.UniqueIdentifier nodeUniqueId, boolean sendToCluster)
PublishedItem	getLastPublishedItem(LeafNode node)	Fetches the last published item (by creation date) for the specified node.
PublishedItem	getPublishedItem(LeafNode node, PublishedItem.UniqueIdentifier itemIdentifier)	Fetches a published item (by ID) for a node.
List<PublishedItem>	getPublishedItems(LeafNode node)	Fetches all the results for the specified node, limited by LeafNode.getMaxPublishedItems().
List<PublishedItem>	getPublishedItems(LeafNode node, int maxRows)	Fetches all the results for the specified node, limited by LeafNode.getMaxPublishedItems().
void	initialize()	Starts the provider.
DefaultNodeConfiguration	loadDefaultConfiguration(PubSubService.UniqueIdentifier serviceIdentifier, boolean isLeafType)	Loads from the database the default node configuration for the specified node type and pubsub service.
void	loadNode(PubSubService service, Node.UniqueIdentifier nodeIdentifier)	Loads all nodes from the database and adds them to the PubSub service.
void	loadNodes(PubSubService service)	Loads all nodes from the database and adds them to the PubSub service.
PEPService	loadPEPServiceFromDB(org.xmpp.packet.JID jid)	Loads a PEP service from the database, if it exists.
void	loadSubscription(Node node, String subId)	Loads a subscription from the database, storing it in the provided node.
void	purgeNode(LeafNode leafNode)	Deletes all published items of a node.
void	removeAffiliation(Node node, NodeAffiliate affiliate)	Removes the affiliation and subscription state of the user from the DB.
void	removeNode(Node node)	Schedules the node to be removed in the database.
void	removePublishedItem(PublishedItem item)	Removes the specified published item from the DB.
void	removeSubscription(NodeSubscription subscription)	Removes the subscription of the user from the DB.
void	savePublishedItem(PublishedItem item)	Creates and stores the published item in the database.
void	shutdown()	Stops the provider.
void	updateAffiliation(Node node, NodeAffiliate affiliate)	Updates an affiliation of the user in the node.
void	updateDefaultConfiguration(PubSubService.UniqueIdentifier serviceIdentifier, DefaultNodeConfiguration config)	Updates the default node configuration for the specified service.
void	updateNode(Node node)	Schedules the node to be updated in the database.
void	updateSubscription(Node node, NodeSubscription subscription)	Updates the subscription of the user to the node to the database.

Methods inherited from class java.lang.Object

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

Field Details

DELEGATE

public static final SystemProperty<Class> DELEGATE

The class definition used to instantiate the delegate, used by this instance to interact with persistent data storage.

FLUSH_TIMER_DELAY

public static final SystemProperty<Duration> FLUSH_TIMER_DELAY

Flush timer delay is configurable, but not less than 20 seconds (default: 2 mins)

MAX_ITEMS_FLUSH

public static final SystemProperty<Integer> MAX_ITEMS_FLUSH

Maximum number of published items allowed in the write cache before being flushed to the database.

Constructor Details

CachingPubsubPersistenceProvider

public CachingPubsubPersistenceProvider()

Method Details

initialize

public void initialize()

Description copied from interface: PubSubPersistenceProvider

Starts the provider. This method is invoked before the provider is used to interact with the backend datastore.

Specified by:

initialize in interface PubSubPersistenceProvider

shutdown

public void shutdown()

Description copied from interface: PubSubPersistenceProvider

Stops the provider. This method is invoked when the system is to be shut down. The provider should not be used after this method is invoked.

Specified by:

shutdown in interface PubSubPersistenceProvider

createNode

public void createNode(Node node)

Description copied from interface: PubSubPersistenceProvider

Schedules the node to be created in the database.

Specified by:

createNode in interface PubSubPersistenceProvider

Parameters:

node - The newly created node.

updateNode

public void updateNode(Node node)

Description copied from interface: PubSubPersistenceProvider

Schedules the node to be updated in the database.

Specified by:

updateNode in interface PubSubPersistenceProvider

Parameters:

node - The updated node.

removeNode

public void removeNode(Node node)

Description copied from interface: PubSubPersistenceProvider

Schedules the node to be removed in the database.

Specified by:

removeNode in interface PubSubPersistenceProvider

Parameters:

node - The node that is being deleted.

loadNodes

public void loadNodes(PubSubService service)

Description copied from interface: PubSubPersistenceProvider

Loads all nodes from the database and adds them to the PubSub service.

Specified by:

loadNodes in interface PubSubPersistenceProvider

Parameters:

service - the pubsub service that is hosting the nodes.

loadNode

public void loadNode(PubSubService service,
 Node.UniqueIdentifier nodeIdentifier)

Description copied from interface: PubSubPersistenceProvider

Loads all nodes from the database and adds them to the PubSub service.

Specified by:

loadNode in interface PubSubPersistenceProvider

Parameters:

service - the pubsub service that is hosting the nodes.

nodeIdentifier - the identifier of the node to load.

loadSubscription

public void loadSubscription(Node node,
 String subId)

Description copied from interface: PubSubPersistenceProvider

Loads a subscription from the database, storing it in the provided node.

Specified by:

loadSubscription in interface PubSubPersistenceProvider

Parameters:

node - The node for which a subscription is to be loaded from the database.

subId - The identifier of the subscription that is to be loaded from the database.

findDirectlySubscribedNodes

@Nonnull
public Set<Node.UniqueIdentifier> findDirectlySubscribedNodes(@Nonnull
 org.xmpp.packet.JID address)

Description copied from interface: PubSubPersistenceProvider

Returns identifiers for all pubsub nodes to which the provided address is a direct subscriber. Note that the results do not include nodes to which the provided address is a subscriber through inheritance! The result can include root nodes, (other) collection nodes as well as leaf nodes. When a node is subscribed to using a full JID, that node will be returned only if the address used as an argument in this method matches that full JID. If the node was subscribed to using a bare JID, it will be returned when the provided argument's bare JID representation matches the JID used for the subscription.

Specified by:

findDirectlySubscribedNodes in interface PubSubPersistenceProvider

Parameters:

address - The address (bare of full JID) for which to return nodes.

Returns:

A collection of node identifiers, possibly empty.

createAffiliation

public void createAffiliation(Node node,
 NodeAffiliate affiliate)

Description copied from interface: PubSubPersistenceProvider

Creates a new affiliation of the user in the node.

Specified by:

createAffiliation in interface PubSubPersistenceProvider

Parameters:

node - The node where the affiliation of the user was updated.

affiliate - The new affiliation of the user in the node.

updateAffiliation

public void updateAffiliation(Node node,
 NodeAffiliate affiliate)

Description copied from interface: PubSubPersistenceProvider

Updates an affiliation of the user in the node.

Specified by:

updateAffiliation in interface PubSubPersistenceProvider

Parameters:

node - The node where the affiliation of the user was updated.

affiliate - The new affiliation of the user in the node.

removeAffiliation

public void removeAffiliation(Node node,
 NodeAffiliate affiliate)

Description copied from interface: PubSubPersistenceProvider

Removes the affiliation and subscription state of the user from the DB.

Specified by:

removeAffiliation in interface PubSubPersistenceProvider

Parameters:

node - The node where the affiliation of the user was updated.

affiliate - The existing affiliation and subsription state of the user in the node.

createSubscription

public void createSubscription(Node node,
 NodeSubscription subscription)

Description copied from interface: PubSubPersistenceProvider

Adds the new subscription of the user to the node to the database.

Specified by:

createSubscription in interface PubSubPersistenceProvider

Parameters:

node - The node where the user has subscribed to.

subscription - The new subscription of the user to the node.

updateSubscription

public void updateSubscription(Node node,
 NodeSubscription subscription)

Description copied from interface: PubSubPersistenceProvider

Updates the subscription of the user to the node to the database.

Specified by:

updateSubscription in interface PubSubPersistenceProvider

Parameters:

node - The node where the user has subscribed to.

subscription - The new subscription of the user to the node.

removeSubscription

public void removeSubscription(NodeSubscription subscription)

Description copied from interface: PubSubPersistenceProvider

Removes the subscription of the user from the DB.

Specified by:

removeSubscription in interface PubSubPersistenceProvider

Parameters:

subscription - The existing subscription of the user to the node.

purgeNode

public void purgeNode(LeafNode leafNode)

Description copied from interface: PubSubPersistenceProvider

Deletes all published items of a node.

Specified by:

purgeNode in interface PubSubPersistenceProvider

Parameters:

leafNode - the node for which to delete all published items.

savePublishedItem

public void savePublishedItem(PublishedItem item)

Description copied from interface: PubSubPersistenceProvider

Creates and stores the published item in the database. When an item with the same ID was previously saved, this item will be replaced by the new item.

Specified by:

savePublishedItem in interface PubSubPersistenceProvider

Parameters:

item - The published item to save.

flushPendingChanges

public void flushPendingChanges(Node.UniqueIdentifier nodeUniqueId)

flushPendingChanges

public void flushPendingChanges(Node.UniqueIdentifier nodeUniqueId,
 boolean sendToCluster)

flushPendingChanges

public void flushPendingChanges(boolean sendToCluster)

Persists any changes that have been applied to the caches by invoking the relevant methods of the delegate. A flush can be performed either local (typically used to periodically persist data) or cluster-wide (useful to ensure that a particular state is reached, cluster-wide).

Parameters:

sendToCluster - set to 'true' to trigger a flush on all cluster nodes. If false, a flush will occur only on the local node.

removePublishedItem

public void removePublishedItem(PublishedItem item)

Description copied from interface: PubSubPersistenceProvider

Removes the specified published item from the DB.

Specified by:

removePublishedItem in interface PubSubPersistenceProvider

Parameters:

item - The published item to delete.

loadPEPServiceFromDB

public PEPService loadPEPServiceFromDB(org.xmpp.packet.JID jid)

Description copied from interface: PubSubPersistenceProvider

Loads a PEP service from the database, if it exists. Note that the returned service is not yet initialized!

Specified by:

loadPEPServiceFromDB in interface PubSubPersistenceProvider

Parameters:

jid - the JID of the owner of the PEP service.

Returns:

the loaded PEP service, or null if not found.

bulkPublishedItems

public void bulkPublishedItems(List<PublishedItem> addList,
 List<PublishedItem> delList)

Description copied from interface: PubSubPersistenceProvider

Writes large changesets, using batches and transactions when available. The 'delete' list takes precedence over the 'add' list: when an item exists on both lists, it is removed (and not re-added) from storage To prevent duplicates to exist, this method will attempt to remove all items to-be-added, before re-adding them.

Specified by:

bulkPublishedItems in interface PubSubPersistenceProvider

Parameters:

addList - A list of items to be added.

delList - A list of items to be removed.

loadDefaultConfiguration

public DefaultNodeConfiguration loadDefaultConfiguration(PubSubService.UniqueIdentifier serviceIdentifier,
 boolean isLeafType)

Description copied from interface: PubSubPersistenceProvider

Loads from the database the default node configuration for the specified node type and pubsub service.

Specified by:

loadDefaultConfiguration in interface PubSubPersistenceProvider

Parameters:

serviceIdentifier - Identifier of the service

isLeafType - true if loading default configuration for leaf nodes.

Returns:

the loaded default node configuration for the specified node type and service or null if none was found.

createDefaultConfiguration

public void createDefaultConfiguration(PubSubService.UniqueIdentifier serviceIdentifier,
 DefaultNodeConfiguration config)

Description copied from interface: PubSubPersistenceProvider

Creates a new default node configuration for the specified service.

Specified by:

createDefaultConfiguration in interface PubSubPersistenceProvider

Parameters:

serviceIdentifier - Identifier of the service

config - the default node configuration to create in the database.

updateDefaultConfiguration

public void updateDefaultConfiguration(PubSubService.UniqueIdentifier serviceIdentifier,
 DefaultNodeConfiguration config)

Description copied from interface: PubSubPersistenceProvider

Updates the default node configuration for the specified service.

Specified by:

updateDefaultConfiguration in interface PubSubPersistenceProvider

Parameters:

serviceIdentifier - Identifier of the service

config - the default node configuration to update in the database.

getPublishedItems

public List<PublishedItem> getPublishedItems(LeafNode node)

Description copied from interface: PubSubPersistenceProvider

Fetches all the results for the specified node, limited by LeafNode.getMaxPublishedItems(). Results are ordered by creation date.

Specified by:

getPublishedItems in interface PubSubPersistenceProvider

Parameters:

node - the leaf node to load its published items.

getPublishedItems

public List<PublishedItem> getPublishedItems(LeafNode node,
 int maxRows)

Description copied from interface: PubSubPersistenceProvider

Fetches all the results for the specified node, limited by LeafNode.getMaxPublishedItems(). Results are ordered by creation date.

Specified by:

getPublishedItems in interface PubSubPersistenceProvider

Parameters:

node - the leaf node to load its published items.

getLastPublishedItem

public PublishedItem getLastPublishedItem(LeafNode node)

Description copied from interface: PubSubPersistenceProvider

Fetches the last published item (by creation date) for the specified node.

Specified by:

getLastPublishedItem in interface PubSubPersistenceProvider

Parameters:

node - the leaf node to load its last published items.

getPublishedItem

public PublishedItem getPublishedItem(LeafNode node,
 PublishedItem.UniqueIdentifier itemIdentifier)

Description copied from interface: PubSubPersistenceProvider

Fetches a published item (by ID) for a node.

Specified by:

getPublishedItem in interface PubSubPersistenceProvider

Parameters:

node - The node for which to get a published item.

itemIdentifier - The unique identifier of the item to fetch.

Returns:

The item, or null if no item was found.