Package org.frankframework.ldap

Class LdapFindMemberPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.ldap.AbstractLdapQueryPipe

org.frankframework.ldap.LdapFindMemberPipe

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

public class LdapFindMemberPipe
extends AbstractLdapQueryPipe

Pipe that checks if a specified dn exists as 'member' in another specified dn in LDAP.

Author:

Peter Leeuwenburgh

Field Summary

Fields inherited from class org.frankframework.ldap.AbstractLdapQueryPipe

cf, exceptionForward, 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
LdapFindMemberPipe()

Method Summary

Modifier and Type	Method	Description
PipeRunResult	doPipeWithException(Message message, PipeLineSession session)
protected boolean	findMember(String host, int port, String dnSearchIn, boolean useSsl, String dnFind, boolean recursiveSearch)
String	getDnFind()
String	getDnSearchIn()
boolean	isRecursiveSearch()
void	setDnFind(String string)	The dn of the member to search for when the parameter dnFind is not set
void	setDnSearchIn(String string)	The dn of the group to search in when the parameter dnSearchIn is not set
void	setRecursiveSearch(boolean b)	when true, the member attribute is also searched in all the found members

Methods inherited from class org.frankframework.ldap.AbstractLdapQueryPipe

configure, doPipe, retrieveUrl, setAuthAlias, setBaseDN, setExceptionForwardName, setHost, setLdapProviderURL, setNotFoundForwardName, setPassword, setPort, setUsername, setUseSsl

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, 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.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent

Constructor Details

LdapFindMemberPipe

public LdapFindMemberPipe()

Method Details

doPipeWithException

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

Specified by:

doPipeWithException in class AbstractLdapQueryPipe

Throws:

PipeRunException

findMember

protected boolean findMember(String host,
 int port,
 String dnSearchIn,
 boolean useSsl,
 String dnFind,
 boolean recursiveSearch)
                      throws NamingException

Throws:

NamingException

setDnSearchIn

public void setDnSearchIn(String string)

The dn of the group to search in when the parameter dnSearchIn is not set

getDnSearchIn

public String getDnSearchIn()

setDnFind

public void setDnFind(String string)

The dn of the member to search for when the parameter dnFind is not set

getDnFind

public String getDnFind()

setRecursiveSearch

public void setRecursiveSearch(boolean b)

when true, the member attribute is also searched in all the found members

Default value

true

isRecursiveSearch

public boolean isRecursiveSearch()