1 /*
2 * ModeShape (http://www.modeshape.org)
3 * See the COPYRIGHT.txt file distributed with this work for information
4 * regarding copyright ownership. Some portions may be licensed
5 * to Red Hat, Inc. under one or more contributor license agreements.
6 * See the AUTHORS.txt file in the distribution for a full listing of
7 * individual contributors.
8 *
9 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10 * is licensed to you under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation; either version 2.1 of
12 * the License, or (at your option) any later version.
13 *
14 * ModeShape is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this software; if not, write to the Free
21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23 */
24 package org.modeshape.search.lucene;
25
26 import net.jcip.annotations.ThreadSafe;
27 import org.apache.lucene.store.Directory;
28 import org.modeshape.graph.search.SearchEngineException;
29
30 /**
31 * Interface used to obtain the Lucene {@link Directory} instance that should be used for a workspace given the name of the
32 * workspace. There are several implementations (see {@link LuceneConfigurations}), but custom implementations can always be
33 * used.
34 */
35 @ThreadSafe
36 public interface LuceneConfiguration {
37 /**
38 * Get the {@link Directory} that should be used for the workspace with the supplied name.
39 *
40 * @param workspaceName the workspace name
41 * @param indexName the name of the index to be created
42 * @return the directory; never null
43 * @throws IllegalArgumentException if the workspace name is null
44 * @throws SearchEngineException if there is a problem creating the directory
45 */
46 Directory getDirectory( String workspaceName,
47 String indexName ) throws SearchEngineException;
48
49 /**
50 * Destroy the {@link Directory} that is used for the workspace with the supplied name.
51 *
52 * @param workspaceName the workspace name
53 * @param indexName the name of the index to be created
54 * @return true if the directory existed and was destroyed, or false if the directory didn't exist
55 * @throws IllegalArgumentException if the workspace name is null
56 * @throws SearchEngineException if there is a problem creating the directory
57 */
58 boolean destroyDirectory( String workspaceName,
59 String indexName ) throws SearchEngineException;
60 }