Package cz.metacentrum.perun.core.api

Interface ExtSourcesManager

All Known Implementing Classes:

ExtSourcesManagerEntry

public interface ExtSourcesManager

Author:

Michal Prochazka <michalp@ics.muni.cz>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIGURATIONFILE
static final String	EXTSOURCE_IDP
static final String	EXTSOURCE_INTERNAL
static final String	EXTSOURCE_KERBEROS
static final String	EXTSOURCE_LDAP
static final String	EXTSOURCE_NAME_INTERNAL	Name of the INTERNAL extSource, which is used for internal Perun components like Registrar etc.
static final String	EXTSOURCE_NAME_LOCAL	Name of the LOCAL extSource, which is used for users without any external authentication.
static final String	EXTSOURCE_NAME_PERUN	Name of the default extSource which have every user in Perun.
static final String	EXTSOURCE_REMS
static final String	EXTSOURCE_SQL
static final String	EXTSOURCE_SYNCHRONIZATION_ENABLED_ATTRNAME
static final String	EXTSOURCE_X509

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.
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.
Map<String,String>	getAttributes(PerunSession sess, ExtSource extSource)	Gets attributes for external source.
Candidate	getCandidate(PerunSession perunSession, ExtSource source, String login)	Get the candidate from the ExtSource defined by the extsource login.
Candidate	getCandidate(PerunSession perunSession, Map<String,String> subjectData, ExtSource source)	Get the candidate from subjectData where at least login must exists.
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	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.

Field Details

EXTSOURCE_IDP

static final String EXTSOURCE_IDP

See Also:

• Constant Field Values

EXTSOURCE_SQL

static final String EXTSOURCE_SQL

See Also:

• Constant Field Values

EXTSOURCE_LDAP

static final String EXTSOURCE_LDAP

See Also:

• Constant Field Values

EXTSOURCE_KERBEROS

static final String EXTSOURCE_KERBEROS

See Also:

• Constant Field Values

EXTSOURCE_INTERNAL

static final String EXTSOURCE_INTERNAL

See Also:

• Constant Field Values

EXTSOURCE_X509

static final String EXTSOURCE_X509

See Also:

• Constant Field Values

EXTSOURCE_REMS

static final String EXTSOURCE_REMS

See Also:

• Constant Field Values

EXTSOURCE_NAME_LOCAL

static final String EXTSOURCE_NAME_LOCAL

Name of the LOCAL extSource, which is used for users without any external authentication. extLogin is generated on the fly, usually it is time of the first access.

See Also:

• Constant Field Values

EXTSOURCE_NAME_INTERNAL

static final String EXTSOURCE_NAME_INTERNAL

Name of the INTERNAL extSource, which is used for internal Perun components like Registrar etc.

See Also:

• Constant Field Values

EXTSOURCE_NAME_PERUN

static final String EXTSOURCE_NAME_PERUN

Name of the default extSource which have every user in Perun.

See Also:

• Constant Field Values

CONFIGURATIONFILE

static final String CONFIGURATIONFILE

See Also:

• Constant Field Values

EXTSOURCE_SYNCHRONIZATION_ENABLED_ATTRNAME

static final String EXTSOURCE_SYNCHRONIZATION_ENABLED_ATTRNAME

See Also:

• Constant Field Values

Method Details

addExtSource

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

Associate external source definition with the VO.

Throws:

PrivilegeException

VoNotExistsException

ExtSourceNotExistsException

ExtSourceAlreadyAssignedException

addExtSource

void addExtSource(PerunSession perunSession,
 Group group,
 ExtSource source)
           throws PrivilegeException,
VoNotExistsException,
GroupNotExistsException,
ExtSourceNotAssignedException,
ExtSourceNotExistsException,
ExtSourceAlreadyAssignedException

Associate external source definition with the GROUP.

Throws:

PrivilegeException

VoNotExistsException

GroupNotExistsException

ExtSourceNotAssignedException

ExtSourceNotExistsException

ExtSourceAlreadyAssignedException

addExtSources

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

Associate external source definitions with the VO.

Parameters:

perunSession - sess

vo - vo

sources - list of sources to associate

Throws:

PrivilegeException

VoNotExistsException

ExtSourceNotExistsException

ExtSourceAlreadyAssignedException

addExtSources

void addExtSources(PerunSession perunSession,
 Group group,
 List<ExtSource> sources)
            throws PrivilegeException,
VoNotExistsException,
GroupNotExistsException,
ExtSourceNotAssignedException,
ExtSourceNotExistsException,
ExtSourceAlreadyAssignedException

Associate external source definitions with the group.

Parameters:

perunSession - sess

group - group

sources - list of sources to associate

Throws:

PrivilegeException

VoNotExistsException

GroupNotExistsException

ExtSourceNotExistsException

ExtSourceNotAssignedException

ExtSourceAlreadyAssignedException

checkOrCreateExtSource

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

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

Returns:

existing or newly created extSource is returned

createExtSource

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

Creates an external source.

Returns:

ExtSource object with newly associated ID.

Throws:

ExtSourceExistsException

PrivilegeException

deleteExtSource

void deleteExtSource(PerunSession perunSession,
 ExtSource extSource)
              throws ExtSourceNotExistsException,
PrivilegeException,
ExtSourceAlreadyRemovedException

Deletes an external source.

Throws:

ExtSourceAlreadyRemovedException - when 0 rows are affected by deleting from DB

ExtSourceNotExistsException

PrivilegeException

getAttributes

Map<String,String> getAttributes(PerunSession sess,
 ExtSource extSource)
                          throws PrivilegeException,
ExtSourceNotExistsException

Gets attributes for external source. Must be Perun Admin.

Parameters:

sess - Current Session

extSource - External Source

Returns:

Map of attributes for external source

Throws:

PrivilegeException

ExtSourceNotExistsException

getCandidate

Candidate getCandidate(PerunSession perunSession,
 ExtSource source,
 String login)
                throws PrivilegeException,
ExtSourceNotExistsException,
CandidateNotExistsException,
ExtSourceUnsupportedOperationException

Get the candidate from the ExtSource defined by the extsource login.

Returns:

a Candidate object

Throws:

PrivilegeException

ExtSourceNotExistsException

CandidateNotExistsException

ExtSourceUnsupportedOperationException

getCandidate

Candidate getCandidate(PerunSession perunSession,
 Map<String,String> subjectData,
 ExtSource source)
                throws PrivilegeException,
ExtSourceNotExistsException

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

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

Returns:

a Candidate object

Throws:

PrivilegeException

ExtSourceNotExistsException

getExtSourceById

ExtSource getExtSourceById(PerunSession perunSession,
 int id)
                    throws ExtSourceNotExistsException,
PrivilegeException

Searches for the external source with specified id.

Returns:

External source with specified id

Throws:

ExtSourceNotExistsException

PrivilegeException

getExtSourceByName

ExtSource getExtSourceByName(PerunSession perunSession,
 String name)
                      throws ExtSourceNotExistsException,
PrivilegeException

Searches for the external source using specified name.

Returns:

External source with specified name

Throws:

ExtSourceNotExistsException

PrivilegeException

getExtSources

List<ExtSource> getExtSources(PerunSession perunSession)
                       throws PrivilegeException

Get list of all external sources.

Returns:

list of external source

Throws:

PrivilegeException

getGroupExtSources

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

Get list of external sources associated with the GROUP.

Returns:

list of external sources associated with the VO

Throws:

PrivilegeException

GroupNotExistsException

getInvalidUsers

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

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

Returns:

list of users, who is not in the extSource anymore

Throws:

PrivilegeException

ExtSourceNotExistsException

getVoExtSources

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

Get list of external sources associated with the VO.

Returns:

list of external sources associated with the VO

Throws:

PrivilegeException

VoNotExistsException

loadExtSourcesDefinitions

void loadExtSourcesDefinitions(PerunSession sess)
                        throws PrivilegeException

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

Throws:

PrivilegeException

removeExtSource

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

Remove association of the external source from the VO.

Throws:

ExtSourceAlreadyRemovedException - when 0 rows affected by removing from DB

PrivilegeException

VoNotExistsException

ExtSourceNotExistsException

ExtSourceNotAssignedException

removeExtSource

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

Remove association of the external source from the GROUP.

Throws:

ExtSourceAlreadyRemovedException - when 0 rows affected by removing from DB

PrivilegeException

GroupNotExistsException

ExtSourceNotExistsException

ExtSourceNotAssignedException

removeExtSources

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

Remove associations of external sources from the VO.

Parameters:

perunSession -

vo -

sources -

Throws:

ExtSourceAlreadyRemovedException - when 0 rows affected by removing from DB

PrivilegeException

VoNotExistsException

ExtSourceNotExistsException

ExtSourceNotAssignedException

removeExtSources

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

Remove associations of external sources from the GROUP.

Parameters:

perunSession -

group -

sources -

Throws:

ExtSourceAlreadyRemovedException - when 0 rows affected by removing from DB

PrivilegeException

GroupNotExistsException

ExtSourceNotExistsException

ExtSourceNotAssignedException