001/* 002 * (C) Copyright 2010 Nuxeo SA (http://nuxeo.com/) and others. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 * 016 * Contributors: 017 * Olivier Grisel 018 * 019 * $Id$ 020 */ 021 022package org.nuxeo.ecm.directory; 023 024import org.nuxeo.ecm.core.api.DocumentModel; 025 026/** 027 * Interface to be used by Directory implementations to perform arbitrary "fetch-time" adaptations on the entry fields 028 * and the readonly flag. 029 */ 030public interface EntryAdaptor { 031 032 /** 033 * Allow the directory initialization process to configure the adaptor by providing String valued parameters. 034 */ 035 void setParameter(String name, String value); 036 037 /** 038 * Apply an arbitrary transformation of the fetched entry. 039 * 040 * @param directory the directory instance the entry is fetched from 041 * @param entry the entry to transform 042 * @return the adapted entry 043 * @throws DirectoryException if the adapting process fails unexpectedly 044 */ 045 DocumentModel adapt(Directory directory, DocumentModel entry) throws DirectoryException; 046 047}