Package org.frankframework.ldap

Class AbstractLdapQueryPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.ldap.AbstractLdapQueryPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IForwardTarget, INamedObject, IPipe, IScopeProvider, IWithParameters, EventThrowing, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

LdapFindGroupMembershipsPipe, LdapFindMemberPipe

@Forward(name="*",
         description="When {@literal notFoundForwardName} or {@literal exceptionForwardName} is used")
public abstract class AbstractLdapQueryPipe
extends FixedForwardPipe

Base pipe for querying LDAP.

Author:

Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field	Description
protected CredentialFactory	cf
protected PipeForward	exceptionForward
protected PipeForward	notFoundForward

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class org.frankframework.core.TransactionAttributes

log

Fields inherited from interface org.frankframework.core.IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
AbstractLdapQueryPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	checks for correct configuration of forward
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
abstract PipeRunResult	doPipeWithException(Message message, PipeLineSession session)
String	getAuthAlias()
String	getBaseDN()
String	getExceptionForwardName()
String	getHost()
String	getLdapProviderURL()
String	getNotFoundForwardName()
String	getPassword()
int	getPort()
String	getUsername()
boolean	isUseSsl()
protected String	retrieveUrl(String host, int port, String baseDN, boolean useSsl)
void	setAuthAlias(String string)	Alias used to obtain credentials to connect to ldap server
void	setBaseDN(String baseDN)	BaseDN, e.g.
void	setExceptionForwardName(String string)	PipeForward used when an exception is caught
void	setHost(String string)	Host part of ldapProviderUrl.
void	setLdapProviderURL(String string)	Url to context to search in, e.g.
void	setNotFoundForwardName(String string)
void	setPassword(String string)	Password used to obtain credentials to connect to ldap server
void	setPort(int i)	Port of ldapProviderUrl.
void	setUsername(String string)	Username used to obtain credentials to connect to ldap server
void	setUseSsl(boolean b)	Indication to use ldap or ldaps in ldapProviderUrl.

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

getIfParam, getIfValue, getOnlyIfSessionKey, getOnlyIfValue, getParameterValue, getSuccessForward, getUnlessSessionKey, getUnlessValue, isSkipOnEmptyInput, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getApplicationContext, getChompCharSize, getConfigurationClassLoader, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getEventSourceName, getForwards, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getName, getParameterList, getPipeLine, getSecLogSessionKeys, getStoreResultInSessionKey, hasRegisteredForward, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setEventPublisher, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPipeLine, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, getTransactionAttribute, getTransactionTimeout, getTxDef, isTransacted, isTransacted, setTransacted, setTransactionAttribute, setTransactionTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.frankframework.core.IPipe

throwEvent

Field Details

cf

protected CredentialFactory cf

notFoundForward

protected PipeForward notFoundForward

exceptionForward

protected PipeForward exceptionForward

Constructor Details

AbstractLdapQueryPipe

public AbstractLdapQueryPipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

checks for correct configuration of forward

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class FixedForwardPipe

Throws:

ConfigurationException

doPipe

public PipeRunResult doPipe(Message message,
 PipeLineSession session)
                     throws PipeRunException

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.

Throws:

PipeRunException

doPipeWithException

public abstract PipeRunResult doPipeWithException(Message message,
 PipeLineSession session)
                                           throws PipeRunException

Throws:

PipeRunException

retrieveUrl

protected String retrieveUrl(String host,
 int port,
 String baseDN,
 boolean useSsl)

setLdapProviderURL

public void setLdapProviderURL(String string)

Url to context to search in, e.g. 'ldaps://DOMAIN.EXT'.

setHost

public void setHost(String string)

Host part of ldapProviderUrl. Only used when ldapProviderUrl not specified

setPort

public void setPort(int i)

Port of ldapProviderUrl. Only used when ldapProviderUrl not specified

setUseSsl

public void setUseSsl(boolean b)

Indication to use ldap or ldaps in ldapProviderUrl. Only used when ldapProviderUrl not specified

Default value

false

setBaseDN

public void setBaseDN(String baseDN)

BaseDN, e.g. CN=USERS,DC=DOMAIN,DC=EXT

Default value

false

setAuthAlias

public void setAuthAlias(String string)

Alias used to obtain credentials to connect to ldap server

setUsername

public void setUsername(String string)

Username used to obtain credentials to connect to ldap server

setPassword

public void setPassword(String string)

Password used to obtain credentials to connect to ldap server

setNotFoundForwardName

public void setNotFoundForwardName(String string)

setExceptionForwardName

public void setExceptionForwardName(String string)

PipeForward used when an exception is caught

getLdapProviderURL

public String getLdapProviderURL()

getHost

public String getHost()

getPort

public int getPort()

isUseSsl

public boolean isUseSsl()

getBaseDN

public String getBaseDN()

getAuthAlias

public String getAuthAlias()

getUsername

public String getUsername()

getPassword

public String getPassword()

getNotFoundForwardName

public String getNotFoundForwardName()

getExceptionForwardName

public String getExceptionForwardName()