org.bonitasoft.connectors.ldap

Class LdapConnector

java.lang.Object

org.bonitasoft.engine.connector.AbstractConnector

org.bonitasoft.connectors.ldap.LdapConnector

All Implemented Interfaces:

org.bonitasoft.engine.connector.Connector

public class LdapConnector
extends org.bonitasoft.engine.connector.AbstractConnector

This connector provides an LDAP service of querying directory service. This connector does the search operation.

Author:

Matthieu Chaffotte

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTES_PARAMETER
static String	BASE_OBJECT_PARAMETER
static String	DEREF_ALIASES_PARAMETER
static String	FILTER_PARAMETER
static String	HOST_PARAMETER
static String	LDAP_ATTRIBUTE_LIST_OUTPUT
static String	PAGE_SIZE_PARAMETER
static String	PASSWORD_PARAMETER
static String	PORT_PARAMETER
static String	PROTOCOL_PARAMETER
static String	REFERRAL_HANDLING_PARAMETER
static String	SCOPE_PARAMETER
static String	SIZE_LIMIT_PARAMETER
static String	TIME_LIMIT_PARAMETER
static String	USERNAME_PARAMETER

Fields inherited from class org.bonitasoft.engine.connector.AbstractConnector

apiAccessor

Constructor Summary

Constructors

Constructor and Description
LdapConnector()

Method Summary

Modifier and Type	Method and Description
protected void	executeBusinessLogic()
String[]	getAttributes()
String	getBaseObject()
String	getCertificatePath()
LdapDereferencingAlias	getDerefAliases()
String	getFilter()
List<List<LdapAttribute>>	getLdapAttributeList()
long	getPageSize()
String	getPassword()
LdapProtocol	getProtocol()
String	getReferralHandling()
LdapScope	getScope()
long	getSizeLimit()
int	getTimeLimit()
String	getUserName()
void	setAttributes(String attributes)
void	setAttributes(String[] attributes)
void	setBaseObject(String baseObject)
void	setDerefAliases(LdapDereferencingAlias derefAliases)
void	setDerefAliases(String derefAliases)
void	setFilter(String filter)
void	setHost(String host)
void	setInputParameters(Map<String,Object> parameters)
void	setPageSize(long pageSize)
void	setPageSize(Long pageSize)
void	setPassword(String password)
void	setPort(int port)
void	setPort(Long port)
void	setProtocol(LdapProtocol protocol)
void	setProtocol(String protocol)
void	setReferralHandling(String referralHandling)
void	setScope(LdapScope scope)
void	setScope(String scope)
void	setSizeLimit(long sizeLimit)
void	setSizeLimit(Long sizeLimit)
void	setTimeLimit(int timeLimit) Sets the time-limit during a search in seconds.
void	setTimeLimit(Long timeLimit) Sets the time-limit during a search in seconds.
void	setUserName(String userName)
void	validateInputParameters()

Methods inherited from class org.bonitasoft.engine.connector.AbstractConnector

connect, disconnect, execute, getAPIAccessor, getExecutionContext, getInputParameter, getInputParameter, getOutputParameters, setAPIAccessor, setExecutionContext, setOutputParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HOST_PARAMETER

public static final String HOST_PARAMETER

See Also:

Constant Field Values

PORT_PARAMETER

public static final String PORT_PARAMETER

See Also:

Constant Field Values

PROTOCOL_PARAMETER

public static final String PROTOCOL_PARAMETER

See Also:

Constant Field Values

USERNAME_PARAMETER

public static final String USERNAME_PARAMETER

See Also:

Constant Field Values

PASSWORD_PARAMETER

public static final String PASSWORD_PARAMETER

See Also:

Constant Field Values

BASE_OBJECT_PARAMETER

public static final String BASE_OBJECT_PARAMETER

See Also:

Constant Field Values

SCOPE_PARAMETER

public static final String SCOPE_PARAMETER

See Also:

Constant Field Values

FILTER_PARAMETER

public static final String FILTER_PARAMETER

See Also:

Constant Field Values

ATTRIBUTES_PARAMETER

public static final String ATTRIBUTES_PARAMETER

See Also:

Constant Field Values

SIZE_LIMIT_PARAMETER

public static final String SIZE_LIMIT_PARAMETER

See Also:

Constant Field Values

PAGE_SIZE_PARAMETER

public static final String PAGE_SIZE_PARAMETER

See Also:

Constant Field Values

TIME_LIMIT_PARAMETER

public static final String TIME_LIMIT_PARAMETER

See Also:

Constant Field Values

REFERRAL_HANDLING_PARAMETER

public static final String REFERRAL_HANDLING_PARAMETER

See Also:

Constant Field Values

DEREF_ALIASES_PARAMETER

public static final String DEREF_ALIASES_PARAMETER

See Also:

Constant Field Values

LDAP_ATTRIBUTE_LIST_OUTPUT

public static final String LDAP_ATTRIBUTE_LIST_OUTPUT

See Also:

Constant Field Values

Constructor Detail

LdapConnector

public LdapConnector()

Method Detail

getProtocol

public LdapProtocol getProtocol()

getUserName

public String getUserName()

getPassword

public String getPassword()

getCertificatePath

public String getCertificatePath()

getBaseObject

public String getBaseObject()

getScope

public LdapScope getScope()

getFilter

public String getFilter()

getDerefAliases

public LdapDereferencingAlias getDerefAliases()

getAttributes

public String[] getAttributes()

getSizeLimit

public long getSizeLimit()

getPageSize

public long getPageSize()

getTimeLimit

public int getTimeLimit()

getLdapAttributeList

public List<List<LdapAttribute>> getLdapAttributeList()

getReferralHandling

public String getReferralHandling()

setHost

public void setHost(String host)

setPort

public void setPort(Long port)

setPort

public void setPort(int port)

setProtocol

public void setProtocol(LdapProtocol protocol)

setProtocol

public void setProtocol(String protocol)

setUserName

public void setUserName(String userName)

setPassword

public void setPassword(String password)

setBaseObject

public void setBaseObject(String baseObject)

setScope

public void setScope(LdapScope scope)

setScope

public void setScope(String scope)

setFilter

public void setFilter(String filter)

setDerefAliases

public void setDerefAliases(LdapDereferencingAlias derefAliases)

setDerefAliases

public void setDerefAliases(String derefAliases)

setAttributes

public void setAttributes(String[] attributes)

setAttributes

public void setAttributes(String attributes)

setSizeLimit

public void setSizeLimit(long sizeLimit)

setSizeLimit

public void setSizeLimit(Long sizeLimit)

setPageSize

public void setPageSize(long pageSize)

setPageSize

public void setPageSize(Long pageSize)

setTimeLimit

public void setTimeLimit(int timeLimit)

Sets the time-limit during a search in seconds.

Parameters:

timeLimit, - the search time limit in seconds

setTimeLimit

public void setTimeLimit(Long timeLimit)

Sets the time-limit during a search in seconds.

Parameters:

timeLimit, - the search time limit in seconds

setReferralHandling

public void setReferralHandling(String referralHandling)

setInputParameters

public void setInputParameters(Map<String,Object> parameters)

Specified by:

setInputParameters in interface org.bonitasoft.engine.connector.Connector

Overrides:

setInputParameters in class org.bonitasoft.engine.connector.AbstractConnector

executeBusinessLogic

protected void executeBusinessLogic()
                             throws org.bonitasoft.engine.connector.ConnectorException

Specified by:

executeBusinessLogic in class org.bonitasoft.engine.connector.AbstractConnector

Throws:

org.bonitasoft.engine.connector.ConnectorException

validateInputParameters

public void validateInputParameters()
                             throws org.bonitasoft.engine.connector.ConnectorValidationException

Throws:

org.bonitasoft.engine.connector.ConnectorValidationException