Package cz.metacentrum.perun.core.implApi

Interface ExtSourcesManagerImplApi

All Known Implementing Classes:

ExtSourcesManagerImpl

public interface ExtSourcesManagerImplApi

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	checkExtSourceExists(PerunSession perunSession, ExtSource extSource)	Check if extSource exists in underlaying data source.
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()	Clean up allocated resources.
boolean	extSourceExists(PerunSession perunSession, ExtSource extSource)	Check if extSource exists in underlaying data source.
List<Integer>	getAssociatedUsersIdsWithExtSource(PerunSession perunSession, ExtSource source)	Get all users' id associate with the provided ExtSource
Map<String,String>	getAttributes(ExtSource extSource)	Gets attributes for external source.
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>	getExtSourcesToSynchronize(PerunSession sess)	Returns all ExtSources with enabled synchronization
List<Integer>	getGroupExtSourcesIds(PerunSession perunSession, Group group)	Get list of external sources ids associated with the GROUP.
List<Integer>	getVoExtSourcesIds(PerunSession perunSession, Vo vo)	Get list of external sources ids associated to the VO.
void	initialize(PerunSession sess, PerunBl perunBl)	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	updateExtSource(PerunSession sess, ExtSource extSource, Map<String,String> attributes)	Updates extSource definition.

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

checkExtSourceExists

void checkExtSourceExists(PerunSession perunSession,
 ExtSource extSource)
                   throws ExtSourceNotExistsException

Check if extSource exists in underlaying data source.

Parameters:

perunSession -

extSource -

Throws:

InternalErrorException

ExtSourceNotExistsException

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:

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

InternalErrorException

destroy

void destroy()

Clean up allocated resources.

extSourceExists

boolean extSourceExists(PerunSession perunSession,
 ExtSource extSource)

Check if extSource exists in underlaying data source.

Parameters:

perunSession -

extSource -

Returns:

true if extSource exists in underlaying data source, false otherwise

Throws:

InternalErrorException

getAssociatedUsersIdsWithExtSource

List<Integer> getAssociatedUsersIdsWithExtSource(PerunSession perunSession,
 ExtSource source)

Get all users' id associate with the provided ExtSource

Parameters:

perunSession -

source -

Returns:

list of users' id associated with the provided ExtSource

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

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 VO

Throws:

InternalErrorException

getExtSourcesToSynchronize

List<ExtSource> getExtSourcesToSynchronize(PerunSession sess)

Returns all ExtSources with enabled synchronization

Parameters:

sess - PerunSession

Returns:

List of External Sources with enabled synchronization

Throws:

InternalErrorException

getGroupExtSourcesIds

List<Integer> getGroupExtSourcesIds(PerunSession perunSession,
 Group group)
                             throws InternalErrorException

Get list of external sources ids associated with the GROUP.

Parameters:

perunSession -

group -

Returns:

list of external sources ids associated with the group

Throws:

InternalErrorException

getVoExtSourcesIds

List<Integer> getVoExtSourcesIds(PerunSession perunSession,
 Vo vo)
                          throws InternalErrorException

Get list of external sources ids associated to the VO.

Parameters:

perunSession -

vo -

Returns:

list of external sources ids associated with the VO

Throws:

InternalErrorException

initialize

void initialize(PerunSession sess,
 PerunBl perunBl)

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 remove in 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

updateExtSource

void updateExtSource(PerunSession sess,
 ExtSource extSource,
 Map<String,String> attributes)
              throws ExtSourceNotExistsException

Updates extSource definition. It should be called only internally, because extSources are defined in the external XML file. It shouldn't be called from upper layers !!!

Parameters:

sess -

extSource -

Throws:

InternalErrorException

ExtSourceNotExistsException