lucene-java-3.5.0/lucene/contrib/remote/src/java/org/apache/lucene/search/RMIRemoteSearchable.java

   1 /**
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package org.apache.lucene.search;
  19
  20 import java.rmi.Remote;
  21
  22 /**
  23  * Marker interface to enable subclasses of {@link org.apache.lucene.search.Searchable} to be used via
  24  * Java RMI. Classes implementing this interface can be used as a RMI -
  25  * "remote object".
  26  * <p>
  27  * {@link RMIRemoteSearchable} extends {@link org.apache.lucene.search.Searchable} and can transparently
  28  * be used as a such.
  29  * <p>
  30  * Example usage:
  31  *
  32  * <pre>
  33  *   RMIRemoteSearchable remoteObject = ...;
  34  *   String remoteObjectName = ...;
  35  *   Naming.rebind (remoteObjectName, remoteObject);
  36  *   Searchable luceneSearchable = (Searchable) Naming.lookup (remoteObjectName);
  37  * </pre>
  38  *
  39  * </p>
  40  * </p>
  41  *
  42  * @deprecated This package (all of contrib/remote) will be
  43  * removed in 4.0.
  44  */
  45 @Deprecated
  46 public interface RMIRemoteSearchable extends Searchable, Remote {
  47
  48 }