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:

CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, HasId, StatefulService, SuspendableService

@UriEndpoint(scheme="spring-ldap",
             title="Spring LDAP",
             syntax="spring-ldap:templateName",
             producerOnly=true,
             label="spring,ldap")
public class SpringLdapEndpoint
extends DefaultEndpoint

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

Methods

Modifier and Type	Method and Description
Consumer	createConsumer(Processor processor) Consumer endpoints are not supported.
String	createEndpointUri() A factory method to lazily create the endpointUri if none is specified
Producer	createProducer() Creates a Producer using this SpringLdapEndpoint
boolean	isSingleton() returns false (constant)
void	setOperation(String operation) Sets the LDAP operation to be performed.
void	setScope(String scope) sets the scope of the LDAP operation.

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, getExchangePattern, getId, getPollingConsumerQueueSize, hashCode, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, 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, 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 Producer createProducer()
                        throws Exception

Creates a Producer using this SpringLdapEndpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Consumer endpoints are not supported.

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

isSingleton

public boolean isSingleton()

returns false (constant)

Returns:

true to be a single shared instance, false to create new instances.

setScope

public void setScope(String scope)

sets the scope of the LDAP operation. The scope string must be one of "object = 0", "onelevel = 1", or "subtree = 2"

createEndpointUri

public String createEndpointUri()

Description copied from class: DefaultEndpoint

A factory method to lazily create the endpointUri if none is specified

Overrides:

createEndpointUri in class DefaultEndpoint

Returns:

URI used to create this endpoint

setOperation

public void setOperation(String operation)

Sets the LDAP operation to be performed. The supported operations are defined in org.apache.camel.component.springldap.LdapOperation.