Package org.apache.camel.component.springldap

Class SpringLdapProducer

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultProducer
org.apache.camel.component.springldap.SpringLdapProducer
All Implemented Interfaces:
AutoCloseable, org.apache.camel.EndpointAware, org.apache.camel.IsSingleton, org.apache.camel.Processor, org.apache.camel.Producer, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
public class SpringLdapProducer extends org.apache.camel.support.DefaultProducer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ATTRIBUTES
     
    static final String
    DN
     
    static final String
    FILTER
     
    static final String
    FUNCTION
     
    static final String
    MODIFICATION_ITEMS
     
    static final String
    PASSWORD
     
    static final String
    REQUEST
     

    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
    SpringLdapProducer(SpringLdapEndpoint endpoint)
    Initializes the SpringLdapProducer with the given endpoint

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    process(org.apache.camel.Exchange exchange)
    Performs the LDAP operation defined in SpringLdapEndpoint that created this producer.

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

    createExchange, doStart, doStop, getEndpoint, isSingleton, toString

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

    build, doBuild, doFail, doInit, doLifecycleChange, doResume, doShutdown, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    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

  • Field Details

  • Constructor Details

    • SpringLdapProducer

      public SpringLdapProducer(SpringLdapEndpoint endpoint)
      Initializes the SpringLdapProducer with the given endpoint

  • Method Details

    • process

      public void process(org.apache.camel.Exchange exchange) throws Exception
      Performs the LDAP operation defined in SpringLdapEndpoint that created this producer. The in-message in the exchange must be a map, containing the following entries: 
       key: "dn" - base DN for the LDAP operation
 key: "filter" - necessary for the search operation only; LDAP filter for the search operation,
 see <a http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol>http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol
 key: "attributes" - necessary for the bind operation only; an instance of javax.naming.directory.Attributes,
 containing the information necessary to create an LDAP node.
 key: "password" - necessary for the authentication operation only;
 key: "modificationItems" - necessary for the modify_attributes operation only;
 key: "function" - necessary for the function_driven operation only; provides a flexible hook into the LdapTemplate to call any method
 key: "request" - necessary for the function_driven operation only; passed into the "function" to enable the client to bind parameters that need to be passed into the LdapTemplate
      The keys are defined as final fields above.
      Throws:
      Exception