Package cz.metacentrum.perun.core.impl

Class ExtSourceGoogle

java.lang.Object

cz.metacentrum.perun.core.api.PerunBean

cz.metacentrum.perun.core.api.Auditable

cz.metacentrum.perun.core.api.ExtSource

cz.metacentrum.perun.core.impl.ExtSourceImpl

cz.metacentrum.perun.core.impl.ExtSourceGoogle

All Implemented Interfaces:

ExtSourceApi, ExtSourceSimpleApi, Serializable, Comparable<PerunBean>

public class ExtSourceGoogle
extends ExtSourceImpl
implements ExtSourceApi

Ext source implementation for Google Groups.

Author:

Sona Mastrakova

See Also:

• Serialized Form

Field Summary

Fields inherited from class cz.metacentrum.perun.core.impl.ExtSourceImpl

perunBl

Constructor Summary

Constructors

Constructor	Description
ExtSourceGoogle()

Method Summary

Modifier and Type	Method	Description
void	close()	If extSource needs to be closed, this method must be called.
List<Map<String,String>>	findSubjects(String searchString)	Finds all subjects with attributes in the external source, that contains searchString.
List<Map<String,String>>	findSubjects(String searchString, int maxResults)	Finds all subjects with attributes in the external source, that contains searchString limited by the maxResults
List<Map<String,String>>	findSubjectsLogins(String searchString)	Finds all subjects logins in the external source, that contains searchString.
List<Map<String,String>>	findSubjectsLogins(String searchString, int maxResults)	Finds all subjects logins in the external source, that contains searchString, limited by the maxResults.
com.google.api.services.directory.Directory	getDirectoryService()	Build and returns a Directory service object authorized with the service accounts that act on behalf of the given user.
String	getDomainName()
List<Map<String,String>>	getGroupSubjects(Map<String,String> attributes)	Get the list of the subjects in the external group.
Map<String,String>	getSubjectByLogin(String login)	Finds subject from the external source by the primary login used in external source.
List<Map<String,String>>	getSubjectGroups(Map<String,String> attributes)	Get the list of the subject groups in the external source.
List<Map<String,String>>	getUsersSubjects()	Get the list of subjects from the external source.

Methods inherited from class cz.metacentrum.perun.core.impl.ExtSourceImpl

getAttributes

Methods inherited from class cz.metacentrum.perun.core.api.ExtSource

compareTo, equals, getBeanName, getName, getType, hashCode, serializeToString, setName, setType, toString

Methods inherited from class cz.metacentrum.perun.core.api.Auditable

getCreatedAt, getCreatedBy, getCreatedByUid, getModifiedAt, getModifiedBy, getModifiedByUid, setCreatedAt, setCreatedBy, setCreatedByUid, setModifiedAt, setModifiedBy, setModifiedByUid

Methods inherited from class cz.metacentrum.perun.core.api.PerunBean

getId, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ExtSourceGoogle

public ExtSourceGoogle()

Method Details

close

public void close()
           throws ExtSourceUnsupportedOperationException

Description copied from interface: ExtSourceSimpleApi

If extSource needs to be closed, this method must be called.

Specified by:

close in interface ExtSourceSimpleApi

Throws:

ExtSourceUnsupportedOperationException

findSubjects

public List<Map<String,String>> findSubjects(String searchString)

Description copied from interface: ExtSourceApi

Finds all subjects with attributes in the external source, that contains searchString.

This method is used for getting all logins of subjects in external source with all possible attributes.

Specified by:

findSubjects in interface ExtSourceApi

Returns:

list of maps, which contains attr_name->attr_value (for all extSource attributes)

findSubjects

public List<Map<String,String>> findSubjects(String searchString,
 int maxResults)

Description copied from interface: ExtSourceApi

Finds all subjects with attributes in the external source, that contains searchString limited by the maxResults

This method is used for getting all logins of subjects in external source with all possible attributes.

Specified by:

findSubjects in interface ExtSourceApi

maxResults - define max number of returned results, 0 means unlimited

Returns:

list of maps, which contains attr_name->attr_value (for all extSource attributes)

findSubjectsLogins

public List<Map<String,String>> findSubjectsLogins(String searchString,
 int maxResults)
                                            throws ExtSourceUnsupportedOperationException

Description copied from interface: ExtSourceSimpleApi

Finds all subjects logins in the external source, that contains searchString, limited by the maxResults.

This method is used for getting all logins of subjects in external source and then use them to searching in external source for other subjects attributes

Specified by:

findSubjectsLogins in interface ExtSourceSimpleApi

maxResults - limit returned results

Returns:

list of maps, which contains attr_name->attr_value but only for login definition eg. login;MichalS

Throws:

ExtSourceUnsupportedOperationException

findSubjectsLogins

public List<Map<String,String>> findSubjectsLogins(String searchString)
                                            throws ExtSourceUnsupportedOperationException

Description copied from interface: ExtSourceSimpleApi

Finds all subjects logins in the external source, that contains searchString.

This method is used for getting all logins of subjects in external source and then use them to searching in external source for other subjects attributes.

Specified by:

findSubjectsLogins in interface ExtSourceSimpleApi

Returns:

list of maps, which contains attr_name->attr_value but only for login definition eg. login;MichalS

Throws:

ExtSourceUnsupportedOperationException

getDirectoryService

public com.google.api.services.directory.Directory getDirectoryService()

Build and returns a Directory service object authorized with the service accounts that act on behalf of the given user.

Returns:

Directory service object that is ready to make requests.

getDomainName

public String getDomainName()

getGroupSubjects

public List<Map<String,String>> getGroupSubjects(Map<String,String> attributes)

Description copied from interface: ExtSourceSimpleApi

Get the list of the subjects in the external group.

Specified by:

getGroupSubjects in interface ExtSourceSimpleApi

Parameters:

attributes - map of attributes used for quering the external source

Returns:

list of maps, which contains attr_name->attr_value, e.g. firstName->Michal

getSubjectByLogin

public Map<String,String> getSubjectByLogin(String login)
                                     throws SubjectNotExistsException

Description copied from interface: ExtSourceSimpleApi

Finds subject from the external source by the primary login used in external source.

Specified by:

getSubjectByLogin in interface ExtSourceSimpleApi

Parameters:

login - login used in the external source

Returns:

map which contains attr_name -> attr_value, e.g. firstName->Michal

Throws:

SubjectNotExistsException - if the subject cannot be found

getSubjectGroups

public List<Map<String,String>> getSubjectGroups(Map<String,String> attributes)
                                          throws ExtSourceUnsupportedOperationException

Description copied from interface: ExtSourceSimpleApi

Get the list of the subject groups in the external source.

Specified by:

getSubjectGroups in interface ExtSourceSimpleApi

Parameters:

attributes - map of attributes used for quering the external source

Returns:

list of maps, which contains attr name and attr value

Throws:

ExtSourceUnsupportedOperationException

getUsersSubjects

public List<Map<String,String>> getUsersSubjects()

Description copied from interface: ExtSourceSimpleApi

Get the list of subjects from the external source.

Specified by:

getUsersSubjects in interface ExtSourceSimpleApi

Returns:

list of maps, which contains attr_name->attr_value, e.g. firstName->Michal