Package org.frankframework.ldap

Class LdapChallengePipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.ldap.LdapChallengePipe

All Implemented Interfaces:

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

@Deprecated(forRemoval=true,
            since="7.6.0")
@ConfigurationWarning("please use LdapSender with operation challenge and check for returned message <LdapResult>Success</LdapResult>")
public class LdapChallengePipe
extends FixedForwardPipe

Deprecated, for removal: This API element is subject to removal in a future version.

Pipe to check if a username and password are valid in LDAP.

Parameters:

name	type	remarks
ldapProviderURL	URL to the LDAP server. Example: ldap://su05b9.itc.intranet	Required only if attribute ldapProviderURL is not set
principal	The LDAP DN for the username. Example: UID=SRP,OU=DI-IUF-EP,OU=SERVICES,O=ING	Required and must be filled
credentials	The LDAP password. Example: welkom01	Required and must be filled

Exits:

state	condition	remarks
success	Successful login to LDAP	should be defined in configuration
invalid	Unsuccessful login to LDAP	should be defined in configuration

Author:

Milan Tomc

Field Summary

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
LdapChallengePipe()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	configure()	Deprecated, for removal: This API element is subject to removal in a future version. checks for correct configuration of forward
PipeRunResult	doPipe(Message msg, PipeLineSession pls)	Deprecated, for removal: This API element is subject to removal in a future version. Checks to see if the supplied parameteres of the pipe can login to LDAP
String	getErrorSessionKey()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getInitialContextFactoryName()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getLdapProviderURL()	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	handleError(LdapSender ldapSender, PipeLineSession session, int code, String message)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setErrorSessionKey(String string)	Deprecated, for removal: This API element is subject to removal in a future version. key of session variable used to store cause of errors
void	setInitialContextFactoryName(String value)	Deprecated, for removal: This API element is subject to removal in a future version. class to use as initial context factory
void	setLdapProviderURL(String string)	Deprecated, for removal: This API element is subject to removal in a future version. url to the ldap server.

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

Constructor Details

LdapChallengePipe

public LdapChallengePipe()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

configure

public void configure()
               throws ConfigurationException

Deprecated, for removal: This API element is subject to removal in a future version.

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 msg,
 PipeLineSession pls)
                     throws PipeRunException

Deprecated, for removal: This API element is subject to removal in a future version.

Checks to see if the supplied parameteres of the pipe can login to LDAP

Throws:

PipeRunException

See Also:

• IPipe.doPipe(Message, PipeLineSession)

handleError

protected void handleError(LdapSender ldapSender,
 PipeLineSession session,
 int code,
 String message)

Deprecated, for removal: This API element is subject to removal in a future version.

setLdapProviderURL

public void setLdapProviderURL(String string)

Deprecated, for removal: This API element is subject to removal in a future version.

url to the ldap server.
example: ldap://su05b9.itc.intranet

getLdapProviderURL

public String getLdapProviderURL()

Deprecated, for removal: This API element is subject to removal in a future version.

setInitialContextFactoryName

public void setInitialContextFactoryName(String value)

Deprecated, for removal: This API element is subject to removal in a future version.

class to use as initial context factory

Default value

com.sun.jndi.ldap.ldapctxfactory

getInitialContextFactoryName

public String getInitialContextFactoryName()

Deprecated, for removal: This API element is subject to removal in a future version.

setErrorSessionKey

public void setErrorSessionKey(String string)

Deprecated, for removal: This API element is subject to removal in a future version.

key of session variable used to store cause of errors

getErrorSessionKey

public String getErrorSessionKey()

Deprecated, for removal: This API element is subject to removal in a future version.