com.qizx.api
Interface LibraryMemberObserver

All Superinterfaces:

EventListener

public interface LibraryMemberObserver

extends EventListener

Observes update operations on a XML Library.

Useful for:

• Implementing application-specific logging.
• Implementing triggers.
• Specifically, it can be used to automatically add Properties on created objects, for example in relation with an AccessControl object to speed up its job (which is to match the privileges of a User with a LibraryMember currently being accessed or modified). This allows implementing sophisticated access control based on the contents of a Document or Collection.

Notes:

• Events are generated as soon as the corresponding action is performed is a session (Library), and in the same thread. Therefore any modification action performed by a LibraryObserver will also be part of the transaction in which the initial action happened (and therefore cancelled if the transaction is rolled back).
• The update operations that may be performed by LibraryMemberObserver concern only member Properties; the delete, copy and rename operations are ineffective.
• No AccessControl is invoked for operations called from this observer.
• a LibraryObserver is attached to a LibraryManager, not to a specific session (Library). Due to isolation between sessions, a LibraryObserver must be prepared to see different instances of the same Document or Collection with different contents or properties: a modifying transaction/session would see the future state of a library member, while other transactions may still see older states of the library member.
• No event is generated when Library Members are modified by a method of LibraryMemberObserver, in order to prevent recursive looping.

Method Summary

void	memberCreated(LibraryMember member) Called just after a library member is created or overwritten (for a Document).
void	memberDeleted(LibraryMember member) Called just before the library member is deleted.
void	memberRenamed(LibraryMember member, String oldPath) Called just after the library member is renamed.
void	propertyModified(LibraryMember member, String propertyName) Called just after a property of a member is modified or removed.

Method Detail

memberCreated

public void memberCreated(LibraryMember member)

Called just after a library member is created or overwritten (for a Document). This can be used for example to add automatically computed properties to the object (document or collection).

Parameters:

member - a library member just created

Throws:

DataModelException - if thrown, the exception is reported to the application, but this does not cancel the creation of the member

memberRenamed

public void memberRenamed(LibraryMember member,
                          String oldPath)

Called just after the library member is renamed.

Parameters:

member - the library member renamed. Renaming a collection generates one event for the collection itself, not for contained members.

oldPath - previous path of the member

memberDeleted

public void memberDeleted(LibraryMember member)

Called just before the library member is deleted.

Parameters:

member - library member to be deleted

propertyModified

public void propertyModified(LibraryMember member,
                             String propertyName)

Called just after a property of a member is modified or removed. This can be used for example to update automatically computed properties.

Note: this method is not called for modifications performed by a LibraryMemberObserver, to avoid recursive looping.

Parameters:

member - the library member whose property changes

propertyName - name of the modified or removed property