Package cz.metacentrum.perun.core.bl

Interface ExtSourcesManagerBl

All Known Implementing Classes:

ExtSourcesManagerBlImpl

public interface ExtSourcesManagerBl

Author:

Michal Prochazka <michalp@ics.muni.cz>

Method Summary

Modifier and Type	Method	Description
void	addExtSource(PerunSession perunSession, Group group, ExtSource source)	Associate external source definition with the GROUP.
void	addExtSource(PerunSession perunSession, Vo vo, ExtSource source)	Associate external source definition with the VO.
void	addExtSources(PerunSession perunSession, Group group, List<ExtSource> sources)	Associate external source definitions with the GROUP.
void	addExtSources(PerunSession perunSession, Vo vo, List<ExtSource> sources)	Associate external source definitions with the VO.
void	checkExtSourceAssignedToVo(PerunSession sess, ExtSource extSource, int voId)	Check if extSource is assigned to vo or not.
void	checkExtSourceExists(PerunSession sess, ExtSource extSource)
ExtSource	checkOrCreateExtSource(PerunSession perunSession, String extSourceName, String extSourceType)	Checks whether the ExtSource exists, if not, then the ExtSource is created.
ExtSource	createExtSource(PerunSession perunSession, ExtSource extSource, Map<String,String> attributes)	Creates an external source.
void	deleteExtSource(PerunSession perunSession, ExtSource extSource)	Deletes an external source.
void	destroy()	Destroy manager.
CandidateGroup	generateCandidateGroup(PerunSession perunSession, Map<String,String> groupSubjectData, ExtSource source, String loginPrefix)	Generate a candidate group from a group subject data.
List<CandidateGroup>	generateCandidateGroups(PerunSession perunSession, List<Map<String,String>> groupSubjectsData, ExtSource source, String loginPrefix)	Generate candidate groups from a group subject data.
Map<String,String>	getAttributes(ExtSource extSource)	Gets attributes for external source.
CandidateSync	getCandidate(PerunSession perunSession, ExtSource source, String login)	Get the candidate from the ExtSource.
CandidateSync	getCandidate(PerunSession perunSession, Map<String,String> subjectData, ExtSource source, String login)	Get the candidate from subjectData where at least login must exists.
DataSource	getDataSource(String poolName)	Returns a database connection pool.
ExtSource	getExtSourceById(PerunSession perunSession, int id)	Searches for the external source with specified id.
ExtSource	getExtSourceByName(PerunSession perunSession, String name)	Searches for the external source using specified name.
List<ExtSource>	getExtSources(PerunSession perunSession)	Get list of all external sources.
List<ExtSource>	getGroupExtSources(PerunSession perunSession, Group group)	Get list of external sources associated with the GROUP.
List<User>	getInvalidUsers(PerunSession perunSession, ExtSource source)	Returns list of users stored by this ExtSource, which are not valid.
List<ExtSource>	getVoExtSources(PerunSession perunSession, Vo vo)	Get list of external sources associated with the VO.
void	initialize(PerunSession sess)	Initialize manager.
void	loadExtSourcesDefinitions(PerunSession sess)	Loads ext source definitions from the configuration file and updates entries stored in the DB.
void	removeExtSource(PerunSession perunSession, Group group, ExtSource source)	Remove association of the external source from the GROUP.
void	removeExtSource(PerunSession perunSession, Vo vo, ExtSource source)	Remove association of the external source from the VO.
void	removeExtSources(PerunSession perunSession, Group group, List<ExtSource> sources)	Remove associations of external sources from the GROUP.
void	removeExtSources(PerunSession perunSession, Vo vo, List<ExtSource> sources)	Remove associations of external sources from the VO.

Method Details

addExtSource

void addExtSource(PerunSession perunSession,
 Vo vo,
 ExtSource source)
           throws ExtSourceAlreadyAssignedException

Associate external source definition with the VO.

Parameters:

perunSession -

vo -

source -

Throws:

InternalErrorException

ExtSourceAlreadyAssignedException

addExtSource

void addExtSource(PerunSession perunSession,
 Group group,
 ExtSource source)
           throws ExtSourceAlreadyAssignedException

Associate external source definition with the GROUP.

Parameters:

perunSession -

group -

source -

Throws:

InternalErrorException

ExtSourceAlreadyAssignedException

addExtSources

void addExtSources(PerunSession perunSession,
 Vo vo,
 List<ExtSource> sources)
            throws ExtSourceAlreadyAssignedException

Associate external source definitions with the VO.

Parameters:

perunSession - sess

vo - vo

sources - list of sources to associate

Throws:

ExtSourceAlreadyAssignedException

addExtSources

void addExtSources(PerunSession perunSession,
 Group group,
 List<ExtSource> sources)
            throws ExtSourceAlreadyAssignedException

Associate external source definitions with the GROUP.

Parameters:

perunSession - sess

group - group

sources - list of sources to associate

Throws:

ExtSourceAlreadyAssignedException

checkExtSourceAssignedToVo

void checkExtSourceAssignedToVo(PerunSession sess,
 ExtSource extSource,
 int voId)
                         throws ExtSourceNotAssignedException,
VoNotExistsException

Check if extSource is assigned to vo or not. Throw exception if not.

Parameters:

sess -

extSource -

voId -

Throws:

InternalErrorException

ExtSourceNotAssignedException

VoNotExistsException

checkExtSourceExists

void checkExtSourceExists(PerunSession sess,
 ExtSource extSource)
                   throws ExtSourceNotExistsException

Throws:

ExtSourceNotExistsException

checkOrCreateExtSource

ExtSource checkOrCreateExtSource(PerunSession perunSession,
 String extSourceName,
 String extSourceType)

Checks whether the ExtSource exists, if not, then the ExtSource is created.

Parameters:

perunSession -

extSourceName -

extSourceType -

Returns:

existing or newly created extSource is returned

Throws:

InternalErrorException

createExtSource

ExtSource createExtSource(PerunSession perunSession,
 ExtSource extSource,
 Map<String,String> attributes)
                   throws ExtSourceExistsException

Creates an external source.

Parameters:

perunSession -

extSource -

attributes -

Returns:

ExtSource object with newly associated ID.

Throws:

InternalErrorException

ExtSourceExistsException

deleteExtSource

void deleteExtSource(PerunSession perunSession,
 ExtSource extSource)
              throws ExtSourceAlreadyRemovedException

Deletes an external source.

Parameters:

perunSession -

extSource -

Throws:

InternalErrorException

ExtSourceAlreadyRemovedException - if there are 0 rows affected by delete in DB

destroy

void destroy()

Destroy manager. Clean resources.

generateCandidateGroup

CandidateGroup generateCandidateGroup(PerunSession perunSession,
 Map<String,String> groupSubjectData,
 ExtSource source,
 String loginPrefix)

Generate a candidate group from a group subject data.

IMPORTANT: expected, that these subjectData was get from the ExtSource before using.

Parameters:

perunSession -

groupSubjectData -

source -

loginPrefix - login prefix to change group login and parent group login by it

Returns:

Candidate group object

Throws:

InternalErrorException

generateCandidateGroups

List<CandidateGroup> generateCandidateGroups(PerunSession perunSession,
 List<Map<String,String>> groupSubjectsData,
 ExtSource source,
 String loginPrefix)

Generate candidate groups from a group subject data.

IMPORTANT: expected, that these subjectData was get from the ExtSource before using.

Parameters:

perunSession -

groupSubjectsData -

source -

loginPrefix - login prefix to change group login and parent group login by it

Returns:

Candidate group objects

Throws:

InternalErrorException

getAttributes

Map<String,String> getAttributes(ExtSource extSource)

Gets attributes for external source.

Parameters:

extSource - External Source

Returns:

Map of attributes for external source

Throws:

InternalErrorException

getCandidate

CandidateSync getCandidate(PerunSession perunSession,
 ExtSource source,
 String login)
                    throws CandidateNotExistsException,
ExtSourceUnsupportedOperationException

Get the candidate from the ExtSource. Login of the candidate will be used to gain data from the ExtSource.

Parameters:

perunSession - Perun session

source - External source which will be used to get data about the candidate

login - Login of the candidate

Returns:

a Candidate object

Throws:

InternalErrorException

CandidateNotExistsException

ExtSourceUnsupportedOperationException

getCandidate

CandidateSync getCandidate(PerunSession perunSession,
 Map<String,String> subjectData,
 ExtSource source,
 String login)

Get the candidate from subjectData where at least login must exists.

IMPORTANT: expected, that these subjectData was get from the ExtSource before using.

Parameters:

perunSession - Perun session

subjectData -

source - External source which will be used to get data about the candidate

login - Login of the candidate

Returns:

a Candidate object

Throws:

InternalErrorException

getDataSource

DataSource getDataSource(String poolName)

Returns a database connection pool.

Parameters:

poolName - named defined in perun-extSources.xml

Returns:

database connection pool

getExtSourceById

ExtSource getExtSourceById(PerunSession perunSession,
 int id)
                    throws ExtSourceNotExistsException

Searches for the external source with specified id.

Parameters:

perunSession -

id -

Returns:

External source with specified id

Throws:

InternalErrorException

ExtSourceNotExistsException

getExtSourceByName

ExtSource getExtSourceByName(PerunSession perunSession,
 String name)
                      throws ExtSourceNotExistsException

Searches for the external source using specified name.

Parameters:

perunSession -

name -

Returns:

External source with specified name

Throws:

InternalErrorException

ExtSourceNotExistsException

getExtSources

List<ExtSource> getExtSources(PerunSession perunSession)

Get list of all external sources.

Parameters:

perunSession -

Returns:

list of external source

Throws:

InternalErrorException

getGroupExtSources

List<ExtSource> getGroupExtSources(PerunSession perunSession,
 Group group)

Get list of external sources associated with the GROUP.

Parameters:

perunSession -

group -

Returns:

list of external sources associated with the VO

Throws:

InternalErrorException

getInvalidUsers

List<User> getInvalidUsers(PerunSession perunSession,
 ExtSource source)

Returns list of users stored by this ExtSource, which are not valid.

Parameters:

perunSession -

source -

Returns:

list of users, who is not in the extSource anymore

Throws:

InternalErrorException

getVoExtSources

List<ExtSource> getVoExtSources(PerunSession perunSession,
 Vo vo)

Get list of external sources associated with the VO.

Parameters:

perunSession -

vo -

Returns:

list of external sources associated with the VO

Throws:

InternalErrorException

initialize

void initialize(PerunSession sess)

Initialize manager.

loadExtSourcesDefinitions

void loadExtSourcesDefinitions(PerunSession sess)

Loads ext source definitions from the configuration file and updates entries stored in the DB.

Parameters:

sess -

removeExtSource

void removeExtSource(PerunSession perunSession,
 Vo vo,
 ExtSource source)
              throws ExtSourceNotAssignedException,
ExtSourceAlreadyRemovedException

Remove association of the external source from the VO.

Parameters:

perunSession -

vo -

source -

Throws:

InternalErrorException

ExtSourceNotAssignedException

ExtSourceAlreadyRemovedException - if there are 0 rows affected by delete from DB

removeExtSource

void removeExtSource(PerunSession perunSession,
 Group group,
 ExtSource source)
              throws ExtSourceNotAssignedException,
ExtSourceAlreadyRemovedException

Remove association of the external source from the GROUP.

Parameters:

perunSession -

group -

source -

Throws:

InternalErrorException

ExtSourceAlreadyRemovedException - when 0 rows affected by removing from DB

ExtSourceNotAssignedException

removeExtSources

void removeExtSources(PerunSession perunSession,
 Vo vo,
 List<ExtSource> sources)
               throws ExtSourceNotAssignedException,
ExtSourceAlreadyRemovedException

Remove associations of external sources from the VO.

Parameters:

perunSession -

vo -

sources -

Throws:

InternalErrorException

ExtSourceAlreadyRemovedException - when 0 rows affected by removing from DB

ExtSourceNotAssignedException

removeExtSources

void removeExtSources(PerunSession perunSession,
 Group group,
 List<ExtSource> sources)
               throws ExtSourceNotAssignedException,
ExtSourceAlreadyRemovedException

Remove associations of external sources from the GROUP.

Parameters:

perunSession -

group -

sources -

Throws:

InternalErrorException

ExtSourceAlreadyRemovedException - when 0 rows affected by removing from DB

ExtSourceNotAssignedException