Package org.alfresco.service.cmr.security

Interface MutableAuthenticationService

All Superinterfaces:

AuthenticationService

All Known Implementing Classes:

AbstractChainingAuthenticationService, ChainingAuthenticationServiceImpl, MutableAuthenticationServiceImpl, SubsystemChainingAuthenticationService

@AlfrescoPublicApi
public interface MutableAuthenticationService
extends AuthenticationService

An extended AuthenticationService that allows mutation of some or all of its user accounts.

Author:

dward

Method Summary

Modifier and Type	Method	Description
void	createAuthentication(java.lang.String userName, char[] password)	Create an authentication for the given user.
void	deleteAuthentication(java.lang.String userName)	Delete an authentication entry
boolean	isAuthenticationCreationAllowed()	Determines whether authentication creation is allowed.
boolean	isAuthenticationMutable(java.lang.String userName)	Determines whether this user's authentication may be mutated via the other methods.
void	setAuthentication(java.lang.String userName, char[] newPassword)	Set the login information for a user (typically called by an admin user)
void	setAuthenticationEnabled(java.lang.String userName, boolean enabled)	Enable or disable an authentication entry
void	updateAuthentication(java.lang.String userName, char[] oldPassword, char[] newPassword)	Update the login information for the user (typically called by the user)

Methods inherited from interface org.alfresco.service.cmr.security.AuthenticationService

authenticate, authenticateAsGuest, authenticationExists, clearCurrentSecurityContext, getAuthenticationEnabled, getCurrentTicket, getCurrentUserName, getDefaultAdministratorUserNames, getDefaultGuestUserNames, getDomains, getDomainsThatAllowUserCreation, getDomainsThatAllowUserDeletion, getDomiansThatAllowUserPasswordChanges, getNewTicket, guestUserAuthenticationAllowed, invalidateTicket, invalidateUserSession, isCurrentUserTheSystemUser, validate

Method Detail

isAuthenticationMutable

@Auditable(parameters="userName",
           recordable=true)
boolean isAuthenticationMutable(java.lang.String userName)

Determines whether this user's authentication may be mutated via the other methods.

Parameters:

userName - the user ID

Returns:

true if this user's authentication may be mutated via the other methods.

isAuthenticationCreationAllowed

@Auditable
boolean isAuthenticationCreationAllowed()

Determines whether authentication creation is allowed.

Returns:

true if authentication creation is allowed

createAuthentication

@Auditable(parameters={"userName","password"},
           recordable={true,false})
void createAuthentication(java.lang.String userName,
                          char[] password)
                   throws org.alfresco.repo.security.authentication.AuthenticationException

Create an authentication for the given user.

Parameters:

userName - String

password - char[]

Throws:

org.alfresco.repo.security.authentication.AuthenticationException

updateAuthentication

@Auditable(parameters={"userName","oldPassword","newPassword"},
           recordable={true,false,false})
void updateAuthentication(java.lang.String userName,
                          char[] oldPassword,
                          char[] newPassword)
                   throws org.alfresco.repo.security.authentication.AuthenticationException

Update the login information for the user (typically called by the user)

Parameters:

userName - String

oldPassword - char[]

newPassword - char[]

Throws:

org.alfresco.repo.security.authentication.AuthenticationException

setAuthentication

@Auditable(parameters={"userName","newPassword"},
           recordable={true,false})
void setAuthentication(java.lang.String userName,
                       char[] newPassword)
                throws org.alfresco.repo.security.authentication.AuthenticationException

Set the login information for a user (typically called by an admin user)

Parameters:

userName - String

newPassword - char[]

Throws:

org.alfresco.repo.security.authentication.AuthenticationException

deleteAuthentication

@Auditable(parameters="userName")
void deleteAuthentication(java.lang.String userName)
                   throws org.alfresco.repo.security.authentication.AuthenticationException

Delete an authentication entry

Parameters:

userName - String

Throws:

org.alfresco.repo.security.authentication.AuthenticationException

setAuthenticationEnabled

@Auditable(parameters={"userName","enabled"})
void setAuthenticationEnabled(java.lang.String userName,
                              boolean enabled)
                       throws org.alfresco.repo.security.authentication.AuthenticationException

Enable or disable an authentication entry

Parameters:

userName - String

enabled - boolean

Throws:

org.alfresco.repo.security.authentication.AuthenticationException