org.apache.solr.request.LocalSolrQueryRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of solr-core Show documentation
Show all versions of solr-core Show documentation
Apache Solr (module: core)
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.solr.request;
import java.security.Principal;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Objects;
import org.apache.solr.common.params.CommonParams;
import org.apache.solr.common.params.MultiMapSolrParams;
import org.apache.solr.common.params.SolrParams;
import org.apache.solr.common.util.NamedList;
import org.apache.solr.core.SolrCore;
// With the addition of SolrParams, this class isn't needed for much anymore... it's currently
// retained more for backward compatibility.
/** */
public class LocalSolrQueryRequest extends SolrQueryRequestBase {
public String userPrincipalName = null;
protected static SolrParams makeParams(
String query, String qtype, int start, int limit, Map args) {
Map map = new HashMap<>();
for (Iterator> iter = args.entrySet().iterator(); iter.hasNext(); ) {
Map.Entry e = iter.next();
String k = e.getKey().toString();
Object v = e.getValue();
if (v instanceof String[]) map.put(k, (String[]) v);
else map.put(k, new String[] {v.toString()});
}
if (query != null) map.put(CommonParams.Q, new String[] {query});
if (qtype != null) map.put(CommonParams.QT, new String[] {qtype});
map.put(CommonParams.START, new String[] {Integer.toString(start)});
map.put(CommonParams.ROWS, new String[] {Integer.toString(limit)});
return new MultiMapSolrParams(map);
}
public LocalSolrQueryRequest(
SolrCore core, String query, String qtype, int start, int limit, Map args) {
super(core, makeParams(query, qtype, start, limit, args));
}
public LocalSolrQueryRequest(SolrCore core, NamedList args) {
super(core, args.toSolrParams());
}
public LocalSolrQueryRequest(SolrCore core, Map args) {
super(core, new MultiMapSolrParams(args));
}
public LocalSolrQueryRequest(SolrCore core, SolrParams args) {
super(core, args);
}
@Override
public Principal getUserPrincipal() {
return new LocalPrincipal(this.userPrincipalName);
}
/**
* Allows setting the 'name' of the User Principal for the purposes of creating local requests in
* a solr node when security is enabled. It is experiemental and subject to removal
*
* @see org.apache.solr.security.PKIAuthenticationPlugin#NODE_IS_USER
* @see #getUserPrincipal
* @lucene.internal
* @lucene.experimental
*/
public void setUserPrincipalName(String s) {
this.userPrincipalName = s;
}
private static final class LocalPrincipal implements Principal {
private final String user;
public LocalPrincipal(String user) {
this.user = user;
}
@Override
public String getName() {
return user;
}
@Override
public int hashCode() {
return Objects.hashCode(user);
}
@Override
public boolean equals(Object other) {
return Objects.equals(this.getClass(), other.getClass())
&& Objects.equals(this.getName(), ((LocalPrincipal) other).getName());
}
}
}