01: /**
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: */package org.apache.solr.core;
17:
18: import java.net.URL;
19: import org.apache.solr.util.*;
20:
21: /**
22: * MBean interface for getting various ui friendly strings and URLs
23: * for use by objects which are 'pluggable' to make server administration
24: * easier.
25: *
26: * @author ronp
27: * @version $Id: SolrInfoMBean.java 472574 2006-11-08 18:25:52Z yonik $
28: */
29: public interface SolrInfoMBean {
30:
31: public enum Category {
32: CORE, QUERYHANDLER, UPDATEHANDLER, CACHE, OTHER
33: };
34:
35: /**
36: * Simple common usage name, e.g. BasicQueryHandler,
37: * or fully qualified clas name.
38: */
39: public String getName();
40:
41: /** Simple common usage version, e.g. 2.0 */
42: public String getVersion();
43:
44: /** Simple one or two line description */
45: public String getDescription();
46:
47: /** Purpose of this Class */
48: public Category getCategory();
49:
50: /** CVS Id, SVN Id, etc */
51: public String getSourceId();
52:
53: /** CVS Source, SVN Source, etc */
54: public String getSource();
55:
56: /**
57: * Documentation URL list.
58: *
59: * <p>
60: * Suggested documentation URLs: Homepage for sponsoring project,
61: * FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...
62: * </p>
63: */
64: public URL[] getDocs();
65:
66: /**
67: * Any statistics this instance would like to be publicly available via
68: * the Solr Administration interface.
69: *
70: * <p>
71: * Any Object type may be stored in the list, but only the
72: * <code>toString()</code> representation will be used.
73: * </p>
74: */
75: public NamedList getStatistics();
76:
77: }
|