org.apache.solr.handler.admin
Class CoreAdminHandler

java.lang.Object
  extended by org.apache.solr.handler.RequestHandlerBase
      extended by org.apache.solr.handler.admin.CoreAdminHandler
All Implemented Interfaces:
SolrInfoMBean, SolrRequestHandler

public class CoreAdminHandler
extends RequestHandlerBase

Since:
solr 1.3

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean
SolrInfoMBean.Category
 
Field Summary
static com.google.common.collect.ImmutableMap<String,String> cloudParamToProp
           
protected  CoreContainer coreContainer
           
protected static org.slf4j.Logger log
           
static com.google.common.collect.ImmutableMap<String,String> paramToProp
           
 
Fields inherited from class org.apache.solr.handler.RequestHandlerBase
appends, defaults, httpCaching, initArgs, invariants
 
Constructor Summary
CoreAdminHandler()
           
CoreAdminHandler(CoreContainer coreContainer)
          Overloaded ctor to inject CoreContainer into the handler.
 
Method Summary
protected static CoreDescriptor buildCoreDescriptor(SolrParams params, CoreContainer container)
           
 CoreContainer getCoreContainer()
          The instance of CoreContainer this handler handles.
protected  NamedList<Object> getCoreStatus(CoreContainer cores, String cname, boolean isIndexInfoNeeded)
          Returns the core status for a particular core.
 String getDescription()
          Simple one or two line description
 String getSource()
          CVS Source, SVN Source, etc
protected  void handleAliasAction(SolrQueryRequest req, SolrQueryResponse rsp)
          Deprecated. 
protected  void handleCreateAction(SolrQueryRequest req, SolrQueryResponse rsp)
          Handle 'CREATE' action.
protected  void handleCustomAction(SolrQueryRequest req, SolrQueryResponse rsp)
          Handle Custom Action.
protected  void handleMergeAction(SolrQueryRequest req, SolrQueryResponse rsp)
           
protected  void handlePersistAction(SolrQueryRequest req, SolrQueryResponse rsp)
          Handler "PERSIST" action
protected  void handleReloadAction(SolrQueryRequest req, SolrQueryResponse rsp)
          Handler "RELOAD" action
protected  void handleRenameAction(SolrQueryRequest req, SolrQueryResponse rsp)
          Handle "RENAME" Action
 void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
           
protected  void handleRequestRecoveryAction(SolrQueryRequest req, SolrQueryResponse rsp)
           
protected  void handleRequestSyncAction(SolrQueryRequest req, SolrQueryResponse rsp)
           
protected  void handleSplitAction(SolrQueryRequest adminReq, SolrQueryResponse rsp)
          Handle the core admin SPLIT action.
protected  void handleStatusAction(SolrQueryRequest req, SolrQueryResponse rsp)
          Handle "STATUS" action
protected  void handleSwapAction(SolrQueryRequest req, SolrQueryResponse rsp)
          Handle "SWAP" action
protected  void handleUnloadAction(SolrQueryRequest req, SolrQueryResponse rsp)
          Handle "UNLOAD" Action
protected  void handleWaitForStateAction(SolrQueryRequest req, SolrQueryResponse rsp)
           
 void init(NamedList args)
          Initializes the SolrRequestHandler by creating three SolrParams named.
protected static String normalizePath(String path)
           
static ModifiableSolrParams params(String... params)
           
 
Methods inherited from class org.apache.solr.handler.RequestHandlerBase
getCategory, getDocs, getInitArgs, getName, getStatistics, getVersion, handleRequest
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected static org.slf4j.Logger log

coreContainer

protected final CoreContainer coreContainer

paramToProp

public static com.google.common.collect.ImmutableMap<String,String> paramToProp

cloudParamToProp

public static com.google.common.collect.ImmutableMap<String,String> cloudParamToProp
Constructor Detail

CoreAdminHandler

public CoreAdminHandler()

CoreAdminHandler

public CoreAdminHandler(CoreContainer coreContainer)
Overloaded ctor to inject CoreContainer into the handler.

Parameters:
coreContainer - Core Container of the solr webapp installed.
Method Detail

init

public final void init(NamedList args)
Description copied from class: RequestHandlerBase
Initializes the SolrRequestHandler by creating three SolrParams named.
NameDescription
defaultsContains all of the named arguments contained within the list element named "defaults".
appendsContains all of the named arguments contained within the list element named "appends".
invariantsContains all of the named arguments contained within the list element named "invariants".
Example:
 <lst name="defaults">
 <str name="echoParams">explicit</str>
 <str name="qf">text^0.5 features^1.0 name^1.2 sku^1.5 id^10.0</str>
 <str name="mm">2<-1 5<-2 6<90%</str>
 <str name="bq">incubationdate_dt:[* TO NOW/DAY-1MONTH]^2.2</str>
 </lst>
 <lst name="appends">
 <str name="fq">inStock:true</str>
 </lst>

 <lst name="invariants">
 <str name="facet.field">cat</str>
 <str name="facet.field">manu_exact</str>
 <str name="facet.query">price:[* TO 500]</str>
 <str name="facet.query">price:[500 TO *]</str>
 </lst>
 

Specified by:
init in interface SolrRequestHandler
Overrides:
init in class RequestHandlerBase
Parameters:
args - The NamedList to initialize from
See Also:
RequestHandlerBase.handleRequest(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse), RequestHandlerBase.handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse), SolrPluginUtils.setDefaults(org.apache.solr.request.SolrQueryRequest, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams, org.apache.solr.common.params.SolrParams), See also the example solrconfig.xml located in the Solr codebase (example/solr/conf).

getCoreContainer

public CoreContainer getCoreContainer()
The instance of CoreContainer this handler handles. This should be the CoreContainer instance that created this handler.

Returns:
a CoreContainer instance

handleRequestBody

public void handleRequestBody(SolrQueryRequest req,
                              SolrQueryResponse rsp)
                       throws Exception
Specified by:
handleRequestBody in class RequestHandlerBase
Throws:
Exception

handleSplitAction

protected void handleSplitAction(SolrQueryRequest adminReq,
                                 SolrQueryResponse rsp)
                          throws IOException
Handle the core admin SPLIT action.

Throws:
IOException

handleMergeAction

protected void handleMergeAction(SolrQueryRequest req,
                                 SolrQueryResponse rsp)
                          throws Exception
Throws:
Exception

handleCustomAction

protected void handleCustomAction(SolrQueryRequest req,
                                  SolrQueryResponse rsp)
Handle Custom Action.

This method could be overridden by derived classes to handle custom actions.
By default - this method throws a solr exception. Derived classes are free to write their derivation if necessary.


buildCoreDescriptor

protected static CoreDescriptor buildCoreDescriptor(SolrParams params,
                                                    CoreContainer container)

handleCreateAction

protected void handleCreateAction(SolrQueryRequest req,
                                  SolrQueryResponse rsp)
                           throws SolrException
Handle 'CREATE' action.

Throws:
SolrException - in case of a configuration error.

handleRenameAction

protected void handleRenameAction(SolrQueryRequest req,
                                  SolrQueryResponse rsp)
                           throws SolrException
Handle "RENAME" Action

Throws:
SolrException

handleAliasAction

@Deprecated
protected void handleAliasAction(SolrQueryRequest req,
                                            SolrQueryResponse rsp)
Deprecated. 

Handle "ALIAS" action


handleUnloadAction

protected void handleUnloadAction(SolrQueryRequest req,
                                  SolrQueryResponse rsp)
                           throws SolrException
Handle "UNLOAD" Action

Throws:
SolrException

handleStatusAction

protected void handleStatusAction(SolrQueryRequest req,
                                  SolrQueryResponse rsp)
                           throws SolrException
Handle "STATUS" action

Throws:
SolrException

handlePersistAction

protected void handlePersistAction(SolrQueryRequest req,
                                   SolrQueryResponse rsp)
                            throws SolrException
Handler "PERSIST" action

Throws:
SolrException

handleReloadAction

protected void handleReloadAction(SolrQueryRequest req,
                                  SolrQueryResponse rsp)
Handler "RELOAD" action


handleSwapAction

protected void handleSwapAction(SolrQueryRequest req,
                                SolrQueryResponse rsp)
Handle "SWAP" action


handleRequestRecoveryAction

protected void handleRequestRecoveryAction(SolrQueryRequest req,
                                           SolrQueryResponse rsp)
                                    throws IOException
Throws:
IOException

handleRequestSyncAction

protected void handleRequestSyncAction(SolrQueryRequest req,
                                       SolrQueryResponse rsp)
                                throws IOException
Throws:
IOException

handleWaitForStateAction

protected void handleWaitForStateAction(SolrQueryRequest req,
                                        SolrQueryResponse rsp)
                                 throws IOException,
                                        InterruptedException,
                                        org.apache.zookeeper.KeeperException
Throws:
IOException
InterruptedException
org.apache.zookeeper.KeeperException

getCoreStatus

protected NamedList<Object> getCoreStatus(CoreContainer cores,
                                          String cname,
                                          boolean isIndexInfoNeeded)
                                   throws IOException
Returns the core status for a particular core.

Parameters:
cores - - the enclosing core container
cname - - the core to return
isIndexInfoNeeded - - add what may be expensive index information. NOT returned if the core is not loaded
Returns:
- a named list of key/value pairs from the core.
Throws:
IOException - - LukeRequestHandler can throw an I/O exception

normalizePath

protected static String normalizePath(String path)

params

public static ModifiableSolrParams params(String... params)

getDescription

public String getDescription()
Description copied from interface: SolrInfoMBean
Simple one or two line description

Specified by:
getDescription in interface SolrInfoMBean
Specified by:
getDescription in class RequestHandlerBase

getSource

public String getSource()
Description copied from interface: SolrInfoMBean
CVS Source, SVN Source, etc

Specified by:
getSource in interface SolrInfoMBean
Specified by:
getSource in class RequestHandlerBase


Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.