org.opencms.search.solr.CmsSolrIndexWriter Maven / Gradle / Ivy
/*
* File : $Source$
* Date : $Date$
* Version: $Revision$
*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (C) 2002 - 2009 Alkacon Software (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.search.solr;
import org.opencms.db.CmsPublishedResource;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.search.I_CmsSearchDocument;
import org.opencms.search.fields.CmsSearchField;
import java.io.IOException;
import java.util.List;
import org.apache.commons.logging.Log;
import org.apache.solr.client.solrj.SolrClient;
import org.apache.solr.client.solrj.SolrServerException;
import org.apache.solr.common.SolrException;
import org.apache.solr.common.SolrInputDocument;
/**
* Implements the index writer for the Solr server used by OpenCms.
*
* @since 8.5.0
*/
public class CmsSolrIndexWriter implements I_CmsSolrIndexWriter {
/** The log object for this class. */
protected static final Log LOG = CmsLog.getLog(CmsSolrIndexWriter.class);
/** The time to wait before a commit is sent to the Solr index. */
private int m_commitMs = new Long(
OpenCms.getSearchManager().getSolrServerConfiguration().getSolrCommitMs()).intValue();
/** The Solr index. */
private CmsSolrIndex m_index;
/** The Solr client. */
private SolrClient m_server;
/**
* Constructor to create a Solr index writer.
*
* @param client the client to use
*/
public CmsSolrIndexWriter(SolrClient client) {
this(client, null);
}
/**
* Creates a new index writer based on the provided standard Lucene IndexWriter for the
* provided OpenCms search index instance.
*
* The OpenCms search instance is currently used only for improved logging of the
* index operations.
*
* @param client the standard Lucene IndexWriter to use as delegate
* @param index the OpenCms search index instance this writer to supposed to write to
*/
public CmsSolrIndexWriter(SolrClient client, CmsSolrIndex index) {
m_index = index;
m_server = client;
if (m_index != null) {
LOG.info(
Messages.get().getBundle().key(
Messages.LOG_SOLR_WRITER_CREATE_2,
m_index.getName(),
m_index.getPath()));
}
}
/**
* @see org.opencms.search.I_CmsIndexWriter#close()
*/
public void close() {
// nothing to do here
}
/**
* @see org.opencms.search.I_CmsIndexWriter#commit()
*/
public void commit() throws IOException {
if ((m_server != null) && (m_index != null)) {
try {
LOG.info(
Messages.get().getBundle().key(
Messages.LOG_SOLR_WRITER_COMMIT_2,
m_index.getName(),
m_index.getPath()));
m_server.commit(m_index.getCoreName());
} catch (SolrServerException e) {
throw new IOException(e.getLocalizedMessage(), e);
}
}
}
/**
* @see org.opencms.search.solr.I_CmsSolrIndexWriter#deleteAllDocuments()
*/
public void deleteAllDocuments() throws IOException {
if ((m_server != null) && (m_index != null)) {
try {
LOG.info(
Messages.get().getBundle().key(
Messages.LOG_SOLR_WRITER_DELETE_ALL_2,
m_index.getName(),
m_index.getPath()));
m_server.deleteByQuery(m_index.getCoreName(), "*:*", m_commitMs);
} catch (SolrServerException e) {
throw new IOException(e.getLocalizedMessage(), e);
}
}
}
/**
* @see org.opencms.search.I_CmsIndexWriter#deleteDocument(org.opencms.db.CmsPublishedResource)
*/
public void deleteDocument(CmsPublishedResource resource) throws IOException {
if ((m_server != null) && (m_index != null)) {
try {
LOG.info(
Messages.get().getBundle().key(
Messages.LOG_SOLR_WRITER_DOC_DELETE_3,
resource.getRootPath(),
m_index.getName(),
m_index.getPath()));
m_server.deleteByQuery(m_index.getCoreName(), "id:" + resource.getStructureId().toString(), m_commitMs);
} catch (SolrServerException e) {
throw new IOException(e.getLocalizedMessage(), e);
} catch (SolrException e) {
throw new IOException(e.getLocalizedMessage(), e);
}
}
}
/**
* @see org.opencms.search.I_CmsIndexWriter#optimize()
*/
public void optimize() {
// optimization is not recommended
// should be configured within solrconfig.xml
}
/**
* @see org.opencms.search.I_CmsIndexWriter#updateDocument(java.lang.String, org.opencms.search.I_CmsSearchDocument)
*/
public void updateDocument(String rootPath, I_CmsSearchDocument document) throws IOException {
if ((m_server != null) && (m_index != null)) {
if (document.getDocument() != null) {
try {
m_server.deleteByQuery(m_index.getCoreName(), "path:\"" + rootPath + "\"", m_commitMs);
} catch (Exception e1) {
LOG.error(e1.getLocalizedMessage(), e1);
}
try {
LOG.info(
Messages.get().getBundle().key(
Messages.LOG_SOLR_WRITER_DOC_UPDATE_3,
rootPath,
m_index.getName(),
m_index.getPath()));
addDocumentInstances(document);
} catch (SolrServerException e) {
throw new IOException(e.getLocalizedMessage(), e);
}
}
}
}
/**
* Adds Solr documents to the index for the {@link I_CmsSearchDocument}.
* Documents for serial dates are added for each occurrence once with the date of the respective occurrence.
* @param document the document for the indexed resource
* @throws SolrServerException thrown if adding the document to the index fails
* @throws IOException thrown if adding the document to the index fails
*/
private void addDocumentInstances(I_CmsSearchDocument document) throws SolrServerException, IOException {
List serialDates = document.getMultivaluedFieldAsStringList(CmsSearchField.FIELD_SERIESDATES);
SolrInputDocument inputDoc = (SolrInputDocument)document.getDocument();
String id = inputDoc.getFieldValue(CmsSearchField.FIELD_ID).toString();
if (null != serialDates) {
// NOTE: We can assume the following to arrays have the same length as serialDates.
List serialDatesEnd = document.getMultivaluedFieldAsStringList(
CmsSearchField.FIELD_SERIESDATES_END);
List serialDatesCurrentTill = document.getMultivaluedFieldAsStringList(
CmsSearchField.FIELD_SERIESDATES_CURRENT_TILL);
for (int i = 0; i < serialDates.size(); i++) {
String date = serialDates.get(i);
String endDate = serialDatesEnd.get(i);
String currentTillDate = serialDatesCurrentTill.get(i);
inputDoc.setField(CmsSearchField.FIELD_INSTANCEDATE + CmsSearchField.FIELD_POSTFIX_DATE, date);
inputDoc.setField(CmsSearchField.FIELD_INSTANCEDATE_END + CmsSearchField.FIELD_POSTFIX_DATE, endDate);
inputDoc.setField(
CmsSearchField.FIELD_INSTANCEDATE_CURRENT_TILL + CmsSearchField.FIELD_POSTFIX_DATE,
currentTillDate);
for (String locale : document.getMultivaluedFieldAsStringList(CmsSearchField.FIELD_CONTENT_LOCALES)) {
inputDoc.setField(
CmsSearchField.FIELD_INSTANCEDATE + "_" + locale + CmsSearchField.FIELD_POSTFIX_DATE,
date);
inputDoc.setField(
CmsSearchField.FIELD_INSTANCEDATE_END + "_" + locale + CmsSearchField.FIELD_POSTFIX_DATE,
endDate);
inputDoc.setField(
CmsSearchField.FIELD_INSTANCEDATE_CURRENT_TILL
+ "_"
+ locale
+ CmsSearchField.FIELD_POSTFIX_DATE,
currentTillDate);
}
String newId = id + String.format("-%04d", Integer.valueOf(i + 1));
inputDoc.setField(CmsSearchField.FIELD_SOLR_ID, newId);
//remove fields that should not be part of the index, but were used to transport extra-information on date series
inputDoc.removeField(CmsSearchField.FIELD_SERIESDATES_END);
inputDoc.removeField(CmsSearchField.FIELD_SERIESDATES_CURRENT_TILL);
m_server.add(m_index.getCoreName(), inputDoc, m_commitMs);
}
} else {
inputDoc.setField(CmsSearchField.FIELD_SOLR_ID, id);
m_server.add(m_index.getCoreName(), inputDoc, m_commitMs);
}
}
}