Package org.apache.camel.component.springldap

Class SpringLdapEndpoint

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultEndpoint
org.apache.camel.component.springldap.SpringLdapEndpoint
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.ComponentAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasCamelContext, 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, category=SECURITY) public class SpringLdapEndpoint extends org.apache.camel.support.DefaultEndpoint
Perform searches in LDAP servers using filters as the message payload.

  • Field Summary

    Fields inherited from class org.apache.camel.support.service.BaseService

    BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    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()
     
    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.support.DefaultEndpoint

    configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

    Methods inherited from class org.apache.camel.support.service.BaseService

    build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, 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.ComponentAware

    getComponent

    Methods inherited from interface org.apache.camel.Endpoint

    getEndpointBaseUri, isSingletonProducer

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

    Methods inherited from interface org.apache.camel.ShutdownableService

    shutdown

    Methods inherited from interface org.apache.camel.StatefulService

    getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

    Methods inherited from interface org.apache.camel.SuspendableService

    isSuspended, resume, suspend

  • Constructor Details

    • SpringLdapEndpoint

      public SpringLdapEndpoint(String endpointUri, SpringLdapComponent component, String templateName, org.springframework.ldap.core.LdapTemplate ldapTemplate)
      Initializes the SpringLdapEndpoint using the provided template
      Parameters:
      endpointUri - the full URI used to create this endpoint
      component - the component that created this endpoint
      templateName - name of the LDAP template
      ldapTemplate - LDAP template, see org.springframework.ldap.core.LdapTemplate

  • Method Details

    • 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

    • createEndpointUri

      public String createEndpointUri()
      Overrides:
      createEndpointUri in class org.apache.camel.support.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()