Package cz.metacentrum.perun.core.impl

Class ExtSourceSql

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

cz.metacentrum.perun.core.impl.ExtSourceSql

All Implemented Interfaces:

ExtSourceSimpleApi, Serializable, Comparable<PerunBean>

Direct Known Subclasses:

ExtSourceSqlComplex

public class ExtSourceSql
extends ExtSourceImpl
implements ExtSourceSimpleApi

Author:

Michal Prochazka michalp@ics.muni.cz

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DBPOOL
static final String	URL
static final String	USER

Fields inherited from class cz.metacentrum.perun.core.impl.ExtSourceImpl

perunBl

Constructor Summary

Constructors

Constructor	Description
ExtSourceSql()

Method Summary

Modifier and Type	Method	Description
void	close()	If extSource needs to be closed, this method must be called.
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 DataSource	getDataSource()
List<Map<String,String>>	getGroupSubjects(Map<String,String> groupAttributes)	Get the list of the subjects in the external group.
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> groupAttributes)	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 List<Map<String,String>>	groupQuery(String query)	Get subject groups from an external source
protected List<Map<String,String>>	querySource(String query, String searchString, int maxResults)

Methods inherited from class cz.metacentrum.perun.core.impl.ExtSourceImpl

getAttributes

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

DBPOOL

public static final String DBPOOL

See Also:

• Constant Field Values

USER

public static final String USER

See Also:

• Constant Field Values

URL

public static final String URL

See Also:

• Constant Field Values

Constructor Details

ExtSourceSql

public ExtSourceSql()

Method Details

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

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

Parameters:

searchString -

maxResults - limit returned results

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)

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

Parameters:

searchString -

Returns:

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

getDataSource

protected DataSource getDataSource()

getGroupSubjects

public List<Map<String,String>> getGroupSubjects(Map<String,String> groupAttributes)
                                          throws InternalErrorException

Description copied from interface: ExtSourceSimpleApi

Get the list of the subjects in the external group.

Specified by:

getGroupSubjects in interface ExtSourceSimpleApi

Parameters:

groupAttributes - map of attributes used for quering the external source

Returns:

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

Throws:

InternalErrorException

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

getSubjectGroups

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

Description copied from interface: ExtSourceSimpleApi

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

Specified by:

getSubjectGroups in interface ExtSourceSimpleApi

Parameters:

groupAttributes - map of attributes used for quering the external source

Returns:

list of maps, which contains attr name and attr value

Throws:

InternalErrorException

ExtSourceUnsupportedOperationException

getUsersSubjects

public List<Map<String,String>> getUsersSubjects()
                                          throws InternalErrorException,
ExtSourceUnsupportedOperationException

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

Throws:

InternalErrorException

ExtSourceUnsupportedOperationException

groupQuery

protected List<Map<String,String>> groupQuery(String query)

Get subject groups from an external source

Parameters:

query - to select subject groups

Returns:

list of subjects

querySource

protected List<Map<String,String>> querySource(String query,
 String searchString,
 int maxResults)
                                        throws InternalErrorException

Throws:

InternalErrorException