Package cz.metacentrum.perun.core.impl

Class ExtSourcesManagerImpl

java.lang.Object

cz.metacentrum.perun.core.impl.ExtSourcesManagerImpl

All Implemented Interfaces:

ExtSourcesManagerImplApi

public class ExtSourcesManagerImpl
extends Object
implements ExtSourcesManagerImplApi

Field Summary

Fields

Modifier and Type	Field	Description
static final String	USEREXTSOURCEMAPPING

Constructor Summary

Constructors

Constructor	Description
ExtSourcesManagerImpl(DataSource perunPool)

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	checkExtSourceExists(PerunSession perunSession, ExtSource es)	Check if extSource exists in underlaying data source.
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()	Cleans up allocated resources.
boolean	extSourceExists(PerunSession perunSession, ExtSource extSource)	Check if extSource exists in underlaying data source.
List<Integer>	getAssociatedUsersIdsWithExtSource(PerunSession sess, 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 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.
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 sess, Vo vo)	Get list of external sources ids associated to the VO.
void	initialize(PerunSession sess, PerunBl perunBl)	Routine which initialize the extSourcesManager.
void	loadExtSourcesDefinitions(PerunSession sess)	Loads the extSources definitions from the XML configuration file.
void	removeExtSource(PerunSession perunSession, 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	setSelf(ExtSourcesManagerImplApi self)
void	updateExtSource(PerunSession sess, ExtSource extSource, Map<String,String> attributes)	Updates extSource definition.

Methods inherited from class java.lang.Object

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

Field Details

USEREXTSOURCEMAPPING

public static final String USEREXTSOURCEMAPPING

See Also:

• Constant Field Values

Constructor Details

ExtSourcesManagerImpl

public ExtSourcesManagerImpl(DataSource perunPool)

Method Details

addExtSource

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

Description copied from interface: ExtSourcesManagerImplApi

Associate external source definition with the VO.

Specified by:

addExtSource in interface ExtSourcesManagerImplApi

Parameters:

sess -

vo -

source -

Throws:

ExtSourceAlreadyAssignedException

addExtSource

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

Description copied from interface: ExtSourcesManagerImplApi

Associate external source definition with the GROUP.

Specified by:

addExtSource in interface ExtSourcesManagerImplApi

Parameters:

sess -

group -

source -

Throws:

ExtSourceAlreadyAssignedException

checkExtSourceExists

public void checkExtSourceExists(PerunSession perunSession,
 ExtSource es)
                          throws ExtSourceNotExistsException

Description copied from interface: ExtSourcesManagerImplApi

Check if extSource exists in underlaying data source.

Specified by:

checkExtSourceExists in interface ExtSourcesManagerImplApi

Parameters:

perunSession -

es -

Throws:

ExtSourceNotExistsException

createExtSource

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

Description copied from interface: ExtSourcesManagerImplApi

Creates an external source.

Specified by:

createExtSource in interface ExtSourcesManagerImplApi

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

Deletes an external source.

Specified by:

deleteExtSource in interface ExtSourcesManagerImplApi

Parameters:

sess -

extSource -

Throws:

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

destroy

public void destroy()

Cleans up allocated resources.

Specified by:

destroy in interface ExtSourcesManagerImplApi

extSourceExists

public boolean extSourceExists(PerunSession perunSession,
 ExtSource extSource)

Description copied from interface: ExtSourcesManagerImplApi

Check if extSource exists in underlaying data source.

Specified by:

extSourceExists in interface ExtSourcesManagerImplApi

Parameters:

perunSession -

extSource -

Returns:

true if extSource exists in underlaying data source, false otherwise

getAssociatedUsersIdsWithExtSource

public List<Integer> getAssociatedUsersIdsWithExtSource(PerunSession sess,
 ExtSource source)

Description copied from interface: ExtSourcesManagerImplApi

Get all users' id associate with the provided ExtSource

Specified by:

getAssociatedUsersIdsWithExtSource in interface ExtSourcesManagerImplApi

Parameters:

sess -

source -

Returns:

list of users' id associated with the provided ExtSource

getAttributes

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

Description copied from interface: ExtSourcesManagerImplApi

Gets attributes for external source.

Specified by:

getAttributes in interface ExtSourcesManagerImplApi

Parameters:

extSource - External Source

Returns:

Map of attributes for external source

getDataSource

public DataSource getDataSource(String poolName)

Description copied from interface: ExtSourcesManagerImplApi

Returns a database connection pool.

Specified by:

getDataSource in interface ExtSourcesManagerImplApi

Parameters:

poolName - named defined in perun-extSources.xml

Returns:

database connection pool

getExtSourceById

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

Description copied from interface: ExtSourcesManagerImplApi

Searches for the external source with specified id.

Specified by:

getExtSourceById in interface ExtSourcesManagerImplApi

Parameters:

sess -

id -

Returns:

External source with specified id

Throws:

ExtSourceNotExistsException

getExtSourceByName

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

Description copied from interface: ExtSourcesManagerImplApi

Searches for the external source using specified name.

Specified by:

getExtSourceByName in interface ExtSourcesManagerImplApi

Parameters:

sess -

name -

Returns:

External source with specified name

Throws:

ExtSourceNotExistsException

getExtSources

public List<ExtSource> getExtSources(PerunSession sess)

Description copied from interface: ExtSourcesManagerImplApi

Get list of all external sources.

Specified by:

getExtSources in interface ExtSourcesManagerImplApi

Parameters:

sess -

Returns:

list of VO

getExtSourcesToSynchronize

public List<ExtSource> getExtSourcesToSynchronize(PerunSession sess)

Description copied from interface: ExtSourcesManagerImplApi

Returns all ExtSources with enabled synchronization

Specified by:

getExtSourcesToSynchronize in interface ExtSourcesManagerImplApi

Parameters:

sess - PerunSession

Returns:

List of External Sources with enabled synchronization

getGroupExtSourcesIds

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

Description copied from interface: ExtSourcesManagerImplApi

Get list of external sources ids associated with the GROUP.

Specified by:

getGroupExtSourcesIds in interface ExtSourcesManagerImplApi

Parameters:

perunSession -

group -

Returns:

list of external sources ids associated with the group

Throws:

InternalErrorException

getVoExtSourcesIds

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

Description copied from interface: ExtSourcesManagerImplApi

Get list of external sources ids associated to the VO.

Specified by:

getVoExtSourcesIds in interface ExtSourcesManagerImplApi

Parameters:

sess -

vo -

Returns:

list of external sources ids associated with the VO

Throws:

InternalErrorException

initialize

public void initialize(PerunSession sess,
 PerunBl perunBl)

Routine which initialize the extSourcesManager.

Specified by:

initialize in interface ExtSourcesManagerImplApi

loadExtSourcesDefinitions

public void loadExtSourcesDefinitions(PerunSession sess)

Loads the extSources definitions from the XML configuration file. All data from the extSouces XML file are synchronized with the DB.

Example:

 
 
 
 MAIN
 

 
 
 PEOPLEDB
 jdbc:oracle:thin:@//oracle.example.com:1521/people
 perun
 ******
 oracle.jdbc.OracleDriver
 300000
 600000
 10
 1
 300000
 30000
 
 
 
 INET
 cz.metacentrum.perun.core.impl.ExtSourceSql
 
 
 INETDB
 ...
 ...
 
 
 

Specified by:

loadExtSourcesDefinitions in interface ExtSourcesManagerImplApi

Parameters:

sess -

removeExtSource

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

Description copied from interface: ExtSourcesManagerImplApi

Remove association of the external source from the VO.

Specified by:

removeExtSource in interface ExtSourcesManagerImplApi

Parameters:

sess -

vo -

source -

Throws:

ExtSourceNotAssignedException

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

removeExtSource

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

Description copied from interface: ExtSourcesManagerImplApi

Remove association of the external source from the GROUP.

Specified by:

removeExtSource in interface ExtSourcesManagerImplApi

Parameters:

perunSession -

group -

source -

Throws:

ExtSourceNotAssignedException

ExtSourceAlreadyRemovedException - when 0 rows affected by removing from DB

setSelf

public void setSelf(ExtSourcesManagerImplApi self)

updateExtSource

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

Description copied from interface: ExtSourcesManagerImplApi

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 !!!

Specified by:

updateExtSource in interface ExtSourcesManagerImplApi

Parameters:

sess -

extSource -

Throws:

ExtSourceNotExistsException