org.apache.camel.builder.endpoint.dsl

Interface LdapEndpointBuilderFactory.LdapEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

LdapEndpointBuilderFactory

public static interface LdapEndpointBuilderFactory.LdapEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the LDAP component.

Method Summary

Modifier and Type	Method and Description
default LdapEndpointBuilderFactory.LdapEndpointBuilder	base(String base) The base DN for searches.
default LdapEndpointBuilderFactory.LdapEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default LdapEndpointBuilderFactory.LdapEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default LdapEndpointBuilderFactory.LdapEndpointBuilder	pageSize(Integer pageSize) When specified the ldap module uses paging to retrieve all results (most LDAP Servers throw an exception when trying to retrieve more than 1000 entries in one query).
default LdapEndpointBuilderFactory.LdapEndpointBuilder	pageSize(String pageSize) When specified the ldap module uses paging to retrieve all results (most LDAP Servers throw an exception when trying to retrieve more than 1000 entries in one query).
default LdapEndpointBuilderFactory.LdapEndpointBuilder	returnedAttributes(String returnedAttributes) Comma-separated list of attributes that should be set in each entry of the result.
default LdapEndpointBuilderFactory.LdapEndpointBuilder	scope(String scope) Specifies how deeply to search the tree of entries, starting at the base DN.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

base

default LdapEndpointBuilderFactory.LdapEndpointBuilder base(String base)

The base DN for searches. The option is a: <code>java.lang.String</code> type. Default: ou=system Group: producer

Parameters:

base - the value to set

Returns:

the dsl builder

lazyStartProducer

default LdapEndpointBuilderFactory.LdapEndpointBuilder 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 LdapEndpointBuilderFactory.LdapEndpointBuilder 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

pageSize

default LdapEndpointBuilderFactory.LdapEndpointBuilder pageSize(Integer pageSize)

When specified the ldap module uses paging to retrieve all results (most LDAP Servers throw an exception when trying to retrieve more than 1000 entries in one query). To be able to use this a LdapContext (subclass of DirContext) has to be passed in as ldapServerBean (otherwise an exception is thrown). The option is a: <code>java.lang.Integer</code> type. Group: producer

Parameters:

pageSize - the value to set

Returns:

the dsl builder

pageSize

default LdapEndpointBuilderFactory.LdapEndpointBuilder pageSize(String pageSize)

When specified the ldap module uses paging to retrieve all results (most LDAP Servers throw an exception when trying to retrieve more than 1000 entries in one query). To be able to use this a LdapContext (subclass of DirContext) has to be passed in as ldapServerBean (otherwise an exception is thrown). The option will be converted to a <code>java.lang.Integer</code> type. Group: producer

Parameters:

pageSize - the value to set

Returns:

the dsl builder

returnedAttributes

default LdapEndpointBuilderFactory.LdapEndpointBuilder returnedAttributes(String returnedAttributes)

Comma-separated list of attributes that should be set in each entry of the result. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

returnedAttributes - the value to set

Returns:

the dsl builder

scope

default LdapEndpointBuilderFactory.LdapEndpointBuilder scope(String scope)

Specifies how deeply to search the tree of entries, starting at the base DN. The option is a: <code>java.lang.String</code> type. Default: subtree Group: producer

Parameters:

scope - the value to set

Returns:

the dsl builder