public abstract class LdapQueryPipeBase extends FixedForwardPipe
Modifier and Type | Field and Description |
---|---|
protected CredentialFactory |
cf |
protected PipeForward |
exceptionForward |
protected PipeForward |
notFoundForward |
parameterNamesMustBeUnique
log
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
Constructor and Description |
---|
LdapQueryPipeBase() |
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.
|
getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe
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
configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent
getMaxThreads
getName
getApplicationContext, getName
getConfigurationClassLoader
getName
getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute
protected CredentialFactory cf
protected PipeForward notFoundForward
protected PipeForward exceptionForward
public void configure() throws ConfigurationException
FixedForwardPipe
configure
in interface IConfigurable
configure
in interface IPipe
configure
in class FixedForwardPipe
ConfigurationException
public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
IPipe
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.PipeRunException
public abstract PipeRunResult doPipeWithException(Message message, PipeLineSession session) throws PipeRunException
PipeRunException
public void setLdapProviderURL(String string)
public String getLdapProviderURL()
public void setHost(String string)
public String getHost()
public void setPort(int i)
public int getPort()
public void setUseSsl(boolean b)
public boolean isUseSsl()
public void setBaseDN(String baseDN)
public String getBaseDN()
public void setAuthAlias(String string)
public void setUsername(String string)
@Deprecated @ConfigurationWarning(value="Please use attribute username instead") public void setUserName(String username)
public void setPassword(String string)
public void setNotFoundForwardName(String string)
public String getNotFoundForwardName()
public void setExceptionForwardName(String string)
public String getExceptionForwardName()
Copyright © 2023 Frank!Framework. All rights reserved.