|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.solr.handler.RequestHandlerBase
org.apache.solr.handler.admin.ShowFileRequestHandler
public class ShowFileRequestHandler
This handler uses the RawResponseWriter to give client access to
files inside ${solr.home}/conf
If you want to selectively restrict access some configuration files, you can list
these files in the HIDDEN
invariants. For example to hide
synonyms.txt and anotherfile.txt, you would register:
<requestHandler name="/admin/file" class="org.apache.solr.handler.admin.ShowFileRequestHandler" > <lst name="defaults"> <str name="echoParams">explicit</str> </lst> <lst name="invariants"> <str name="hidden">synonyms.txt</str> <str name="hidden">anotherfile.txt</str> </lst> </requestHandler>The ShowFileRequestHandler uses the
RawResponseWriter
(wt=raw) to return
file contents. If you need to use a different writer, you will need to change
the registered invarient param for wt.
If you want to override the contentType header returned for a given file, you can
set it directly using: USE_CONTENT_TYPE
. For example, to get a plain text
version of schema.xml, try:
http://localhost:8983/solr/admin/file?file=schema.xml&contentType=text/plain
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean |
---|
SolrInfoMBean.Category |
Field Summary | |
---|---|
static String |
HIDDEN
|
protected Set<String> |
hiddenFiles
|
static String |
USE_CONTENT_TYPE
|
Fields inherited from class org.apache.solr.handler.RequestHandlerBase |
---|
appends, defaults, httpCaching, initArgs, invariants |
Constructor Summary | |
---|---|
ShowFileRequestHandler()
|
Method Summary | |
---|---|
String |
getDescription()
Simple one or two line description |
static String |
getFileContents(String path)
Deprecated. This functionality is implemented in handleRequestBody(SolrQueryRequest, SolrQueryResponse) . |
Set<String> |
getHiddenFiles()
|
String |
getSource()
CVS Source, SVN Source, etc |
String |
getSourceId()
CVS Id, SVN Id, etc |
String |
getVersion()
Simple common usage version, e.g. |
void |
handleRequestBody(SolrQueryRequest req,
SolrQueryResponse rsp)
|
void |
init(org.apache.solr.common.util.NamedList args)
Initializes the SolrRequestHandler by creating three SolrParams named. |
Methods inherited from class org.apache.solr.handler.RequestHandlerBase |
---|
getCategory, getDocs, getInitArgs, getName, getStatistics, handleRequest |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String HIDDEN
public static final String USE_CONTENT_TYPE
protected Set<String> hiddenFiles
Constructor Detail |
---|
public ShowFileRequestHandler()
Method Detail |
---|
public void init(org.apache.solr.common.util.NamedList args)
RequestHandlerBase
SolrRequestHandler
by creating three SolrParams
named.
Name | Description |
---|---|
defaults | Contains all of the named arguments contained within the list element named "defaults". |
appends | Contains all of the named arguments contained within the list element named "appends". |
invariants | Contains all of the named arguments contained within the list element named "invariants". |
<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>
init
in interface SolrRequestHandler
init
in class RequestHandlerBase
args
- The NamedList
to initialize fromRequestHandlerBase.handleRequest(org.apache.solr.request.SolrQueryRequest, org.apache.solr.request.SolrQueryResponse)
,
RequestHandlerBase.handleRequestBody(org.apache.solr.request.SolrQueryRequest, org.apache.solr.request.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).
public Set<String> getHiddenFiles()
public void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp) throws IOException
handleRequestBody
in class RequestHandlerBase
IOException
@Deprecated public static String getFileContents(String path)
handleRequestBody(SolrQueryRequest, SolrQueryResponse)
.
public String getDescription()
SolrInfoMBean
getDescription
in interface SolrInfoMBean
getDescription
in class RequestHandlerBase
public String getVersion()
SolrInfoMBean
getVersion
in interface SolrInfoMBean
getVersion
in class RequestHandlerBase
public String getSourceId()
SolrInfoMBean
getSourceId
in interface SolrInfoMBean
getSourceId
in class RequestHandlerBase
public String getSource()
SolrInfoMBean
getSource
in interface SolrInfoMBean
getSource
in class RequestHandlerBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |