LDAPConnectorCapabilitiesAdapter

extends LDAPConnector
implements Capabilities

java.lang.Object
↳	org.mule.module.ldap.LDAPConnector
	↳	org.mule.module.ldap.adapters.LDAPConnectorCapabilitiesAdapter

Known Direct Subclasses

LDAPConnectorMetadataAdapater

Known Indirect Subclasses

LDAPConnectorConnectionIdentifierAdapter, LDAPConnectorLifecycleAdapter, LDAPConnectorProcessAdapter

Class Overview

A LDAPConnectorCapabilitiesAdapter is a wrapper around LDAPConnector that implements org.mule.api.Capabilities interface.

Summary

[Expand]

Inherited Fields

From class org.mule.module.ldap.LDAPConnector

private static final Logger	LOGGER
private LDAPConnection	connection
private Map<String, String>	extendedConfiguration	This is a Map instance holding extended configuration attributes that will be used in the Context environment.
private int	initialPoolSize	The string representation of an integer that represents the number of connections per connection identity to create when initially creating a connection for the identity.
private int	maxPoolSize	The string representation of an integer that represents the maximum number of connections per connection identity that can be maintained concurrently.
private long	poolTimeout	The string representation of an integer that represents the number of milliseconds that an idle connection may remain in the pool without being closed and removed from the pool.
private Referral	referral	Constant that holds the name of the environment property for specifying how referrals encountered by the service provider are to be processed (follow, ignore, throw).
private Type	type	The implementation of the connection to be used.
private String	url	The connection URL to the LDAP server with the following syntax: `ldap[s]://hostname:port/base_dn`.

Public Constructors
	LDAPConnectorCapabilitiesAdapter()

Public Methods
boolean	isCapableOf(Capability capability) Returns true if this module implements such capability

[Expand]

Inherited Methods

From class org.mule.module.ldap.LDAPConnector

void	add(LDAPEntry entry) Creates a new `LDAPEntry` in the LDAP server.
void	addFromMap(String dn, Map<String, Object> entry) Creates a new entry in the LDAP server from a Map representation.
void	addMultiValueAttribute(String dn, String attributeName, List<Object> attributeValues) Adds all the values for an attribute in an existing LDAP entry.
void	addSingleValueAttribute(String dn, String attributeName, String attributeValue) Adds a value for an attribute in an existing LDAP entry.
LDAPEntry	bind() Performs an LDAP bind (login) operation.
void	connect(String authDn, String authPassword, String authentication) Establish the connection to the LDAP server and use connection management to handle different users.
String	connectionId() Returns the connection ID
void	delete(String dn) Deletes the LDAP entry represented by the provided distinguished name.
void	deleteMultiValueAttribute(String dn, String attributeName, List<Object> attributeValues) Deletes all the values matching attributeValues of the attribute defined by attributeName.
void	deleteSingleValueAttribute(String dn, String attributeName, String attributeValue) Deletes the value matching attributeValue of the attribute defined by attributeName.
void	disconnect() Disconnect the current connection
Map<String, String>	getExtendedConfiguration()
int	getInitialPoolSize()
int	getMaxPoolSize()
long	getPoolTimeout()
Referral	getReferral()
Type	getType()
String	getUrl()
boolean	isConnected() Are we connected?
static String	ldapEntryToLdif(LDAPEntry entry) Transforms a `LDAPEntry` to a String in LDIF representation (RFC 2849).
static Map<String, Object>	ldapEntryToMap(LDAPEntry entry) Creates the Map representation of an `LDAPEntry`.
LDAPEntry	lookup(String dn, List<String> attributes) Retrieves an entry from the LDAP server base on its distinguished name (DN).
static LDAPEntry	mapToLdapEntry(Map<String, Object> entry) Creates a `LDAPEntry` from its Map representation.
void	modify(LDAPEntry entry) Updates an existing `LDAPEntry` in the LDAP server.
void	modifyFromMap(String dn, Map<String, Object> entry) Updates an existing entry in the LDAP server from a Map representation.
void	modifyMultiValueAttribute(String dn, String attributeName, List<Object> attributeValues) Updates (replaces) the value or values of the attribute defined by attributeName with the new values defined by attributeValues.
void	modifySingleValueAttribute(String dn, String attributeName, String attributeValue) Updates (replaces) the value or values of the attribute defined by attributeName with the new value defined by attributeValue.
List<Object>	pagedResultSearch(String baseDn, String filter, List<String> attributes, SearchScope scope, int timeout, long maxResults, boolean returnObject, int pageSize, int resultPageSize, SourceCallback callback) Performs a LDAP search and streams result to the rest of the flow.
void	rename(String oldDn, String newDn) Renames and existing LDAP entry (moves and entry from a DN to another one).
List<LDAPEntry>	search(String baseDn, String filter, List<String> attributes, SearchScope scope, int timeout, long maxResults, boolean returnObject, int pageSize) Performs a LDAP search returning a list with all the resulting LDAP entries.
LDAPEntry	searchOne(String baseDn, String filter, List<String> attributes, SearchScope scope, int timeout, long maxResults, boolean returnObject) Performs a LDAP search that is supposed to return a unique result.
void	setExtendedConfiguration(Map<String, String> extendedConfiguration)
void	setInitialPoolSize(int initialPoolSize)
void	setMaxPoolSize(int maxPoolSize)
void	setPoolTimeout(long poolTimeout)
void	setReferral(Referral referral)
void	setType(Type type)
void	setUrl(String url)

From class java.lang.Object

From interface org.mule.api.Capabilities

Public Constructors

public LDAPConnectorCapabilitiesAdapter ()

Public Methods

public boolean isCapableOf (Capability capability)

Returns true if this module implements such capability

Parameters

capability

Classes