org.alfresco.repo.security.authentication

Interface AuthenticationComponent

All Superinterfaces:

AuthenticationContext

All Known Subinterfaces:

NLTMAuthenticator

All Known Implementing Classes:

AbstractAuthenticationComponent, AbstractChainingAuthenticationComponent, AuthenticationComponentImpl, ChainingAuthenticationComponentImpl, JAASAuthenticationComponent, LDAPAuthenticationComponentImpl, NTLMAuthenticationComponentImpl, SimpleAcceptOrRejectAllAuthenticationComponentImpl, SubsystemChainingAuthenticationComponent

public interface AuthenticationComponent
extends AuthenticationContext

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuthenticationComponent.UserNameValidationMode

Method Summary

Modifier and Type	Method and Description
void	authenticate(String userName, char[] password) Authenticate
Set<String>	getDefaultAdministratorUserNames() Gets a set of user names who for this particular authentication system should be considered administrators by default.
Set<String>	getDefaultGuestUserNames() Gets a set of user names who for this particular authentication system should be considered guests by default.
boolean	guestUserAuthenticationAllowed() True if Guest user authentication is allowed, false otherwise
net.sf.acegisecurity.Authentication	setCurrentUser(String userName) Explicitly set the current user to be authenticated.
net.sf.acegisecurity.Authentication	setCurrentUser(String userName, AuthenticationComponent.UserNameValidationMode validationMode) Explicitly set the current user to be authenticated.
net.sf.acegisecurity.Authentication	setGuestUserAsCurrentUser() Set the guest user as the current user.

Methods inherited from interface org.alfresco.repo.security.authentication.AuthenticationContext

clearCurrentSecurityContext, getCurrentAuthentication, getCurrentUserName, getGuestUserName, getGuestUserName, getSystemUserName, getSystemUserName, getUserDomain, isCurrentUserTheSystemUser, isGuestUserName, isSystemUserName, setCurrentAuthentication, setSystemUserAsCurrentUser, setSystemUserAsCurrentUser, setUserDetails

Method Detail

authenticate

void authenticate(String userName,
                  char[] password)
           throws org.alfresco.repo.security.authentication.AuthenticationException

Authenticate

Throws:

AuthenticationException

setCurrentUser

net.sf.acegisecurity.Authentication setCurrentUser(String userName)

Explicitly set the current user to be authenticated.

setCurrentUser

net.sf.acegisecurity.Authentication setCurrentUser(String userName,
                                                   AuthenticationComponent.UserNameValidationMode validationMode)

Explicitly set the current user to be authenticated. Specify if the userName is to be checked and fixed

setGuestUserAsCurrentUser

net.sf.acegisecurity.Authentication setGuestUserAsCurrentUser()

Set the guest user as the current user.

guestUserAuthenticationAllowed

boolean guestUserAuthenticationAllowed()

True if Guest user authentication is allowed, false otherwise

getDefaultAdministratorUserNames

Set<String> getDefaultAdministratorUserNames()

Gets a set of user names who for this particular authentication system should be considered administrators by default. If the security framework is case sensitive these values should be case sensitive user names. If the security framework is not case sensitive these values should be the lower-case user names.

Returns:

a set of user names

getDefaultGuestUserNames

Set<String> getDefaultGuestUserNames()

Gets a set of user names who for this particular authentication system should be considered guests by default. If the security framework is case sensitive these values should be case sensitive user names. If the security framework is not case sensitive these values should be the lower-case user names.

Returns:

a set of user names