org.openepics.cable.services

Interface UserDirectoryService

All Known Implementing Classes:

DummyUserDirectoryService, RBACUserDirectoryService

public interface UserDirectoryService

This is a service that provides directory data on users.

Author:

Sunil Sah

Method Summary

Modifier and Type	Method and Description
Set<String>	getAllAdministratorUsernames() Returns a set of names of all users that have administer permission of the cable database.
Set<String>	getAllUsernames() Returns a set of all user names currently registered in the directory.
Set<String>	getAllUserUsernames() Returns a set of names of all users that have user permission of the cable database.
String	getEmail(String username) Retrieves the email address for the given user.
String	getUserFullName(String username) Retrieves fur name for the given user.
String	getUserFullNameAndEmail(String username) Retrieves the full name and email of the user in the form Name Surname - mail@mail.com
void	validate() Tests that the directory service is reachable, and throws an exception if it isn't.

Method Detail

validate

void validate()

Tests that the directory service is reachable, and throws an exception if it isn't.

getAllUsernames

Set<String> getAllUsernames()

Returns a set of all user names currently registered in the directory.

Returns:

the set

getAllUserUsernames

Set<String> getAllUserUsernames()

Returns a set of names of all users that have user permission of the cable database.

Returns:

the set

getAllAdministratorUsernames

Set<String> getAllAdministratorUsernames()

Returns a set of names of all users that have administer permission of the cable database.

Returns:

the set

getEmail

String getEmail(String username)

Retrieves the email address for the given user.

Parameters:

username - the user name

Returns:

the user email

getUserFullName

String getUserFullName(String username)

Retrieves fur name for the given user.

Parameters:

username - the user name

Returns:

the full name of the user

getUserFullNameAndEmail

String getUserFullNameAndEmail(String username)

Retrieves the full name and email of the user in the form Name Surname - mail@mail.com

Parameters:

username - the user name

Returns:

the user full name and email