vCard 2 OFUSER Plugin

Document created by LG Champion on Sep 23, 2007Last modified by LG Champion on Mar 3, 2010
Version 7Show Document
  • View in full screen mode

State

alpha

 

Developers

LG

Open Issues

none which are known

 

Feedback and Discussion

Community Plugins

 

Description

This plugin copies data from vCards into the OFUSER table. This may be useful if the users want to register them self and can't add data to the OFUSER table which is used by the search service. This can of course be abused by every user by entering wrong data in the vCard if the vCard is not read-only. It does as far as I know not work with external user providers as Openfire has only read-access to such sources.

 

Installation

Copy vcard2ofuser.jar into the plugins directory of your Openfire installation. The plugin will then be automatically deployed. To upgrade to a new version, copy the new vcard2jiveuser.jar file over the existing file.

 

Configuration

There are four properties which can be set (not yet tested):

plugin.vCard2JiveUser.NameField=/vCard/N/GIVEN, ,/vCard/N/FAMILY

plugin.vCard2JiveUser.EmailField=/vCard/EMAIL/USERID

These two properties are XPathes and strings, separated with ','. To insert a ',' one needs to add ',,' to the expression, for "Lastname, Firstname" the expression looks like

plugin.plugin.vCard2JiveUser..NameField=/vCard/N/FAMILY,, ,/vCard/N/GIVEN

One can also these expression also within the EmailField to add there other information and not the email address.

 

plugin.vCard2JiveUser.DelayBeforeLoop=0

This property defines how long the plugin will wait before it will iterate over all existing vCards. If you experience high load during startup of your server you can delay the start to 10 minutes with:

plugin.vCard2JiveUser.DelayBeforeLoop=600000

To disable the looping process set this to a negative value, this plugin will then only process new or changed vCards.

 

plugin.vCard2JiveUser.DelayWithinLoop=100

This property defines how long it will wait after processing a vCard. With a delay of 100ms it will process 10 or less users every second. This keeps the CPU low and is quite fast but one can set this to a lower value, especially on an SMP system.

Restart the plugin after adding or changing these properties.

 

Usage

The plugin verifies and modifies all user data during initialization and on every vCard change.

Enable the debug log to log all changes the plugin does.

 

(zip file contains the source code)

vCard2OFUSER.zip is the source code for Openfire 3.6.5 / 3.7 and due to logging not compatible with a previous version of Openfire. It also contains a newer readme file.

Outcomes