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
static class AuthenticationComponent.UserNameValidationMode
           
 
Method Summary
 void authenticate(java.lang.String userName, char[] password)
          Authenticate
 java.util.Set getDefaultAdministratorUserNames()
          Gets a set of user names who for this particular authentication system should be considered administrators by default.
 java.util.Set 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(java.lang.String userName)
          Explicitly set the current user to be authenticated.
 net.sf.acegisecurity.Authentication setCurrentUser(java.lang.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(java.lang.String userName,
                  char[] password)
                  throws org.alfresco.repo.security.authentication.AuthenticationException
Authenticate

Throws:
AuthenticationException

setCurrentUser

net.sf.acegisecurity.Authentication setCurrentUser(java.lang.String userName)
Explicitly set the current user to be authenticated.


setCurrentUser

net.sf.acegisecurity.Authentication setCurrentUser(java.lang.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

java.util.Set 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

java.util.Set 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


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.