org.nuxeo.ecm.directory

Interface EntryAdaptor

All Known Implementing Classes:

WritePolicyEntryAdaptor

public interface EntryAdaptor

Interface to be used by Directory implementations to perform arbitrary "fetch-time" adaptations on the entry fields and the readonly flag.

Method Summary

Modifier and Type	Method and Description
DocumentModel	adapt(Directory directory, DocumentModel entry) Apply an arbitrary transformation of the fetched entry.
void	setParameter(String name, String value) Allow the directory initialization process to configure the adaptor by providing String valued parameters.

Method Detail

setParameter

void setParameter(String name,
                  String value)

Allow the directory initialization process to configure the adaptor by providing String valued parameters.

adapt

DocumentModel adapt(Directory directory,
                    DocumentModel entry)
             throws DirectoryException

Apply an arbitrary transformation of the fetched entry.

Parameters:

directory - the directory instance the entry is fetched from

entry - the entry to transform

Returns:

the adapted entry

Throws:

DirectoryException - if the adapting process fails unexpectedly