org.apache.oodt.security.sso

Interface SingleSignOn

All Known Implementing Classes:

AbstractWebBasedSingleSignOn, DummyImpl, OpenSSOImpl

public interface SingleSignOn

The CAS java-based single sign on API.

Version:

$Revision$

Author:

mattmann

Method Summary

Modifier and Type	Method and Description
String	getCurrentUsername() Should return the current logged in Single Sign On username returned from the implementation-specific authentication API.
boolean	getLastConnectionStatus() Should provide information (true or false) as to whether the last connection to the SSO authentication service was successful.
boolean	isLoggedIn() Returns true when the user is logged in, or false otherwise.
boolean	login(String username, String password) Logs the user with the provided username and password in to the SSO authentication mechanism.
void	logout() Logs the current SSO user out of her session.
List<String>	retrieveGroupsForUser(String username) Obtains a user's groups from the security principal that this SSO object talks to.

Method Detail

getCurrentUsername

String getCurrentUsername()

Should return the current logged in Single Sign On username returned from the implementation-specific authentication API.

Returns:

A string representation of the current SSO username.

isLoggedIn

boolean isLoggedIn()

Returns true when the user is logged in, or false otherwise.

Returns:

True if the user is logged in, false otherwise.

login

boolean login(String username,
              String password)

Logs the user with the provided username and password in to the SSO authentication mechanism.

Parameters:

username - The username credentials.

password - The password credentials.

Returns:

True if the login was successful, false otherwise.

logout

void logout()

Logs the current SSO user out of her session.

getLastConnectionStatus

boolean getLastConnectionStatus()

Should provide information (true or false) as to whether the last connection to the SSO authentication service was successful.

Returns:

True if the last authentication was successful, false otherwise.

retrieveGroupsForUser

List<String> retrieveGroupsForUser(String username)

Obtains a user's groups from the security principal that this SSO object talks to.

Parameters:

username - The username to obtain the groups for.

Returns:

A List of string group names obtained from the security principal.