Skip to content

Commit

Permalink
HSEARCH-2642 Throw exceptions when trying to use blacklists in TypeTo…
Browse files Browse the repository at this point in the history
…kenFilterFactory-based analyzer defs with Elasticsearch

Elasticsearch only supports whitelists.
  • Loading branch information
yrodiere authored and Sanne committed May 9, 2017
1 parent c14054b commit 4cbd045
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 1 deletion.
Expand Up @@ -457,4 +457,8 @@ BulkRequestFailedException elasticsearchBulkRequestFailed(String request, String
value = "For simple query string queries, Elasticsearch does not support overriding fields with more than one different analyzers: %1$s.")
SearchException unableToOverrideQueryAnalyzerWithMoreThanOneAnalyzersForSimpleQueryStringQueries(Collection<String> analyzers);

@Message(id = ES_BACKEND_MESSAGES_START_ID + 84,
value = "The parameter '%2$s' must have value '%3$s' for the factory '%1$s' with Elasticsearch. Current value '%4$s' is invalid." )
SearchException invalidAnalysisFactoryParameter(@FormatWith(ClassFormatter.class) Class<?> factoryType, String parameter,
String expectedValue, String actualValue);
}
Expand Up @@ -484,11 +484,11 @@ public void start(Properties properties, BuildContext context) {
.disallow( "enablePositionIncrements" )
.end()
.builder( TypeTokenFilterFactory.class, "keep_types" )
.mandateAndStrip( "useWhitelist", "true" )
.transform(
"types",
new WordSetFileParameterValueTransformer( resourceLoader )
)
.disallow( "useWhitelist" )
.disallow( "enablePositionIncrements" )
.end()
.builder( ClassicFilterFactory.class, "classic" ).end()
Expand Down
Expand Up @@ -87,6 +87,10 @@ public SimpleAnalysisDefinitionFactoryBuilder<D> disallow(String luceneParam) {
return transform( luceneParam, new ThrowingUnsupportedParameterValueTransformer( luceneClass, luceneParam ) );
}

public SimpleAnalysisDefinitionFactoryBuilder<D> mandateAndStrip(String luceneParam, String luceneValue) {
return transform( new ThrowingMandatoryStrippedParametersTransformer( luceneClass, luceneParam, luceneValue ) );
}

public SimpleAnalysisDefinitionFactoryBuilder<D> rename(String luceneParam, String elasticsearchParam) {
if ( parameterNameTranslations == null ) {
parameterNameTranslations = new HashMap<>();
Expand Down
@@ -0,0 +1,54 @@
/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.search.elasticsearch.settings.impl.translation;

import java.util.Collections;
import java.util.Map;

import org.hibernate.search.elasticsearch.logging.impl.Log;
import org.hibernate.search.util.logging.impl.LoggerFactory;

import com.google.gson.JsonElement;

class ThrowingMandatoryStrippedParametersTransformer implements ParametersTransformer {

private static final Log log = LoggerFactory.make( Log.class );

private final Class<?> factoryClass;
private final String parameterName;
private final String expectedValue;

ThrowingMandatoryStrippedParametersTransformer(Class<?> factoryClass, String parameterName, String expectedValue) {
this.factoryClass = factoryClass;
this.parameterName = parameterName;
this.expectedValue = expectedValue;
}

@Override
public Map<String, JsonElement> transform(Map<String, String> luceneParameters) {
String actualValue = luceneParameters.remove( parameterName );

if ( !expectedValue.equals( actualValue ) ) {
throw log.invalidAnalysisFactoryParameter( factoryClass, parameterName, expectedValue, actualValue );
}

return Collections.emptyMap();
}

@Override
public String toString() {
return new StringBuilder( getClass().getSimpleName() )
.append( "[" )
.append( factoryClass )
.append( "," )
.append( parameterName )
.append( "," )
.append( expectedValue )
.append( "]" )
.toString();
}
}

0 comments on commit 4cbd045

Please sign in to comment.