com.memberwebs.ldapxml
Interface LXHook

All Known Implementing Classes:

LXDefaultHook

public interface LXHook

Interface for hooking into LX processing.

Version:

0.5

Author:

stef@memberwebs.com

Method Summary

void	initialize(java.lang.Object obj) Initialize this hook.
boolean	postfix(com.novell.ldap.LDAPEntry entry, org.w3c.dom.Element el) Allows post processing of an element retrieved from LDAP.
boolean	prefix(com.novell.ldap.LDAPEntry entry) Allows pre processing of an entry retrieved from LDAP.

Method Detail

initialize

public void initialize(java.lang.Object obj)
                throws LXException

Initialize this hook. The parameter is passed through to this object by creating an LXSpecs object, using LXSpecs.setData to set custom data and then one of the LXReader methods that allow passing in of a LXSpecs object. The custom data will then be passed to this method the first time that this hook is used.

Parameters:

obj - An initialization parameter

Throws:

LXException

prefix

public boolean prefix(com.novell.ldap.LDAPEntry entry)
               throws LXException

Allows pre processing of an entry retrieved from LDAP. By modifying the passed LDAPEntry object, you can affect the way the map handles your data. Returning false, will cause this entry to be ignored as if it didn't exist.

Parameters:

entry - The LDAP entry retrieved

Returns:

If false then this element will not be included.

Throws:

LXException

postfix

public boolean postfix(com.novell.ldap.LDAPEntry entry,
                       org.w3c.dom.Element el)
                throws LXException

Allows post processing of an element retrieved from LDAP. You can modify the final constructed XML element at this point. By returning false you cause this element to be discarded.

Parameters:

entry - The LDAP entry retrieved.

el - The DOM element constructed.

Returns:

If false then this element.

Throws:

LXException