org.apache.camel.component.springldap

Class SpringLdapProducer

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultProducer

org.apache.camel.component.springldap.SpringLdapProducer

All Implemented Interfaces:

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.impl.DefaultProducer

Field Summary

Fields

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

Fields inherited from class org.apache.camel.impl.DefaultProducer

log

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

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

Constructor Summary

Constructors

Constructor and Description
SpringLdapProducer(SpringLdapEndpoint endpoint) Initializes the SpringLdapProducer with the given endpoint

Method Summary

Modifier and Type	Method and 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.impl.DefaultProducer

createExchange, createExchange, createExchange, doStart, doStop, getEndpoint, isSingleton, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Field Detail

DN

public static final String DN

See Also:

Constant Field Values

FILTER

public static final String FILTER

See Also:

Constant Field Values

ATTRIBUTES

public static final String ATTRIBUTES

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

See Also:

Constant Field Values

MODIFICATION_ITEMS

public static final String MODIFICATION_ITEMS

See Also:

Constant Field Values

FUNCTION

public static final String FUNCTION

See Also:

Constant Field Values

REQUEST

public static final String REQUEST

See Also:

Constant Field Values

Constructor Detail

SpringLdapProducer

public SpringLdapProducer(SpringLdapEndpoint endpoint)

Initializes the SpringLdapProducer with the given endpoint

Method Detail

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 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