01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.apache.lucene.store.jdbc.lock;
18:
19: import java.io.IOException;
20:
21: import org.apache.lucene.store.jdbc.JdbcDirectory;
22:
23: /**
24: * An extension insterface for Lucene <code>Lock</code> class.
25: *
26: * @author kimchy
27: */
28: public interface JdbcLock {
29:
30: /**
31: * Configures the lock. Called just after the lock is instantiated.
32: *
33: * @param jdbcDirectory The directory using the lock
34: * @param name The name of the lock
35: * @throws IOException
36: */
37: void configure(JdbcDirectory jdbcDirectory, String name)
38: throws IOException;
39:
40: /**
41: * Called without configure. Should initialize a creates database.
42: *
43: * @param jdbcDirectory The directory owning the lock
44: */
45: void initializeDatabase(JdbcDirectory jdbcDirectory)
46: throws IOException;
47: }
|