org.flowable.ldap

Class LDAPConfigurator

java.lang.Object

org.flowable.common.engine.impl.AbstractEngineConfigurator

org.flowable.idm.engine.configurator.IdmEngineConfigurator

org.flowable.ldap.LDAPConfigurator

All Implemented Interfaces:

EngineConfigurator

public class LDAPConfigurator
extends IdmEngineConfigurator

A EngineConfigurator that integrates a LDAP system with the Flowable process engine. The LDAP system will be consulted primarily for getting user information and in particular for fetching groups of a user. This class is extensible and many methods can be overridden when the default behavior is not fitting your use case. Check the docs (specifically the setters) to see how this class can be tweaked.

Author:

Joram Barrez

Field Summary

Fields

Modifier and Type	Field and Description
protected LDAPConfiguration	ldapConfiguration

Fields inherited from class org.flowable.idm.engine.configurator.IdmEngineConfigurator

idmEngineConfiguration

Fields inherited from class org.flowable.common.engine.impl.AbstractEngineConfigurator

enableMybatisXmlMappingValidation

Constructor Summary

Constructors

Constructor and Description
LDAPConfigurator()

Method Summary

Modifier and Type	Method and Description
void	beforeInit(AbstractEngineConfiguration engineConfiguration) Called before any initialisation has been done.
void	configure(AbstractEngineConfiguration engineConfiguration) Called when the engine boots up, before it is usable, but after the initialisation of internal objects is done.
protected static IdmEngineConfiguration	getIdmEngineConfiguration(AbstractEngineConfiguration engineConfiguration)
LDAPConfiguration	getLdapConfiguration()
void	setLdapConfiguration(LDAPConfiguration ldapConfiguration)

Methods inherited from class org.flowable.idm.engine.configurator.IdmEngineConfigurator

getCustomDeployers, getEntityDeletionOrder, getEntityInsertionOrder, getIdmEngineConfiguration, getMybatisCfgPath, getPriority, setIdmEngineConfiguration

Methods inherited from class org.flowable.common.engine.impl.AbstractEngineConfigurator

createDocumentBuilderFactory, getMybatisTypeAliases, getMybatisTypeHandlers, initClock, initCommandContextFactory, initDataSource, initDbProperties, initDbSqlSessionFactory, initEngineConfigurations, initEventDispatcher, initEventRegistryEventConsumers, initialiseCommonProperties, initIdGenerator, initObjectMapper, initServiceConfigurations, initSessionFactories, initVariableTypes, isEnableMybatisXmlMappingValidation, registerCustomDeployers, registerCustomMybatisMappings, setEnableMybatisXmlMappingValidation

Methods inherited from class java.lang.Object

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

Field Detail

ldapConfiguration

protected LDAPConfiguration ldapConfiguration

Constructor Detail

LDAPConfigurator

public LDAPConfigurator()

Method Detail

beforeInit

public void beforeInit(AbstractEngineConfiguration engineConfiguration)

Description copied from interface: EngineConfigurator

Called before any initialisation has been done. This can for example be useful to change configuration settings before anything that uses those properties is created. Allows to tweak the engine by passing the AbstractEngineConfiguration which allows tweaking it programmatically. An example is the jdbc url. When a EngineConfigurator instance wants to change it, it needs to do it in this method, or otherwise the datasource would already have been created with the 'old' value for the jdbc url.

Specified by:

beforeInit in interface EngineConfigurator

Overrides:

beforeInit in class AbstractEngineConfigurator

configure

public void configure(AbstractEngineConfiguration engineConfiguration)

Description copied from interface: EngineConfigurator

Called when the engine boots up, before it is usable, but after the initialisation of internal objects is done. Allows to tweak the engine by passing the AbstractEngineConfiguration which allows tweaking it programmatically. An example is the ldap user/group manager, which is an addition to the engine. No default properties need to be overridden for this (otherwise the EngineConfigurator.beforeInit(AbstractEngineConfiguration) method should be used) so the logic contained in this method is executed after initialisation of the default objects. Probably a better name would be 'afterInit' (cfr EngineConfigurator.beforeInit(AbstractEngineConfiguration)), but not possible due to backwards compatibility.

Specified by:

configure in interface EngineConfigurator

Overrides:

configure in class IdmEngineConfigurator

getLdapConfiguration

public LDAPConfiguration getLdapConfiguration()

setLdapConfiguration

public void setLdapConfiguration(LDAPConfiguration ldapConfiguration)

getIdmEngineConfiguration

protected static IdmEngineConfiguration getIdmEngineConfiguration(AbstractEngineConfiguration engineConfiguration)