001/*
002 * File   : $Source$
003 * Date   : $Date$
004 * Version: $Revision$
005 *
006 * This library is part of OpenCms -
007 * the Open Source Content Management System
008 *
009 * Copyright (C) 2002 - 2009 Alkacon Software (http://www.alkacon.com)
010 *
011 * This library is free software; you can redistribute it and/or
012 * modify it under the terms of the GNU Lesser General Public
013 * License as published by the Free Software Foundation; either
014 * version 2.1 of the License, or (at your option) any later version.
015 *
016 * This library is distributed in the hope that it will be useful,
017 * but WITHOUT ANY WARRANTY; without even the implied warranty of
018 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019 * Lesser General Public License for more details.
020 *
021 * For further information about Alkacon Software, please see the
022 * company website: http://www.alkacon.com
023 *
024 * For further information about OpenCms, please see the
025 * project website: http://www.opencms.org
026 *
027 * You should have received a copy of the GNU Lesser General Public
028 * License along with this library; if not, write to the Free Software
029 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
030 */
031
032package org.opencms.search.solr;
033
034import org.opencms.file.CmsObject;
035import org.opencms.file.CmsResource;
036
037import org.apache.solr.common.SolrDocument;
038import org.apache.solr.common.SolrInputDocument;
039
040/**
041 * The post document processor can be used in order to
042 * manipulate search results after the OpenCms permission
043 * check has been done.<p>
044 *
045 * NOTE: Currently it is only possible to use this interface
046 * if you run an embedded Solr server instance.<p>
047 *
048 * @since 8.5.0
049 */
050public interface I_CmsSolrPostSearchProcessor {
051
052    /**
053     * (Re-)Initializes the post processor.<p>
054     */
055    void init();
056
057    /**
058     * Performs the post processing.<p>
059     *
060     * @param searchCms the CMS object
061     * @param resource the resource for the found document
062     * @param document the document itself
063     *
064     * @return the manipulated Solr document
065     */
066    SolrDocument process(CmsObject searchCms, CmsResource resource, SolrInputDocument document);
067}