org.apache.camel.component.springldap

Class SpringLdapEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.springldap.SpringLdapEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="2.11.0",
             scheme="spring-ldap",
             title="Spring LDAP",
             syntax="spring-ldap:templateName",
             producerOnly=true,
             label="spring,ldap")
public class SpringLdapEndpoint
extends org.apache.camel.impl.DefaultEndpoint

The spring-ldap component allows you to perform searches in LDAP servers using filters as the message payload.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
SpringLdapEndpoint(String templateName, org.springframework.ldap.core.LdapTemplate ldapTemplate) Initializes the SpringLdapEndpoint using the provided template

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
String	createEndpointUri()
org.apache.camel.Producer	createProducer()
org.springframework.ldap.core.LdapTemplate	getLdapTemplate()
LdapOperation	getOperation()
String	getScope()
String	getTemplateName()
boolean	isSingleton()
int	scopeValue()
void	setOperation(LdapOperation operation) The LDAP operation to be performed.
void	setScope(String scope) The scope of the search operation.
void	setTemplateName(String templateName) Name of the Spring LDAP Template bean

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createExchange, createExchange, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

SpringLdapEndpoint

public SpringLdapEndpoint(String templateName,
                          org.springframework.ldap.core.LdapTemplate ldapTemplate)

Initializes the SpringLdapEndpoint using the provided template

Parameters:

templateName - name of the LDAP template

ldapTemplate - LDAP template, see org.springframework.ldap.core.LdapTemplate

Method Detail

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

isSingleton

public boolean isSingleton()

createEndpointUri

public String createEndpointUri()

Overrides:

createEndpointUri in class org.apache.camel.impl.DefaultEndpoint

getLdapTemplate

public org.springframework.ldap.core.LdapTemplate getLdapTemplate()

getTemplateName

public String getTemplateName()

setTemplateName

public void setTemplateName(String templateName)

Name of the Spring LDAP Template bean

getOperation

public LdapOperation getOperation()

setOperation

public void setOperation(LdapOperation operation)

The LDAP operation to be performed.

getScope

public String getScope()

setScope

public void setScope(String scope)

The scope of the search operation.

scopeValue

public int scopeValue()