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
@ConfigurationWarning("please use LdapSender with operation challenge and check for returned message <LdapResult>Success</LdapResult>")
public class LdapChallengePipe
extends FixedForwardPipe
Deprecated.
Pipe to check if a username and password are valid in LDAP.
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Deprecated.checks for correct configuration of forwarddoPipe
(Message msg, PipeLineSession pls) Deprecated.Checks to see if the supplied parameteres of the pipe can login to LDAPDeprecated.Deprecated.Deprecated.protected void
handleError
(LdapSender ldapSender, PipeLineSession session, int code, String message) Deprecated.void
setErrorSessionKey
(String string) Deprecated.key of session variable used to store cause of errorsvoid
Deprecated.class to use as initial context factoryvoid
setLdapProviderURL
(String string) Deprecated.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
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, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, registerForward, 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.
-
-
Method Details
-
configure
Deprecated.Description copied from class:FixedForwardPipe
checks for correct configuration of forward- Specified by:
configure
in interfaceIConfigurable
- Specified by:
configure
in interfaceIPipe
- Overrides:
configure
in classFixedForwardPipe
- Throws:
ConfigurationException
-
doPipe
Deprecated.Checks to see if the supplied parameteres of the pipe can login to LDAP- Throws:
PipeRunException
- See Also:
-
handleError
protected void handleError(LdapSender ldapSender, PipeLineSession session, int code, String message) Deprecated. -
setLdapProviderURL
Deprecated.url to the ldap server.
example: ldap://su05b9.itc.intranet -
getLdapProviderURL
Deprecated. -
setInitialContextFactoryName
Deprecated.class to use as initial context factory- Default value
- com.sun.jndi.ldap.ldapctxfactory
-
getInitialContextFactoryName
Deprecated. -
setErrorSessionKey
Deprecated.key of session variable used to store cause of errors -
getErrorSessionKey
Deprecated.
-