Package cz.metacentrum.perun.core.blImpl

Class ExtSourcesManagerBlImpl

java.lang.Object

cz.metacentrum.perun.core.blImpl.ExtSourcesManagerBlImpl

All Implemented Interfaces:

ExtSourcesManagerBl

public class ExtSourcesManagerBlImpl
extends Object
implements ExtSourcesManagerBl

Constructor Summary

Constructors

Constructor	Description
ExtSourcesManagerBlImpl(ExtSourcesManagerImplApi extSourcesManagerImpl)

Method Summary

Modifier and Type	Method	Description
void	addExtSource(PerunSession sess, Group group, ExtSource source)	Associate external source definition with the GROUP.
void	addExtSource(PerunSession sess, 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 sess, String extSourceName, String extSourceType)	Checks whether the ExtSource exists, if not, then the ExtSource is created.
ExtSource	createExtSource(PerunSession sess, ExtSource extSource, Map<String,String> attributes)	Creates an external source.
void	deleteExtSource(PerunSession sess, 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>> subjectsData, 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 sess, 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 sess, int id)	Searches for the external source with specified id.
ExtSource	getExtSourceByName(PerunSession sess, String name)	Searches for the external source using specified name.
List<ExtSource>	getExtSources(PerunSession sess)	Get list of all external sources.
ExtSourcesManagerImplApi	getExtSourcesManagerImpl()	Gets the extSourcesManagerImpl for this instance.
List<ExtSource>	getGroupExtSources(PerunSession sess, Group group)	Get list of external sources associated with the GROUP.
List<User>	getInvalidUsers(PerunSession sess, ExtSource source)	Returns list of users stored by this ExtSource, which are not valid.
PerunBl	getPerunBl()
List<ExtSource>	getVoExtSources(PerunSession sess, 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 sess, Group group, ExtSource source)	Remove association of the external source from the GROUP.
void	removeExtSource(PerunSession sess, Vo vo, ExtSource source)	Remove association of the external source from the VO.
void	removeExtSources(PerunSession sess, Group group, List<ExtSource> sources)	Remove associations of external sources from the GROUP.
void	removeExtSources(PerunSession sess, Vo vo, List<ExtSource> sources)	Remove associations of external sources from the VO.
void	setPerunBl(PerunBl perunBl)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExtSourcesManagerBlImpl

public ExtSourcesManagerBlImpl(ExtSourcesManagerImplApi extSourcesManagerImpl)

Method Details

addExtSource

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

Description copied from interface: ExtSourcesManagerBl

Associate external source definition with the VO.

Specified by:

addExtSource in interface ExtSourcesManagerBl

Parameters:

sess -

vo -

source -

Throws:

ExtSourceAlreadyAssignedException

addExtSource

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

Description copied from interface: ExtSourcesManagerBl

Associate external source definition with the GROUP.

Specified by:

addExtSource in interface ExtSourcesManagerBl

Parameters:

sess -

group -

source -

Throws:

ExtSourceAlreadyAssignedException

addExtSources

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

Description copied from interface: ExtSourcesManagerBl

Associate external source definitions with the VO.

Specified by:

addExtSources in interface ExtSourcesManagerBl

Parameters:

perunSession - sess

vo - vo

sources - list of sources to associate

Throws:

ExtSourceAlreadyAssignedException

addExtSources

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

Description copied from interface: ExtSourcesManagerBl

Associate external source definitions with the GROUP.

Specified by:

addExtSources in interface ExtSourcesManagerBl

Parameters:

perunSession - sess

group - group

sources - list of sources to associate

Throws:

ExtSourceAlreadyAssignedException

checkExtSourceAssignedToVo

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

Description copied from interface: ExtSourcesManagerBl

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

Specified by:

checkExtSourceAssignedToVo in interface ExtSourcesManagerBl

Parameters:

sess -

extSource -

voId -

Throws:

ExtSourceNotAssignedException

VoNotExistsException

checkExtSourceExists

public void checkExtSourceExists(PerunSession sess,
 ExtSource extSource)
                          throws InternalErrorException,
ExtSourceNotExistsException

Specified by:

checkExtSourceExists in interface ExtSourcesManagerBl

Throws:

InternalErrorException

ExtSourceNotExistsException

checkOrCreateExtSource

public ExtSource checkOrCreateExtSource(PerunSession sess,
 String extSourceName,
 String extSourceType)

Description copied from interface: ExtSourcesManagerBl

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

Specified by:

checkOrCreateExtSource in interface ExtSourcesManagerBl

Parameters:

sess -

extSourceName -

extSourceType -

Returns:

existing or newly created extSource is returned

createExtSource

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

Description copied from interface: ExtSourcesManagerBl

Creates an external source.

Specified by:

createExtSource in interface ExtSourcesManagerBl

Parameters:

sess -

extSource -

attributes -

Returns:

ExtSource object with newly associated ID.

Throws:

ExtSourceExistsException

deleteExtSource

public void deleteExtSource(PerunSession sess,
 ExtSource extSource)
                     throws ExtSourceAlreadyRemovedException

Description copied from interface: ExtSourcesManagerBl

Deletes an external source.

Specified by:

deleteExtSource in interface ExtSourcesManagerBl

Parameters:

sess -

extSource -

Throws:

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

destroy

public void destroy()

Description copied from interface: ExtSourcesManagerBl

Destroy manager. Clean resources.

Specified by:

destroy in interface ExtSourcesManagerBl

generateCandidateGroup

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

Description copied from interface: ExtSourcesManagerBl

Generate a candidate group from a group subject data.

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

Specified by:

generateCandidateGroup in interface ExtSourcesManagerBl

Parameters:

perunSession -

groupSubjectData -

source -

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

Returns:

Candidate group object

generateCandidateGroups

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

Description copied from interface: ExtSourcesManagerBl

Generate candidate groups from a group subject data.

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

Specified by:

generateCandidateGroups in interface ExtSourcesManagerBl

Parameters:

perunSession -

subjectsData -

source -

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

Returns:

Candidate group objects

getAttributes

public Map<String,String> getAttributes(ExtSource extSource)

Description copied from interface: ExtSourcesManagerBl

Gets attributes for external source.

Specified by:

getAttributes in interface ExtSourcesManagerBl

Parameters:

extSource - External Source

Returns:

Map of attributes for external source

getCandidate

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

Description copied from interface: ExtSourcesManagerBl

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

Specified by:

getCandidate in interface ExtSourcesManagerBl

Parameters:

sess - 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:

CandidateNotExistsException

ExtSourceUnsupportedOperationException

getCandidate

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

Description copied from interface: ExtSourcesManagerBl

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

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

Specified by:

getCandidate in interface ExtSourcesManagerBl

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

getDataSource

public DataSource getDataSource(String poolName)

Description copied from interface: ExtSourcesManagerBl

Returns a database connection pool.

Specified by:

getDataSource in interface ExtSourcesManagerBl

Parameters:

poolName - named defined in perun-extSources.xml

Returns:

database connection pool

getExtSourceById

public ExtSource getExtSourceById(PerunSession sess,
 int id)
                           throws InternalErrorException,
ExtSourceNotExistsException

Description copied from interface: ExtSourcesManagerBl

Searches for the external source with specified id.

Specified by:

getExtSourceById in interface ExtSourcesManagerBl

Parameters:

sess -

id -

Returns:

External source with specified id

Throws:

InternalErrorException

ExtSourceNotExistsException

getExtSourceByName

public ExtSource getExtSourceByName(PerunSession sess,
 String name)
                             throws InternalErrorException,
ExtSourceNotExistsException

Description copied from interface: ExtSourcesManagerBl

Searches for the external source using specified name.

Specified by:

getExtSourceByName in interface ExtSourcesManagerBl

Parameters:

sess -

name -

Returns:

External source with specified name

Throws:

InternalErrorException

ExtSourceNotExistsException

getExtSources

public List<ExtSource> getExtSources(PerunSession sess)
                              throws InternalErrorException

Description copied from interface: ExtSourcesManagerBl

Get list of all external sources.

Specified by:

getExtSources in interface ExtSourcesManagerBl

Parameters:

sess -

Returns:

list of external source

Throws:

InternalErrorException

getExtSourcesManagerImpl

public ExtSourcesManagerImplApi getExtSourcesManagerImpl()

Gets the extSourcesManagerImpl for this instance.

Returns:

extSourceManagerImpl

getGroupExtSources

public List<ExtSource> getGroupExtSources(PerunSession sess,
 Group group)
                                   throws InternalErrorException

Description copied from interface: ExtSourcesManagerBl

Get list of external sources associated with the GROUP.

Specified by:

getGroupExtSources in interface ExtSourcesManagerBl

Parameters:

sess -

group -

Returns:

list of external sources associated with the VO

Throws:

InternalErrorException

getInvalidUsers

public List<User> getInvalidUsers(PerunSession sess,
 ExtSource source)

Description copied from interface: ExtSourcesManagerBl

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

Specified by:

getInvalidUsers in interface ExtSourcesManagerBl

Parameters:

sess -

source -

Returns:

list of users, who is not in the extSource anymore

getPerunBl

public PerunBl getPerunBl()

getVoExtSources

public List<ExtSource> getVoExtSources(PerunSession sess,
 Vo vo)
                                throws InternalErrorException

Description copied from interface: ExtSourcesManagerBl

Get list of external sources associated with the VO.

Specified by:

getVoExtSources in interface ExtSourcesManagerBl

Parameters:

sess -

vo -

Returns:

list of external sources associated with the VO

Throws:

InternalErrorException

initialize

public void initialize(PerunSession sess)

Description copied from interface: ExtSourcesManagerBl

Initialize manager.

Specified by:

initialize in interface ExtSourcesManagerBl

loadExtSourcesDefinitions

public void loadExtSourcesDefinitions(PerunSession sess)

Description copied from interface: ExtSourcesManagerBl

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

Specified by:

loadExtSourcesDefinitions in interface ExtSourcesManagerBl

Parameters:

sess -

removeExtSource

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

Description copied from interface: ExtSourcesManagerBl

Remove association of the external source from the VO.

Specified by:

removeExtSource in interface ExtSourcesManagerBl

Parameters:

sess -

vo -

source -

Throws:

ExtSourceNotAssignedException

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

removeExtSource

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

Description copied from interface: ExtSourcesManagerBl

Remove association of the external source from the GROUP.

Specified by:

removeExtSource in interface ExtSourcesManagerBl

Parameters:

sess -

group -

source -

Throws:

ExtSourceNotAssignedException

ExtSourceAlreadyRemovedException - when 0 rows affected by removing from DB

removeExtSources

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

Description copied from interface: ExtSourcesManagerBl

Remove associations of external sources from the VO.

Specified by:

removeExtSources in interface ExtSourcesManagerBl

Parameters:

sess -

vo -

sources -

Throws:

ExtSourceNotAssignedException

ExtSourceAlreadyRemovedException - when 0 rows affected by removing from DB

removeExtSources

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

Description copied from interface: ExtSourcesManagerBl

Remove associations of external sources from the GROUP.

Specified by:

removeExtSources in interface ExtSourcesManagerBl

Parameters:

sess -

group -

sources -

Throws:

ExtSourceNotAssignedException

ExtSourceAlreadyRemovedException - when 0 rows affected by removing from DB

setPerunBl

public void setPerunBl(PerunBl perunBl)