org.alfresco.repo.security.authentication
Interface AuthenticationComponent

All Known Implementing Classes:

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

public interface AuthenticationComponent

Nested Class Summary

static class

AuthenticationComponent.UserNameValidationMode

Method Summary

net.sf.acegisecurity.Authentication	authenticate(net.sf.acegisecurity.Authentication token) Authenticate using a token
void	authenticate(java.lang.String userName, char[] password) Authenticate
void	clearCurrentSecurityContext() Remove the current security information
net.sf.acegisecurity.Authentication	getCurrentAuthentication()
java.lang.String	getCurrentUserName() Get the current user name.
java.lang.String	getGuestUserName() Get the name of the guest user
java.lang.String	getMD4HashedPassword(java.lang.String userName) Get the MD4 password hash, as required by NTLM based authentication methods.
NTLMMode	getNTLMMode() Get the enum that describes NTLM integration
java.lang.String	getSystemUserName() Get the name of the system user
boolean	guestUserAuthenticationAllowed() True if Guest user authentication is allowed, false otherwise
boolean	isSystemUserName(java.lang.String userName) True if this is the System user ?
net.sf.acegisecurity.Authentication	setCurrentAuthentication(net.sf.acegisecurity.Authentication authentication) Explicitly set the current suthentication.
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.
net.sf.acegisecurity.Authentication	setSystemUserAsCurrentUser() Set the system user as the current user.

Method Detail

authenticate

void authenticate(java.lang.String userName,
                  char[] password)
                  throws AuthenticationException

Authenticate

Throws:

AuthenticationException

authenticate

net.sf.acegisecurity.Authentication authenticate(net.sf.acegisecurity.Authentication token)
                                                 throws AuthenticationException

Authenticate using a token

Parameters:

token - Authentication

Returns:

Authentication

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

clearCurrentSecurityContext

void clearCurrentSecurityContext()

Remove the current security information

setCurrentAuthentication

net.sf.acegisecurity.Authentication setCurrentAuthentication(net.sf.acegisecurity.Authentication authentication)

Explicitly set the current suthentication. If the authentication is null the the current authentication is cleared.

Parameters:

authentication - the current authentication (may be null).

Returns:

Returns the modified authentication instance or null if it was cleared.

getCurrentAuthentication

net.sf.acegisecurity.Authentication getCurrentAuthentication()
                                                             throws AuthenticationException

Throws:

AuthenticationException

setSystemUserAsCurrentUser

net.sf.acegisecurity.Authentication setSystemUserAsCurrentUser()

Set the system user as the current user.

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

getSystemUserName

java.lang.String getSystemUserName()

Get the name of the system user

isSystemUserName

boolean isSystemUserName(java.lang.String userName)

True if this is the System user ?

getGuestUserName

java.lang.String getGuestUserName()

Get the name of the guest user

getCurrentUserName

java.lang.String getCurrentUserName()
                                    throws AuthenticationException

Get the current user name.

Throws:

AuthenticationException

getNTLMMode

NTLMMode getNTLMMode()

Get the enum that describes NTLM integration

getMD4HashedPassword

java.lang.String getMD4HashedPassword(java.lang.String userName)

Get the MD4 password hash, as required by NTLM based authentication methods.