com.nkang.kxmoment.util.SolrUtils.HttpSolrServer.java Source code

Java tutorial

Introduction

Here is the source code for com.nkang.kxmoment.util.SolrUtils.HttpSolrServer.java

Source

package com.nkang.kxmoment.util.SolrUtils;

/*
 * 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.
 */

import java.io.IOException;
import java.io.InputStream;
import java.net.ConnectException;
import java.net.SocketTimeoutException;
import java.nio.charset.Charset;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Locale;
import java.util.ResourceBundle;
import java.util.Set;

import org.apache.commons.io.IOUtils;
import org.apache.http.Header;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.NameValuePair;
import org.apache.http.NoHttpResponseException;
import org.apache.http.client.HttpClient;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.client.params.ClientPNames;
import org.apache.http.conn.ClientConnectionManager;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.InputStreamEntity;
import org.apache.http.entity.mime.FormBodyPart;
import org.apache.http.entity.mime.HttpMultipartMode;
import org.apache.http.entity.mime.MultipartEntity;
import org.apache.http.entity.mime.content.InputStreamBody;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.message.BasicHeader;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import org.apache.solr.client.solrj.ResponseParser;
import org.apache.solr.client.solrj.SolrRequest;
import org.apache.solr.client.solrj.SolrServer;
import org.apache.solr.client.solrj.SolrServerException;
import org.apache.solr.client.solrj.impl.BinaryResponseParser;
import org.apache.solr.client.solrj.impl.HttpClientUtil;
import org.apache.solr.client.solrj.request.RequestWriter;
import org.apache.solr.client.solrj.request.UpdateRequest;
import org.apache.solr.client.solrj.response.UpdateResponse;
import org.apache.solr.client.solrj.util.ClientUtils;
import org.apache.solr.common.SolrException;
import org.apache.solr.common.SolrInputDocument;
import org.apache.solr.common.params.CommonParams;
import org.apache.solr.common.params.ModifiableSolrParams;
import org.apache.solr.common.params.SolrParams;
import org.apache.solr.common.util.ContentStream;
import org.apache.solr.common.util.NamedList;
//import org.slf4j.Logger;
//import org.slf4j.LoggerFactory;

@SuppressWarnings("deprecation")
public class HttpSolrServer extends SolrServer {
    private static final String UTF_8 = "UTF-8";
    private static final String DEFAULT_PATH = "/select";
    private static final long serialVersionUID = -946812319974801896L;

    /**
     * User-Agent String.
     */
    public static final String AGENT = "Solr[" + HttpSolrServer.class.getName() + "] 1.0";

    //private static Logger log = LoggerFactory.getLogger(HttpSolrServer.class);

    /**
     * The URL of the Solr server.
     */
    protected String baseUrl;

    /**
     * Default value: null / empty.
     * <p/>
     * Parameters that are added to every request regardless. This may be a place
     * to add something like an authentication token.
     */
    protected ModifiableSolrParams invariantParams;

    /**
     * Default response parser is BinaryResponseParser
     * <p/>
     * This parser represents the default Response Parser chosen to parse the
     * response if the parser were not specified as part of the request.
     * 
     * @see org.apache.solr.client.solrj.impl.BinaryResponseParser
     */
    protected volatile ResponseParser parser;

    /**
     * The RequestWriter used to write all requests to Solr
     * 
     * @see org.apache.solr.client.solrj.request.RequestWriter
     */
    protected volatile RequestWriter requestWriter = new RequestWriter();

    private final HttpClient httpClient;

    private boolean followRedirects = false;

    private int maxRetries = 0;

    private boolean useMultiPartPost;
    private final boolean internalClient;

    private Set<String> queryParams = Collections.emptySet();

    /**
     * @param baseURL
     *          The URL of the Solr server. For example, "
     *          <code>http://localhost:8983/solr/</code>" if you are using the
     *          standard distribution Solr webapp on your local machine.
     */
    public HttpSolrServer(String baseURL) {
        this(baseURL, null, new BinaryResponseParser());
    }

    public HttpSolrServer(String baseURL, HttpClient client) {
        this(baseURL, client, new BinaryResponseParser());
    }

    public HttpSolrServer(String baseURL, HttpClient client, ResponseParser parser) {
        this.baseUrl = baseURL;
        if (baseUrl.endsWith("/")) {
            baseUrl = baseUrl.substring(0, baseUrl.length() - 1);
        }
        if (baseUrl.indexOf('?') >= 0) {
            throw new RuntimeException(
                    "Invalid base url for solrj.  The base URL must not contain parameters: " + baseUrl);
        }

        if (client != null) {
            httpClient = client;
            internalClient = false;
        } else {
            internalClient = true;
            ModifiableSolrParams params = new ModifiableSolrParams();
            params.set(HttpClientUtil.PROP_MAX_CONNECTIONS, 128);
            params.set(HttpClientUtil.PROP_MAX_CONNECTIONS_PER_HOST, 32);
            params.set(HttpClientUtil.PROP_FOLLOW_REDIRECTS, followRedirects);
            httpClient = HttpClientUtil.createClient(params);
        }

        this.parser = parser;
    }

    public Set<String> getQueryParams() {
        return queryParams;
    }

    /**
     * Expert Method.
     * @param queryParams set of param keys to only send via the query string
     */
    public void setQueryParams(Set<String> queryParams) {
        this.queryParams = queryParams;
    }

    /**
     * Process the request. If
     * {@link org.apache.solr.client.solrj.SolrRequest#getResponseParser()} is
     * null, then use {@link #getParser()}
     * 
     * @param request
     *          The {@link org.apache.solr.client.solrj.SolrRequest} to process
     * @return The {@link org.apache.solr.common.util.NamedList} result
     * @throws IOException If there is a low-level I/O error.
     * 
     * @see #request(org.apache.solr.client.solrj.SolrRequest,
     *      org.apache.solr.client.solrj.ResponseParser)
     */
    @Override
    public NamedList<Object> request(final SolrRequest request) throws SolrServerException, IOException {
        ResponseParser responseParser = request.getResponseParser();
        if (responseParser == null) {
            responseParser = parser;
        }
        return request(request, responseParser);
    }

    public NamedList<Object> request(final SolrRequest request, final ResponseParser processor)
            throws SolrServerException, IOException {
        HttpRequestBase method = null;
        InputStream is = null;
        SolrParams params = request.getParams();
        Collection<ContentStream> streams = requestWriter.getContentStreams(request);
        String path = requestWriter.getPath(request);
        if (path == null || !path.startsWith("/")) {
            path = DEFAULT_PATH;
        }

        ResponseParser parser = request.getResponseParser();
        if (parser == null) {
            parser = this.parser;
        }

        // The parser 'wt=' and 'version=' params are used instead of the original
        // params
        ModifiableSolrParams wparams = new ModifiableSolrParams(params);
        if (parser != null) {
            wparams.set(CommonParams.WT, parser.getWriterType());
            wparams.set(CommonParams.VERSION, parser.getVersion());
        }
        if (invariantParams != null) {
            wparams.add(invariantParams);
        }

        int tries = maxRetries + 1;
        try {
            while (tries-- > 0) {
                // Note: since we aren't do intermittent time keeping
                // ourselves, the potential non-timeout latency could be as
                // much as tries-times (plus scheduling effects) the given
                // timeAllowed.
                try {
                    if (SolrRequest.METHOD.GET == request.getMethod()) {
                        if (streams != null) {
                            throw new SolrException(SolrException.ErrorCode.BAD_REQUEST, "GET can't send streams!");
                        }
                        method = new HttpGet(baseUrl + path + ClientUtils.toQueryString(wparams, false));
                    } else if (SolrRequest.METHOD.POST == request.getMethod()) {

                        String url = baseUrl + path;
                        boolean hasNullStreamName = false;
                        if (streams != null) {
                            for (ContentStream cs : streams) {
                                if (cs.getName() == null) {
                                    hasNullStreamName = true;
                                    break;
                                }
                            }
                        }
                        boolean isMultipart = (this.useMultiPartPost || (streams != null && streams.size() > 1))
                                && !hasNullStreamName;

                        // only send this list of params as query string params
                        ModifiableSolrParams queryParams = new ModifiableSolrParams();
                        for (String param : this.queryParams) {
                            String[] value = wparams.getParams(param);
                            if (value != null) {
                                for (String v : value) {
                                    queryParams.add(param, v);
                                }
                                wparams.remove(param);
                            }
                        }

                        LinkedList<NameValuePair> postParams = new LinkedList<NameValuePair>();
                        if (streams == null || isMultipart) {
                            HttpPost post = new HttpPost(url + ClientUtils.toQueryString(queryParams, false));
                            post.setHeader("Content-Charset", "UTF-8");
                            if (!isMultipart) {
                                post.addHeader("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
                            }

                            List<FormBodyPart> parts = new LinkedList<FormBodyPart>();
                            Iterator<String> iter = wparams.getParameterNamesIterator();
                            while (iter.hasNext()) {
                                String p = iter.next();
                                String[] vals = wparams.getParams(p);
                                if (vals != null) {
                                    for (String v : vals) {
                                        if (isMultipart) {
                                            parts.add(new FormBodyPart(p,
                                                    new StringBody(v, Charset.forName("UTF-8"))));
                                        } else {
                                            postParams.add(new BasicNameValuePair(p, v));
                                        }
                                    }
                                }
                            }

                            if (isMultipart && streams != null) {
                                for (ContentStream content : streams) {
                                    String contentType = content.getContentType();
                                    if (contentType == null) {
                                        contentType = BinaryResponseParser.BINARY_CONTENT_TYPE; // default
                                    }
                                    String name = content.getName();
                                    if (name == null) {
                                        name = "";
                                    }
                                    parts.add(new FormBodyPart(name, new InputStreamBody(content.getStream(),
                                            contentType, content.getName())));
                                }
                            }

                            if (parts.size() > 0) {
                                MultipartEntity entity = new MultipartEntity(HttpMultipartMode.STRICT);
                                for (FormBodyPart p : parts) {
                                    entity.addPart(p);
                                }
                                post.setEntity(entity);
                            } else {
                                //not using multipart
                                post.setEntity(new UrlEncodedFormEntity(postParams, "UTF-8"));
                            }

                            method = post;
                        }
                        // It is has one stream, it is the post body, put the params in the URL
                        else {
                            String pstr = ClientUtils.toQueryString(wparams, false);
                            HttpPost post = new HttpPost(url + pstr);

                            // Single stream as body
                            // Using a loop just to get the first one
                            final ContentStream[] contentStream = new ContentStream[1];
                            for (ContentStream content : streams) {
                                contentStream[0] = content;
                                break;
                            }
                            if (contentStream[0] instanceof RequestWriter.LazyContentStream) {
                                post.setEntity(new InputStreamEntity(contentStream[0].getStream(), -1) {
                                    @Override
                                    public Header getContentType() {
                                        return new BasicHeader("Content-Type", contentStream[0].getContentType());
                                    }

                                    @Override
                                    public boolean isRepeatable() {
                                        return false;
                                    }

                                });
                            } else {
                                post.setEntity(new InputStreamEntity(contentStream[0].getStream(), -1) {
                                    @Override
                                    public Header getContentType() {
                                        return new BasicHeader("Content-Type", contentStream[0].getContentType());
                                    }

                                    @Override
                                    public boolean isRepeatable() {
                                        return false;
                                    }
                                });
                            }
                            method = post;
                        }
                    } else {
                        throw new SolrServerException("Unsupported method: " + request.getMethod());
                    }
                } catch (NoHttpResponseException r) {
                    method = null;
                    if (is != null) {
                        is.close();
                    }
                    // If out of tries then just rethrow (as normal error).
                    if (tries < 1) {
                        throw r;
                    }
                }
            }
        } catch (IOException ex) {
            throw new SolrServerException("error reading streams", ex);
        }

        // client already has this set, is this needed
        method.getParams().setParameter(ClientPNames.HANDLE_REDIRECTS, followRedirects);
        method.addHeader("User-Agent", AGENT);

        // add jauth information
        //String username = WebServiceLoaderUtils.getWebServiceProperty(Constants.SECURITY_USERNAME).toString();
        //String password = WebServiceLoaderUtils.getWebServiceProperty(Constants.SECURITY_PASSWORD).toString();

        ResourceBundle bundle = ResourceBundle.getBundle("solrconfig");
        String username;
        String password;
        username = bundle.getString("wsUsername.url");
        password = bundle.getString("wsPassword.url");

        method.addHeader("username", username);
        method.addHeader("password", password);

        InputStream respBody = null;
        boolean shouldClose = true;
        boolean success = false;
        try {
            // Execute the method.
            final HttpResponse response = httpClient.execute(method);
            int httpStatus = response.getStatusLine().getStatusCode();

            // Read the contents
            respBody = response.getEntity().getContent();
            Header ctHeader = response.getLastHeader("content-type");
            String contentType;
            if (ctHeader != null) {
                contentType = ctHeader.getValue();
            } else {
                contentType = "";
            }

            // handle some http level checks before trying to parse the response
            switch (httpStatus) {
            case HttpStatus.SC_OK:
            case HttpStatus.SC_BAD_REQUEST:
            case HttpStatus.SC_CONFLICT: // 409
                break;
            case HttpStatus.SC_MOVED_PERMANENTLY:
            case HttpStatus.SC_MOVED_TEMPORARILY:
                if (!followRedirects) {
                    throw new SolrServerException(
                            "Server at " + getBaseURL() + " sent back a redirect (" + httpStatus + ").");
                }
                break;
            default:
                if (processor == null) {
                    throw new RemoteSolrException(httpStatus,
                            "Server at " + getBaseURL() + " returned non ok status:" + httpStatus + ", message:"
                                    + response.getStatusLine().getReasonPhrase(),
                            null);
                }
            }
            if (processor == null) {

                // no processor specified, return raw stream
                NamedList<Object> rsp = new NamedList<Object>();
                rsp.add("stream", respBody);
                // Only case where stream should not be closed
                shouldClose = false;
                success = true;
                return rsp;
            }

            String procCt = processor.getContentType();
            if (procCt != null) {
                String procMimeType = ContentType.parse(procCt).getMimeType().trim().toLowerCase(Locale.ROOT);
                String mimeType = ContentType.parse(contentType).getMimeType().trim().toLowerCase(Locale.ROOT);
                if (!procMimeType.equals(mimeType)) {
                    // unexpected mime type
                    String msg = "Expected mime type " + procMimeType + " but got " + mimeType + ".";
                    Header encodingHeader = response.getEntity().getContentEncoding();
                    String encoding;
                    if (encodingHeader != null) {
                        encoding = encodingHeader.getValue();
                    } else {
                        encoding = "UTF-8"; // try UTF-8
                    }
                    try {
                        msg = msg + " " + IOUtils.toString(respBody, encoding);
                    } catch (IOException e) {
                        throw new RemoteSolrException(httpStatus,
                                "Could not parse response with encoding " + encoding, e);
                    }
                    RemoteSolrException e = new RemoteSolrException(httpStatus, msg, null);
                    throw e;
                }
            }

            //      if(true) {
            //        ByteArrayOutputStream copy = new ByteArrayOutputStream();
            //        IOUtils.copy(respBody, copy);
            //        String val = new String(copy.toByteArray());
            //        System.out.println(">RESPONSE>"+val+"<"+val.length());
            //        respBody = new ByteArrayInputStream(copy.toByteArray());
            //      }

            NamedList<Object> rsp = null;
            String charset = EntityUtils.getContentCharSet(response.getEntity());
            try {
                rsp = processor.processResponse(respBody, charset);
            } catch (Exception e) {
                throw new RemoteSolrException(httpStatus, e.getMessage(), e);
            }
            if (httpStatus != HttpStatus.SC_OK) {
                String reason = null;
                try {
                    NamedList<?> err = (NamedList<?>) rsp.get("error");
                    if (err != null) {
                        reason = (String) err.get("msg");
                        // TODO? get the trace?
                    }
                } catch (Exception ex) {
                }
                if (reason == null) {
                    StringBuilder msg = new StringBuilder();
                    msg.append(response.getStatusLine().getReasonPhrase());
                    msg.append("\n\n");
                    msg.append("request: " + method.getURI());
                    reason = java.net.URLDecoder.decode(msg.toString(), UTF_8);
                }
                throw new RemoteSolrException(httpStatus, reason, null);
            }
            success = true;
            return rsp;
        } catch (ConnectException e) {
            throw new SolrServerException("Server refused connection at: " + getBaseURL(), e);
        } catch (SocketTimeoutException e) {
            throw new SolrServerException("Timeout occured while waiting response from server at: " + getBaseURL(),
                    e);
        } catch (IOException e) {
            throw new SolrServerException("IOException occured when talking to server at: " + getBaseURL(), e);
        } finally {
            if (respBody != null && shouldClose) {
                try {
                    respBody.close();
                } catch (IOException e) {
                    //log.error("", e);
                } finally {
                    if (!success) {
                        method.abort();
                    }
                }
            }
        }
    }

    // -------------------------------------------------------------------
    // -------------------------------------------------------------------

    /**
     * Retrieve the default list of parameters are added to every request
     * regardless.
     * 
     * @see #invariantParams
     */
    public ModifiableSolrParams getInvariantParams() {
        return invariantParams;
    }

    public String getBaseURL() {
        return baseUrl;
    }

    public void setBaseURL(String baseURL) {
        this.baseUrl = baseURL;
    }

    public ResponseParser getParser() {
        return parser;
    }

    /**
     * Note: This setter method is <b>not thread-safe</b>.
     * 
     * @param processor
     *          Default Response Parser chosen to parse the response if the parser
     *          were not specified as part of the request.
     * @see org.apache.solr.client.solrj.SolrRequest#getResponseParser()
     */
    public void setParser(ResponseParser processor) {
        parser = processor;
    }

    /**
     * Return the HttpClient this instance uses.
     */
    public HttpClient getHttpClient() {
        return httpClient;
    }

    /**
     * HttpConnectionParams.setConnectionTimeout
     * 
     * @param timeout
     *          Timeout in milliseconds
     **/
    public void setConnectionTimeout(int timeout) {
        HttpClientUtil.setConnectionTimeout(httpClient, timeout);
    }

    /**
     * Set SoTimeout (read timeout). This is desirable
     * for queries, but probably not for indexing.
     * 
     * @param timeout
     *          Timeout in milliseconds
     **/
    public void setSoTimeout(int timeout) {
        HttpClientUtil.setSoTimeout(httpClient, timeout);
    }

    /**
     * Configure whether the client should follow redirects or not.
     * <p>
     * This defaults to false under the assumption that if you are following a
     * redirect to get to a Solr installation, something is misconfigured
     * somewhere.
     * </p>
     */
    public void setFollowRedirects(boolean followRedirects) {
        this.followRedirects = followRedirects;
        HttpClientUtil.setFollowRedirects(httpClient, followRedirects);
    }

    /**
     * Allow server->client communication to be compressed. Currently gzip and
     * deflate are supported. If the server supports compression the response will
     * be compressed. This method is only allowed if the http client is of type
     * DefatulHttpClient.
     */
    public void setAllowCompression(boolean allowCompression) {
        if (httpClient instanceof DefaultHttpClient) {
            HttpClientUtil.setAllowCompression((DefaultHttpClient) httpClient, allowCompression);
        } else {
            throw new UnsupportedOperationException("HttpClient instance was not of type DefaultHttpClient");
        }
    }

    /**
     * Set maximum number of retries to attempt in the event of transient errors.
     * <p>
     * Maximum number of retries to attempt in the event of transient errors.
     * Default: 0 (no) retries. No more than 1 recommended.
     * </p>
     * @param maxRetries
     *          No more than 1 recommended
     */
    public void setMaxRetries(int maxRetries) {
        if (maxRetries > 1) {
            //log.warn("HttpSolrServer: maximum Retries " + maxRetries
            //    + " > 1. Maximum recommended retries is 1.");
        }
        this.maxRetries = maxRetries;
    }

    public void setRequestWriter(RequestWriter requestWriter) {
        this.requestWriter = requestWriter;
    }

    /**
     * Adds the documents supplied by the given iterator.
     * 
     * @param docIterator
     *          the iterator which returns SolrInputDocument instances
     * 
     * @return the response from the SolrServer
     */
    public UpdateResponse add(Iterator<SolrInputDocument> docIterator) throws SolrServerException, IOException {
        UpdateRequest req = new UpdateRequest();
        req.setDocIterator(docIterator);
        return req.process(this);
    }

    /**
     * Adds the beans supplied by the given iterator.
     * 
     * @param beanIterator
     *          the iterator which returns Beans
     * 
     * @return the response from the SolrServer
     */
    public UpdateResponse addBeans(final Iterator<?> beanIterator) throws SolrServerException, IOException {
        UpdateRequest req = new UpdateRequest();
        req.setDocIterator(new Iterator<SolrInputDocument>() {

            //@Override
            public boolean hasNext() {
                return beanIterator.hasNext();
            }

            //@Override
            public SolrInputDocument next() {
                Object o = beanIterator.next();
                if (o == null) {
                    return null;
                }
                return getBinder().toSolrInputDocument(o);
            }

            //@Override
            public void remove() {
                beanIterator.remove();
            }
        });
        return req.process(this);
    }

    /**
     * Close the {@link ClientConnectionManager} from the internal client.
     */
    @Override
    public void shutdown() {
        if (httpClient != null && internalClient) {
            httpClient.getConnectionManager().shutdown();
        }
    }

    /**
     * Set the maximum number of connections that can be open to a single host at
     * any given time. If http client was created outside the operation is not
     * allowed.
     */
    public void setDefaultMaxConnectionsPerHost(int max) {
        if (internalClient) {
            HttpClientUtil.setMaxConnectionsPerHost(httpClient, max);
        } else {
            throw new UnsupportedOperationException("Client was created outside of HttpSolrServer");
        }
    }

    /**
     * Set the maximum number of connections that can be open at any given time.
     * If http client was created outside the operation is not allowed.
     */
    public void setMaxTotalConnections(int max) {
        if (internalClient) {
            HttpClientUtil.setMaxConnections(httpClient, max);
        } else {
            throw new UnsupportedOperationException("Client was created outside of HttpSolrServer");
        }
    }

    public boolean isUseMultiPartPost() {
        return useMultiPartPost;
    }

    /**
     * Set the multipart connection properties
     */
    public void setUseMultiPartPost(boolean useMultiPartPost) {
        this.useMultiPartPost = useMultiPartPost;
    }

    /**
     * Subclass of SolrException that allows us to capture an arbitrary HTTP
     * status code that may have been returned by the remote server or a 
     * proxy along the way.
     */
    public static class RemoteSolrException extends SolrException {
        private static final long serialVersionUID = 1L;

        /**
          * @param code Arbitrary HTTP status code
          * @param msg Exception Message
          * @param th Throwable to wrap with this Exception
          */
        public RemoteSolrException(int code, String msg, Throwable th) {
            super(code, msg, th);
        }
    }
}