← Back to branch summary

~slub.team/goobi-indexserver/3.x

« back to all changes in this revision

Viewing changes to solr/core/src/java/org/apache/solr/core/SolrInfoMBean.java

  • Committer: Sebastian Meyer
  • Date: 2012-08-03 09:12:40 UTC
  • Revision ID: sebastian.meyer@slub-dresden.de-20120803091240-x6861b0vabq1xror
https://launchpad.net/bugs/985487
Remove Lucene and Solr source code and add patches instead
Fix Bug #985487: Auto-suggestion for the search interface

Show diffs side-by-side

added added

removed removed

Lines of Context:
solr/core/src/java/org/apache/solr/core/SolrInfoMBean.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.solr.core;
19
 
 
20
 
import java.net.URL;
21
 
 
22
 
import org.apache.solr.common.util.NamedList;
23
 
 
24
 
/**
25
 
 * MBean interface for getting various ui friendly strings and URLs
26
 
 * for use by objects which are 'pluggable' to make server administration
27
 
 * easier.
28
 
 *
29
 
 * @version $Id: SolrInfoMBean.java 555343 2007-07-11 17:46:25Z hossman $
30
 
 */
31
 
public interface SolrInfoMBean {
32
 
 
33
 
  public enum Category { CORE, QUERYHANDLER, UPDATEHANDLER, CACHE, HIGHLIGHTING, OTHER };
34
 
 
35
 
  /**
36
 
   * Simple common usage name, e.g. BasicQueryHandler,
37
 
   * or fully qualified clas name.
38
 
   */
39
 
  public String getName();
40
 
  /** Simple common usage version, e.g. 2.0 */
41
 
  public String getVersion();
42
 
  /** Simple one or two line description */
43
 
  public String getDescription();
44
 
  /** Purpose of this Class */
45
 
  public Category getCategory();
46
 
  /** CVS Id, SVN Id, etc */
47
 
  public String getSourceId();
48
 
  /** CVS Source, SVN Source, etc */
49
 
  public String getSource();
50
 
  /**
51
 
   * Documentation URL list.
52
 
   *
53
 
   * <p>
54
 
   * Suggested documentation URLs: Homepage for sponsoring project,
55
 
   * FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...
56
 
   * </p>
57
 
   */
58
 
  public URL[] getDocs();
59
 
  /**
60
 
   * Any statistics this instance would like to be publicly available via
61
 
   * the Solr Administration interface.
62
 
   *
63
 
   * <p>
64
 
   * Any Object type may be stored in the list, but only the
65
 
   * <code>toString()</code> representation will be used.
66
 
   * </p>
67
 
   */
68
 
  public NamedList getStatistics();
69
 
 
70
 
}