Package cz.metacentrum.perun.core.impl

Class ExtSourceLdap

java.lang.Object

cz.metacentrum.perun.core.api.PerunBean

cz.metacentrum.perun.core.api.Auditable

cz.metacentrum.perun.core.api.ExtSource

cz.metacentrum.perun.core.impl.ExtSourceLdap

All Implemented Interfaces:

ExtSourceApi, ExtSourceSimpleApi, Serializable, Comparable<PerunBean>

Direct Known Subclasses:

ExtSourceEGISSO

public class ExtSourceLdap
extends ExtSource
implements ExtSourceApi

Ext source implementation for LDAP.

Author:

Michal Prochazka michalp@ics.muni.cz, Pavel Zlámal <zlamal@cesnet.cz>

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DirContext	dirContext
protected String	filteredQuery
protected static final org.slf4j.Logger	log
protected Map<String,String>	mapping

Constructor Summary

Constructors

Constructor	Description
ExtSourceLdap()

Method Summary

Modifier and Type	Method	Description
void	close()	If extSource needs to be closed, this method must be called.
List<Map<String,String>>	findSubjects(String searchString)	Finds all subjects with attributes in the external source, that contains searchString.
List<Map<String,String>>	findSubjects(String searchString, int maxResults)	Finds all subjects with attributes in the external source, that contains searchString limited by the maxResults This method is used for getting all logins of subjects in external source with all possible attributes.
List<Map<String,String>>	findSubjectsLogins(String searchString)	Finds all subjects logins in the external source, that contains searchString.
List<Map<String,String>>	findSubjectsLogins(String searchString, int maxResults)	Finds all subjects logins in the external source, that contains searchString, limited by the maxResults.
protected Map<String,String>	getAttributes()
protected DirContext	getContext()
List<Map<String,String>>	getGroupSubjects(Map<String,String> attributes)	Get the list of the subjects in the external group.
protected String	getLdapAttributeValue(Attributes attributes, String ldapAttrNameRaw)
protected Map<String,String>	getSubjectAttributes(Attributes attributes)
Map<String,String>	getSubjectByLogin(String login)	Finds subject from the external source by the primary login used in external source.
List<Map<String,String>>	getSubjectGroups(Map<String,String> attributes)	Get the list of the subject groups in the external source.
List<Map<String,String>>	getUsersSubjects()	Get the list of subjects from the external source.
protected void	initContext()
protected List<Map<String,String>>	querySource(String query, String base, int maxResults)	Query LDAP using query in defined base.
static PerunBlImpl	setPerunBlImpl(PerunBlImpl perun)

Methods inherited from class cz.metacentrum.perun.core.api.ExtSource

compareTo, equals, getBeanName, getName, getType, hashCode, serializeToString, setName, setType, toString

Methods inherited from class cz.metacentrum.perun.core.api.Auditable

getCreatedAt, getCreatedBy, getCreatedByUid, getModifiedAt, getModifiedBy, getModifiedByUid, setCreatedAt, setCreatedBy, setCreatedByUid, setModifiedAt, setModifiedBy, setModifiedByUid

Methods inherited from class cz.metacentrum.perun.core.api.PerunBean

getId, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

mapping

protected Map<String,String> mapping

log

protected static final org.slf4j.Logger log

dirContext

protected DirContext dirContext

filteredQuery

protected String filteredQuery

Constructor Details

ExtSourceLdap

public ExtSourceLdap()

Method Details

getContext

protected DirContext getContext()

setPerunBlImpl

public static PerunBlImpl setPerunBlImpl(PerunBlImpl perun)

findSubjectsLogins

public List<Map<String,String>> findSubjectsLogins(String searchString)

Description copied from interface: ExtSourceSimpleApi

Finds all subjects logins in the external source, that contains searchString. This method is used for getting all logins of subjects in external source and then use them to searching in external source for other subjects attributes.

Specified by:

findSubjectsLogins in interface ExtSourceSimpleApi

Returns:

list of maps, which contains attr_name->attr_value but only for login definition eg. login;MichalS

findSubjectsLogins

public List<Map<String,String>> findSubjectsLogins(String searchString,
 int maxResults)

Description copied from interface: ExtSourceSimpleApi

Finds all subjects logins in the external source, that contains searchString, limited by the maxResults. This method is used for getting all logins of subjects in external source and then use them to searching in external source for other subjects attributes

Specified by:

findSubjectsLogins in interface ExtSourceSimpleApi

maxResults - limit returned results

Returns:

list of maps, which contains attr_name->attr_value but only for login definition eg. login;MichalS

getSubjectByLogin

public Map<String,String> getSubjectByLogin(String login)
                                     throws SubjectNotExistsException

Description copied from interface: ExtSourceSimpleApi

Finds subject from the external source by the primary login used in external source.

Specified by:

getSubjectByLogin in interface ExtSourceSimpleApi

Parameters:

login - login used in the external source

Returns:

map which contains attr_name -> attr_value, e.g. firstName->Michal

Throws:

SubjectNotExistsException - if the subject cannot be found

getGroupSubjects

public List<Map<String,String>> getGroupSubjects(Map<String,String> attributes)

Description copied from interface: ExtSourceSimpleApi

Get the list of the subjects in the external group.

Specified by:

getGroupSubjects in interface ExtSourceSimpleApi

Parameters:

attributes - map of attributes used for quering the external source

Returns:

list of maps, which contains attr_name->attr_value, e.g. firstName->Michal

getUsersSubjects

public List<Map<String,String>> getUsersSubjects()

Description copied from interface: ExtSourceSimpleApi

Get the list of subjects from the external source.

Specified by:

getUsersSubjects in interface ExtSourceSimpleApi

Returns:

list of maps, which contains attr_name->attr_value, e.g. firstName->Michal

initContext

protected void initContext()

getSubjectAttributes

protected Map<String,String> getSubjectAttributes(Attributes attributes)

getLdapAttributeValue

protected String getLdapAttributeValue(Attributes attributes,
 String ldapAttrNameRaw)

querySource

protected List<Map<String,String>> querySource(String query,
 String base,
 int maxResults)

Query LDAP using query in defined base. Results can be limited to the maxResults.

Parameters:

query -

base -

maxResults -

Returns:

List of Map of the LDAP attribute names and theirs values

Throws:

InternalErrorException

close

public void close()

Description copied from interface: ExtSourceSimpleApi

If extSource needs to be closed, this method must be called.

Specified by:

close in interface ExtSourceSimpleApi

getSubjectGroups

public List<Map<String,String>> getSubjectGroups(Map<String,String> attributes)
                                          throws ExtSourceUnsupportedOperationException

Description copied from interface: ExtSourceSimpleApi

Get the list of the subject groups in the external source.

Specified by:

getSubjectGroups in interface ExtSourceSimpleApi

Parameters:

attributes - map of attributes used for quering the external source

Returns:

list of maps, which contains attr name and attr value

Throws:

ExtSourceUnsupportedOperationException

findSubjects

public List<Map<String,String>> findSubjects(String searchString)

Description copied from interface: ExtSourceApi

Finds all subjects with attributes in the external source, that contains searchString. This method is used for getting all logins of subjects in external source with all possible attributes.

Specified by:

findSubjects in interface ExtSourceApi

Returns:

list of maps, which contains attr_name->attr_value (for all extSource attributes)

findSubjects

public List<Map<String,String>> findSubjects(String searchString,
 int maxResults)

Description copied from interface: ExtSourceApi

Finds all subjects with attributes in the external source, that contains searchString limited by the maxResults This method is used for getting all logins of subjects in external source with all possible attributes.

Specified by:

findSubjects in interface ExtSourceApi

maxResults - define max number of returned results, 0 means unlimited

Returns:

list of maps, which contains attr_name->attr_value (for all extSource attributes)

getAttributes

protected Map<String,String> getAttributes()