@AlfrescoPublicApi
public interface AuthenticationService
Modifier and Type | Method and Description |
---|---|
void |
authenticate(String userName,
char[] password)
Carry out an authentication attempt.
|
void |
authenticateAsGuest()
Authenticate as the guest user.
|
boolean |
authenticationExists(String userName)
Check if the given authentication exists.
|
void |
clearCurrentSecurityContext()
Remove the current security information
|
boolean |
getAuthenticationEnabled(String userName)
Is an authentication enabled or disabled?
|
String |
getCurrentTicket()
Get the current ticket as a string
|
String |
getCurrentUserName()
Get the name of the currently authenticated user.
|
Set<String> |
getDefaultAdministratorUserNames()
Gets a set of user names who should be considered 'administrators' by default.
|
Set<String> |
getDefaultGuestUserNames()
Gets a set of user names who should be considered 'guests' by default.
|
Set<String> |
getDomains()
Get the domain to which this instance of an authentication service applies.
|
Set<String> |
getDomainsThatAllowUserCreation()
Does this instance alow user to be created?
|
Set<String> |
getDomainsThatAllowUserDeletion()
Does this instance allow users to be deleted?
|
Set<String> |
getDomiansThatAllowUserPasswordChanges()
Does this instance allow users to update their passwords?
|
String |
getNewTicket()
Get a new ticket as a string
|
boolean |
guestUserAuthenticationAllowed()
Check if Guest user authentication is allowed.
|
void |
invalidateTicket(String ticket)
Invalidate a single ticket by ID
|
void |
invalidateUserSession(String userName)
Invalidate any tickets held by the user.
|
boolean |
isCurrentUserTheSystemUser()
Is the current user the system user?
|
void |
validate(String ticket)
Validate a ticket.
|
@Auditable(parameters="userName") boolean getAuthenticationEnabled(String userName) throws org.alfresco.repo.security.authentication.AuthenticationException
org.alfresco.repo.security.authentication.AuthenticationException
@Auditable(parameters={"userName","password"}, recordable={true,false}) void authenticate(String userName, char[] password) throws org.alfresco.repo.security.authentication.AuthenticationException
userName
- the usernamepassword
- the passowrdorg.alfresco.repo.security.authentication.AuthenticationException
@Auditable void authenticateAsGuest() throws org.alfresco.repo.security.authentication.AuthenticationException
org.alfresco.repo.security.authentication.AuthenticationException
@Auditable boolean guestUserAuthenticationAllowed()
@Auditable(parameters="userName") boolean authenticationExists(String userName)
userName
- the username@Auditable String getCurrentUserName() throws org.alfresco.repo.security.authentication.AuthenticationException
org.alfresco.repo.security.authentication.AuthenticationException
@Auditable(parameters="userName") void invalidateUserSession(String userName) throws org.alfresco.repo.security.authentication.AuthenticationException
org.alfresco.repo.security.authentication.AuthenticationException
@Auditable(parameters="ticket", recordable=false) void invalidateTicket(String ticket) throws org.alfresco.repo.security.authentication.AuthenticationException
ticket
- Stringorg.alfresco.repo.security.authentication.AuthenticationException
@Auditable(parameters="ticket", recordable=false) void validate(String ticket) throws org.alfresco.repo.security.authentication.AuthenticationException
ticket
- Stringorg.alfresco.repo.security.authentication.AuthenticationException
@Auditable String getCurrentTicket()
@Auditable String getNewTicket()
@Auditable void clearCurrentSecurityContext()
@Auditable boolean isCurrentUserTheSystemUser()
@Auditable Set<String> getDomains()
@Auditable Set<String> getDomainsThatAllowUserCreation()
@Auditable Set<String> getDomainsThatAllowUserDeletion()
@Auditable Set<String> getDomiansThatAllowUserPasswordChanges()
@Auditable Set<String> getDefaultAdministratorUserNames()
Copyright © 2005–2017 Alfresco Software. All rights reserved.