Package org.apache.camel.builder.endpoint.dsl

Interface SolrEndpointBuilderFactory.SolrEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    Enclosing interface:
    SolrEndpointBuilderFactory
    public static interface SolrEndpointBuilderFactory.SolrEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint for the Solr component.

    • Method Detail

      • autoCommit

        default SolrEndpointBuilderFactory.SolrEndpointBuilder autoCommit​(boolean autoCommit)
        If true, each producer operation will be automatically followed by a commit. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        autoCommit - the value to set
        Returns:
        the dsl builder

      • autoCommit

        default SolrEndpointBuilderFactory.SolrEndpointBuilder autoCommit​(String autoCommit)
        If true, each producer operation will be automatically followed by a commit. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        autoCommit - the value to set
        Returns:
        the dsl builder

      • connectionTimeout

        default SolrEndpointBuilderFactory.SolrEndpointBuilder connectionTimeout​(Integer connectionTimeout)
        Sets the connection timeout on the SolrClient. The option is a: <code>java.lang.Integer</code> type. Group: producer
        Parameters:
        connectionTimeout - the value to set
        Returns:
        the dsl builder

      • connectionTimeout

        default SolrEndpointBuilderFactory.SolrEndpointBuilder connectionTimeout​(String connectionTimeout)
        Sets the connection timeout on the SolrClient. The option will be converted to a <code>java.lang.Integer</code> type. Group: producer
        Parameters:
        connectionTimeout - the value to set
        Returns:
        the dsl builder

      • defaultMaxConnectionsPerHost

        @Deprecated
default SolrEndpointBuilderFactory.SolrEndpointBuilder defaultMaxConnectionsPerHost​(Integer defaultMaxConnectionsPerHost)
        Deprecated.
        maxConnectionsPerHost on the underlying HttpConnectionManager. The option is a: <code>java.lang.Integer</code> type. Group: producer
        Parameters:
        defaultMaxConnectionsPerHost - the value to set
        Returns:
        the dsl builder

      • defaultMaxConnectionsPerHost

        @Deprecated
default SolrEndpointBuilderFactory.SolrEndpointBuilder defaultMaxConnectionsPerHost​(String defaultMaxConnectionsPerHost)
        Deprecated.
        maxConnectionsPerHost on the underlying HttpConnectionManager. The option will be converted to a <code>java.lang.Integer</code> type. Group: producer
        Parameters:
        defaultMaxConnectionsPerHost - the value to set
        Returns:
        the dsl builder

      • httpClient

        default SolrEndpointBuilderFactory.SolrEndpointBuilder httpClient​(Object httpClient)
        Sets the http client to be used by the solrClient. This is only applicable when solrClient is not set. The option is a: <code>org.apache.http.client.HttpClient</code> type. Group: producer
        Parameters:
        httpClient - the value to set
        Returns:
        the dsl builder

      • httpClient

        default SolrEndpointBuilderFactory.SolrEndpointBuilder httpClient​(String httpClient)
        Sets the http client to be used by the solrClient. This is only applicable when solrClient is not set. The option will be converted to a <code>org.apache.http.client.HttpClient</code> type. Group: producer
        Parameters:
        httpClient - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default SolrEndpointBuilderFactory.SolrEndpointBuilder lazyStartProducer​(boolean lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default SolrEndpointBuilderFactory.SolrEndpointBuilder lazyStartProducer​(String lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • maxRetries

        @Deprecated
default SolrEndpointBuilderFactory.SolrEndpointBuilder maxRetries​(Integer maxRetries)
        Deprecated.
        Maximum number of retries to attempt in the event of transient errors. The option is a: <code>java.lang.Integer</code> type. Group: producer
        Parameters:
        maxRetries - the value to set
        Returns:
        the dsl builder

      • maxRetries

        @Deprecated
default SolrEndpointBuilderFactory.SolrEndpointBuilder maxRetries​(String maxRetries)
        Deprecated.
        Maximum number of retries to attempt in the event of transient errors. The option will be converted to a <code>java.lang.Integer</code> type. Group: producer
        Parameters:
        maxRetries - the value to set
        Returns:
        the dsl builder

      • maxTotalConnections

        @Deprecated
default SolrEndpointBuilderFactory.SolrEndpointBuilder maxTotalConnections​(Integer maxTotalConnections)
        Deprecated.
        maxTotalConnection on the underlying HttpConnectionManager. The option is a: <code>java.lang.Integer</code> type. Group: producer
        Parameters:
        maxTotalConnections - the value to set
        Returns:
        the dsl builder

      • maxTotalConnections

        @Deprecated
default SolrEndpointBuilderFactory.SolrEndpointBuilder maxTotalConnections​(String maxTotalConnections)
        Deprecated.
        maxTotalConnection on the underlying HttpConnectionManager. The option will be converted to a <code>java.lang.Integer</code> type. Group: producer
        Parameters:
        maxTotalConnections - the value to set
        Returns:
        the dsl builder

      • requestHandler

        default SolrEndpointBuilderFactory.SolrEndpointBuilder requestHandler​(String requestHandler)
        Set the request handler to be used. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        requestHandler - the value to set
        Returns:
        the dsl builder

      • solrClient

        default SolrEndpointBuilderFactory.SolrEndpointBuilder solrClient​(Object solrClient)
        Uses the provided solr client to connect to solr. When this parameter is not specified, camel applies the following rules to determine the SolrClient: 1) when zkHost or zkChroot (=zookeeper root) parameter is set, then the CloudSolrClient is used. 2) when multiple hosts are specified in the uri (separated with a comma), then the CloudSolrClient (uri scheme is 'solrCloud') or the LBHttpSolrClient (uri scheme is not 'solrCloud') is used. 3) when the solr operation is INSERT_STREAMING, then the ConcurrentUpdateSolrClient is used. 4) otherwise, the HttpSolrClient is used. Note: A CloudSolrClient should point to zookeeper endpoint(s); other clients point to Solr endpoint(s). The SolrClient can also be set via the exchange header 'CamelSolrClient'. The option is a: <code>org.apache.solr.client.solrj.SolrClient</code> type. Group: producer
        Parameters:
        solrClient - the value to set
        Returns:
        the dsl builder

      • solrClient

        default SolrEndpointBuilderFactory.SolrEndpointBuilder solrClient​(String solrClient)
        Uses the provided solr client to connect to solr. When this parameter is not specified, camel applies the following rules to determine the SolrClient: 1) when zkHost or zkChroot (=zookeeper root) parameter is set, then the CloudSolrClient is used. 2) when multiple hosts are specified in the uri (separated with a comma), then the CloudSolrClient (uri scheme is 'solrCloud') or the LBHttpSolrClient (uri scheme is not 'solrCloud') is used. 3) when the solr operation is INSERT_STREAMING, then the ConcurrentUpdateSolrClient is used. 4) otherwise, the HttpSolrClient is used. Note: A CloudSolrClient should point to zookeeper endpoint(s); other clients point to Solr endpoint(s). The SolrClient can also be set via the exchange header 'CamelSolrClient'. The option will be converted to a <code>org.apache.solr.client.solrj.SolrClient</code> type. Group: producer
        Parameters:
        solrClient - the value to set
        Returns:
        the dsl builder

      • soTimeout

        default SolrEndpointBuilderFactory.SolrEndpointBuilder soTimeout​(Integer soTimeout)
        Sets the socket timeout on the SolrClient. The option is a: <code>java.lang.Integer</code> type. Group: producer
        Parameters:
        soTimeout - the value to set
        Returns:
        the dsl builder

      • soTimeout

        default SolrEndpointBuilderFactory.SolrEndpointBuilder soTimeout​(String soTimeout)
        Sets the socket timeout on the SolrClient. The option will be converted to a <code>java.lang.Integer</code> type. Group: producer
        Parameters:
        soTimeout - the value to set
        Returns:
        the dsl builder

      • streamingQueueSize

        default SolrEndpointBuilderFactory.SolrEndpointBuilder streamingQueueSize​(int streamingQueueSize)
        Sets the queue size for the ConcurrentUpdateSolrClient. The option is a: <code>int</code> type. Default: 10 Group: producer
        Parameters:
        streamingQueueSize - the value to set
        Returns:
        the dsl builder

      • streamingQueueSize

        default SolrEndpointBuilderFactory.SolrEndpointBuilder streamingQueueSize​(String streamingQueueSize)
        Sets the queue size for the ConcurrentUpdateSolrClient. The option will be converted to a <code>int</code> type. Default: 10 Group: producer
        Parameters:
        streamingQueueSize - the value to set
        Returns:
        the dsl builder

      • streamingThreadCount

        default SolrEndpointBuilderFactory.SolrEndpointBuilder streamingThreadCount​(int streamingThreadCount)
        Sets the number of threads for the ConcurrentUpdateSolrClient. The option is a: <code>int</code> type. Default: 2 Group: producer
        Parameters:
        streamingThreadCount - the value to set
        Returns:
        the dsl builder

      • streamingThreadCount

        default SolrEndpointBuilderFactory.SolrEndpointBuilder streamingThreadCount​(String streamingThreadCount)
        Sets the number of threads for the ConcurrentUpdateSolrClient. The option will be converted to a <code>int</code> type. Default: 2 Group: producer
        Parameters:
        streamingThreadCount - the value to set
        Returns:
        the dsl builder

      • collection

        default SolrEndpointBuilderFactory.SolrEndpointBuilder collection​(String collection)
        Set the default collection for SolrCloud. The option is a: <code>java.lang.String</code> type. Group: CloudSolrClient
        Parameters:
        collection - the value to set
        Returns:
        the dsl builder

      • zkChroot

        default SolrEndpointBuilderFactory.SolrEndpointBuilder zkChroot​(String zkChroot)
        Set the chroot of the zookeeper connection (include the leading slash; e.g. '/mychroot'). The option is a: <code>java.lang.String</code> type. Group: CloudSolrClient
        Parameters:
        zkChroot - the value to set
        Returns:
        the dsl builder

      • zkHost

        default SolrEndpointBuilderFactory.SolrEndpointBuilder zkHost​(String zkHost)
        Set the ZooKeeper host(s) urls which the CloudSolrClient uses, e.g. zkHost=localhost:2181,localhost:2182. Optionally add the chroot, e.g. zkHost=localhost:2181,localhost:2182/rootformysolr. In case the first part of the url path (='contextroot') is set to 'solr' (e.g. 'localhost:2181/solr' or 'localhost:2181/solr/..'), then that path is not considered as zookeeper chroot for backward compatibility reasons (this behaviour can be overridden via zkChroot parameter). The option is a: <code>java.lang.String</code> type. Group: CloudSolrClient
        Parameters:
        zkHost - the value to set
        Returns:
        the dsl builder

      • allowCompression

        default SolrEndpointBuilderFactory.SolrEndpointBuilder allowCompression​(Boolean allowCompression)
        Server side must support gzip or deflate for this to have any effect. The option is a: <code>java.lang.Boolean</code> type. Group: HttpSolrClient
        Parameters:
        allowCompression - the value to set
        Returns:
        the dsl builder

      • allowCompression

        default SolrEndpointBuilderFactory.SolrEndpointBuilder allowCompression​(String allowCompression)
        Server side must support gzip or deflate for this to have any effect. The option will be converted to a <code>java.lang.Boolean</code> type. Group: HttpSolrClient
        Parameters:
        allowCompression - the value to set
        Returns:
        the dsl builder

      • followRedirects

        default SolrEndpointBuilderFactory.SolrEndpointBuilder followRedirects​(Boolean followRedirects)
        Indicates whether redirects are used to get to the Solr server. The option is a: <code>java.lang.Boolean</code> type. Group: HttpSolrClient
        Parameters:
        followRedirects - the value to set
        Returns:
        the dsl builder

      • followRedirects

        default SolrEndpointBuilderFactory.SolrEndpointBuilder followRedirects​(String followRedirects)
        Indicates whether redirects are used to get to the Solr server. The option will be converted to a <code>java.lang.Boolean</code> type. Group: HttpSolrClient
        Parameters:
        followRedirects - the value to set
        Returns:
        the dsl builder

      • password

        default SolrEndpointBuilderFactory.SolrEndpointBuilder password​(String password)
        Sets password for basic auth plugin enabled servers. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        password - the value to set
        Returns:
        the dsl builder

      • username

        default SolrEndpointBuilderFactory.SolrEndpointBuilder username​(String username)
        Sets username for basic auth plugin enabled servers. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        username - the value to set
        Returns:
        the dsl builder