Package org.frankframework.ldap

Class LdapFindGroupMembershipsPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.ldap.AbstractLdapQueryPipe

org.frankframework.ldap.LdapFindGroupMembershipsPipe

All Implemented Interfaces:

ICacheEnabled<String,Set<String>>, 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 LdapFindGroupMembershipsPipe
extends AbstractLdapQueryPipe
implements ICacheEnabled<String,Set<String>>

Pipe that returns the memberships of a userDN. The input is a fullDn, of a user or a group.

Sample result:

 <ldap>
     <entry name="CN=xxyyzz,OU=Users,DC=domain,DC=ext">
         <attributes>
             <attribute>
             <attribute name="memberOf" value="Extern"/>
             <attribute name="departmentCode" value="358000"/>
             <attribute name="organizationalHierarchy">
                 <item value="ou=zzyyxx"/>
                 <item value="ou=OPS&IT,ou=Group,ou=domain,o=ext"/>
             </attribute>
             <attribute name="givenName" value="Gerrit">
         </attributes>
     </entry>
     <entry> .... </entry>
 </ldap>
 

Author:

Gerrit van Brakel

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
LdapFindGroupMembershipsPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
PipeRunResult	doPipeWithException(Message message, PipeLineSession session)
ICache<String,Set<String>>	getCache()
Set<String>	searchObjectForMultiValuedAttribute(String searchedDN)
Set<String>	searchRecursivelyViaAttributes(String searchedDN)
void	setCache(ICache<String,Set<String>> cache)	optional cache definition
void	setRecursiveSearch(boolean b)	when true, the memberOf attribute is also searched in all the found members
void	start()	Perform necessary action to start the pipe.
void	stop()	Perform necessary actions to stop the Pipe. For instance, closing JMS connections, DBMS connections etc.

Methods inherited from class org.frankframework.ldap.AbstractLdapQueryPipe

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

LdapFindGroupMembershipsPipe

public LdapFindGroupMembershipsPipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

Checks for correct configuration of forward.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractLdapQueryPipe

Throws:

ConfigurationException - in case it was not able to configure the component.

start

public void start()

Description copied from interface: IPipe

Perform necessary action to start the pipe. This method is executed after the IConfigurable.configure() method, for each start and stop command of the adapter.

Specified by:

start in interface IPipe

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class AbstractPipe

stop

public void stop()

Description copied from interface: IPipe

Perform necessary actions to stop the Pipe.
For instance, closing JMS connections, DBMS connections etc.

Specified by:

stop in interface IPipe

Specified by:

stop in interface org.springframework.context.Lifecycle

Overrides:

stop in class AbstractPipe

doPipeWithException

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

Specified by:

doPipeWithException in class AbstractLdapQueryPipe

Throws:

PipeRunException

searchRecursivelyViaAttributes

public Set<String> searchRecursivelyViaAttributes(String searchedDN)
                                           throws NamingException

Throws:

NamingException

searchObjectForMultiValuedAttribute

public Set<String> searchObjectForMultiValuedAttribute(String searchedDN)
                                                throws NamingException

Throws:

NamingException

setCache

public void setCache(ICache<String,Set<String>> cache)

Description copied from interface: ICacheEnabled

optional cache definition

Specified by:

setCache in interface ICacheEnabled<String,Set<String>>

getCache

public ICache<String,Set<String>> getCache()

Specified by:

getCache in interface ICacheEnabled<String,Set<String>>

setRecursiveSearch

public void setRecursiveSearch(boolean b)

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

Default value

true