org.dataone.solr.handler.component

Class SolrSearchHandlerUtil

java.lang.Object

org.dataone.solr.handler.component.SolrSearchHandlerUtil

public class SolrSearchHandlerUtil
extends Object

Utility class to provide shared behavior among extensions/customizations of SolrSearchHandler classes. The main scope of this utility is to provide modification of solr search parameters to provide security authorization restrictions regarding which solr records a DataONE user is allowed to read. Also provides a replacement for SolrParams.toMultiMap to support fields like facet.field which appear more than one time as request parameters.

Author:

sroseboo

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_HTTP_REQUEST_KEY

Constructor Summary

Constructors

Constructor and Description
SolrSearchHandlerUtil()

Method Summary

Modifier and Type	Method and Description
static void	applyReadRestrictionQueryFilterParameters(javax.servlet.http.HttpServletRequest httpServletRequest, HashMap<String,String[]> convertedSolrParams, List<String> readFields)
static void	applyReadRestrictionQueryFilterParameters(javax.servlet.http.HttpServletRequest httpServletRequest, HashMap<String,String[]> convertedSolrParams, String readField)
static void	applyRowRestrictions(org.apache.solr.common.params.SolrParams requestParams, HashMap<String,String[]> convertedSolrParams)
static String	escapeQueryChars(String s) See: http://lucene.apache.org/java/docs/queryparsersyntax.html#Escaping%20 Special%20Characters
static HashMap<String,String[]>	getConvertedParameters(org.apache.solr.common.params.SolrParams solrParams)
static boolean	isCNAdministrator(String[] isAdministrator)
static boolean	isValidSolrParam(String[] solrParam)
static void	logSolrContext(org.apache.solr.request.SolrQueryRequest req)
static void	logSolrParameters(HashMap<String,String[]> convertedSolrParams)
static void	setNewSolrParameters(org.apache.solr.request.SolrQueryRequest request, HashMap<String,String[]> convertedSolrParams)
static Map<String,String[]>	toMultiMap(org.apache.solr.common.util.NamedList params) This method is a replacement for SolrParams.toMultiMap.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTEXT_HTTP_REQUEST_KEY

public static final String CONTEXT_HTTP_REQUEST_KEY

See Also:

Constant Field Values

Constructor Detail

SolrSearchHandlerUtil

public SolrSearchHandlerUtil()

Method Detail

applyReadRestrictionQueryFilterParameters

public static void applyReadRestrictionQueryFilterParameters(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                             HashMap<String,String[]> convertedSolrParams,
                                                             String readField)

applyReadRestrictionQueryFilterParameters

public static void applyReadRestrictionQueryFilterParameters(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                             HashMap<String,String[]> convertedSolrParams,
                                                             List<String> readFields)

applyRowRestrictions

public static void applyRowRestrictions(org.apache.solr.common.params.SolrParams requestParams,
                                        HashMap<String,String[]> convertedSolrParams)

isValidSolrParam

public static boolean isValidSolrParam(String[] solrParam)

isCNAdministrator

public static boolean isCNAdministrator(String[] isAdministrator)

logSolrContext

public static void logSolrContext(org.apache.solr.request.SolrQueryRequest req)

logSolrParameters

public static void logSolrParameters(HashMap<String,String[]> convertedSolrParams)

getConvertedParameters

public static HashMap<String,String[]> getConvertedParameters(org.apache.solr.common.params.SolrParams solrParams)

setNewSolrParameters

public static void setNewSolrParameters(org.apache.solr.request.SolrQueryRequest request,
                                        HashMap<String,String[]> convertedSolrParams)

toMultiMap

public static Map<String,String[]> toMultiMap(org.apache.solr.common.util.NamedList params)

This method is a replacement for SolrParams.toMultiMap. This method was updated in later versions in particular with this fix: https://issues.apache.org/jira/browse/SOLR-1666 replaces to address issues dealing with request parameters that can occur multiple times in a request, for example facet.field. The current version does not properly handle this conversion causing errors.

escapeQueryChars

public static String escapeQueryChars(String s)

See: http://lucene.apache.org/java/docs/queryparsersyntax.html#Escaping%20 Special%20Characters