nl.nn.adapterframework.ldap

Class LdapQueryPipeBase

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.ldap.LdapQueryPipeBase

All Implemented Interfaces:

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

Direct Known Subclasses:

LdapFindGroupMembershipsPipe, LdapFindMemberPipe

public abstract class LdapQueryPipeBase
extends FixedForwardPipe

Base pipe for querying LDAP.

Author:

Gerrit van Brakel

Field Summary

Fields

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

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
LdapQueryPipeBase()

Method Summary

Modifier and Type	Method and 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	getBaseDN()
String	getExceptionForwardName()
String	getHost()
String	getLdapProviderURL()
String	getNotFoundForwardName()
int	getPort()
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	setUserName(String username) Deprecated.
void	setUseSsl(boolean b) Indication to use ldap or ldaps in ldapProviderUrl.

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

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

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

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

Methods inherited from class nl.nn.adapterframework.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 nl.nn.adapterframework.core.IExtendedPipe

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

Methods inherited from interface nl.nn.adapterframework.core.IPipe

getMaxThreads

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface nl.nn.adapterframework.core.IForwardTarget

getName

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Field Detail

cf

protected CredentialFactory cf

notFoundForward

protected PipeForward notFoundForward

exceptionForward

protected PipeForward exceptionForward

Constructor Detail

LdapQueryPipeBase

public LdapQueryPipeBase()

Method Detail

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'.

getLdapProviderURL

public String getLdapProviderURL()

setHost

public void setHost(String string)

Host part of ldapProviderUrl. Only used when ldapProviderUrl not specified

getHost

public String getHost()

setPort

public void setPort(int i)

Port of ldapProviderUrl. Only used when ldapProviderUrl not specified

getPort

public int getPort()

setUseSsl

public void setUseSsl(boolean b)

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

Default value

false

isUseSsl

public boolean isUseSsl()

setBaseDN

public void setBaseDN(String baseDN)

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

Default value

false

getBaseDN

public String getBaseDN()

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

setUserName

@Deprecated
 @ConfigurationWarning(value="Please use attribute username instead")
public void setUserName(String username)

Deprecated.

setPassword

public void setPassword(String string)

Password used to obtain credentials to connect to ldap server

setNotFoundForwardName

public void setNotFoundForwardName(String string)

getNotFoundForwardName

public String getNotFoundForwardName()

setExceptionForwardName

public void setExceptionForwardName(String string)

PipeForward used when an exception is caught

getExceptionForwardName

public String getExceptionForwardName()