org.jasig.portlet.blackboardvcportlet.security

Interface ConferenceUserService

All Known Implementing Classes:

ConferenceUserServiceImpl

public interface ConferenceUserService

Provides access to the currently authenticated user

Author:

Eric Dalquist

Method Summary

Methods

Modifier and Type	Method and Description
BasicUser	findBasicUser(String uniqueId)
ConferenceUser	getConferenceUser(org.springframework.security.core.Authentication authentication)
org.springframework.security.core.Authentication	getCurrentAuthentication()
ConferenceUser	getCurrentConferenceUser()
ConferenceUser	getOrCreateConferenceUser(BasicUser basicUser)
ConferenceUser	getOrCreateConferenceUser(String displayName, String email)
ConferenceUser	getOrCreateConferenceUser(String uniqueId, String displayName, String email)
Set<BasicUser>	searchForBasicUserByEmail(String email) Search for a set of users via BasicUser.getEmail().
Set<BasicUser>	searchForBasicUserByName(String name) Search for a set of users via BasicUser.getDisplayName().

Method Detail

getCurrentConferenceUser

ConferenceUser getCurrentConferenceUser()

Returns:

The currently authenticated user, null if no user is currently authenticated

getConferenceUser

ConferenceUser getConferenceUser(org.springframework.security.core.Authentication authentication)

Returns:

The user for the specified Authentication

getCurrentAuthentication

org.springframework.security.core.Authentication getCurrentAuthentication()

Returns:

The current authentication object

getOrCreateConferenceUser

ConferenceUser getOrCreateConferenceUser(String displayName,
                                       String email)

getOrCreateConferenceUser

ConferenceUser getOrCreateConferenceUser(String uniqueId,
                                       String displayName,
                                       String email)

getOrCreateConferenceUser

ConferenceUser getOrCreateConferenceUser(BasicUser basicUser)

findBasicUser

BasicUser findBasicUser(String uniqueId)

Parameters:

uniqueId - The BasicUser.getUniqueId() for the user to find

Returns:

The user for the uniqueId

searchForBasicUserByName

Set<BasicUser> searchForBasicUserByName(String name)

Search for a set of users via BasicUser.getDisplayName(). It is up to the implementation to parse the name parameter to return the best result set based on the name or name fragment.

Parameters:

name - The name or name fragment to search on.

Returns:

Throws:

ToManyResultsException - If more results than the implementation's limit are found, used to prevent using this service to spider available users

searchForBasicUserByEmail

Set<BasicUser> searchForBasicUserByEmail(String email)

Search for a set of users via BasicUser.getEmail(). It is up to the implementation to parse the email parameter to return the best result set based on the email or email fragment.

Parameters:

email - The email or email fragment to search on.

Returns:

Throws:

ToManyResultsException - If more results than the implementation's limit are found, used to prevent using this service to spider available users