Package cz.metacentrum.perun.core.implApi

Interface ExtSourceApi

All Superinterfaces:

ExtSourceSimpleApi

All Known Implementing Classes:

ExtSourceCSV, ExtSourceEGISSO, ExtSourceGoogle, ExtSourceINET, ExtSourceISXML, ExtSourceJSON, ExtSourceLdap, ExtSourcePerun, ExtSourceREMS, ExtSourceSqlComplex, ExtSourceTCS, ExtSourceUnity, ExtSourceXML

public interface ExtSourceApi
extends ExtSourceSimpleApi

Definition of extSource api.

This extSource can get information about all subjects with all attributes by one query.

Author:

Michal Stava stavamichal@gmail.com

Method Summary

Modifier and Type	Method	Description
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

Methods inherited from interface cz.metacentrum.perun.core.implApi.ExtSourceSimpleApi

close, findSubjectsLogins, findSubjectsLogins, getGroupSubjects, getSubjectByLogin, getSubjectGroups, getUsersSubjects

Method Details

findSubjects

List<Map<String,String>> findSubjects(String searchString)
                               throws ExtSourceUnsupportedOperationException

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.

Parameters:

searchString -

Returns:

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

Throws:

InternalErrorException

ExtSourceUnsupportedOperationException

findSubjects

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

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.

Parameters:

searchString -

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

Returns:

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

Throws:

InternalErrorException

ExtSourceUnsupportedOperationException