Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.alfresco.service.cmr.security
Interface AuthenticationService
All Known Subinterfaces:
MutableAuthenticationService

@org.alfresco.api.AlfrescoPublicApi
public interface AuthenticationService
The authentication service defines the API for managing authentication information against a user id.
Author:
Andy Hind

Method Summary
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?
getCurrentTicket()
          Get the current ticket as a string
getCurrentUserName()
          Get the name of the currently authenticated user.
getDefaultAdministratorUserNames()
          Gets a set of user names who should be considered 'administrators' by default.
getDefaultGuestUserNames()
          Gets a set of user names who should be considered 'guests' by default.
getDomains()
          Get the domain to which this instance of an authentication service applies.
getDomainsThatAllowUserCreation()
          Does this instance alow user to be created?
getDomainsThatAllowUserDeletion()
          Does this instance allow users to be deleted?
getDomiansThatAllowUserPasswordChanges()
          Does this instance allow users to update their passwords?
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.
Method Detail
getAuthenticationEnabled
@Auditable(parameters="userName")
boolean getAuthenticationEnabled(String userName)
                          throws AuthenticationException
Is an authentication enabled or disabled?
Throws:
AuthenticationException

authenticate
@Auditable(parameters={
  "userName",
  "password"
},
           recordable={
  true,
  false
})
void authenticate(String userName,
                  char[] password)
           throws AuthenticationException
Carry out an authentication attempt. If successful the user is set to the current user. The current user is a part of the thread context.
Parameters:
userName - the username
password - the passowrd
Throws:
AuthenticationException

authenticateAsGuest
@Auditable
void authenticateAsGuest()
                  throws AuthenticationException
Authenticate as the guest user. This may not be allowed and throw an exception.
Throws:
AuthenticationException

guestUserAuthenticationAllowed
@Auditable
boolean guestUserAuthenticationAllowed()
Check if Guest user authentication is allowed.
Returns:
true if Guest user authentication is allowed, false otherwise

authenticationExists
@Auditable(parameters="userName")
boolean authenticationExists(String userName)
Check if the given authentication exists.
Parameters:
userName - the username
Returns:
Returns true if the authentication exists

getCurrentUserName
@Auditable
String getCurrentUserName()
                   throws AuthenticationException
Get the name of the currently authenticated user.
Returns:
String
Throws:
AuthenticationException

invalidateUserSession
@Auditable(parameters="userName")
void invalidateUserSession(String userName)
                    throws AuthenticationException
Invalidate any tickets held by the user.
Throws:
AuthenticationException

invalidateTicket
@Auditable(parameters="ticket",
           recordable=false)
void invalidateTicket(String ticket)
               throws AuthenticationException
Invalidate a single ticket by ID
Parameters:
ticket - String
Throws:
AuthenticationException

validate
@Auditable(parameters="ticket",
           recordable=false)
void validate(String ticket)
       throws AuthenticationException
Validate a ticket. Set the current user name accordingly.
Parameters:
ticket - String
Throws:
AuthenticationException

getCurrentTicket
@Auditable
String getCurrentTicket()
Get the current ticket as a string
Returns:
String

getNewTicket
@Auditable
String getNewTicket()
Get a new ticket as a string
Returns:
String

clearCurrentSecurityContext
@Auditable
void clearCurrentSecurityContext()
Remove the current security information

isCurrentUserTheSystemUser
@Auditable
boolean isCurrentUserTheSystemUser()
Is the current user the system user?

getDomains
@Auditable
Set<StringgetDomains()
Get the domain to which this instance of an authentication service applies.
Returns:
The domain name

getDomainsThatAllowUserCreation
@Auditable
Set<StringgetDomainsThatAllowUserCreation()
Does this instance alow user to be created?

getDomainsThatAllowUserDeletion
@Auditable
Set<StringgetDomainsThatAllowUserDeletion()
Does this instance allow users to be deleted?

getDomiansThatAllowUserPasswordChanges
@Auditable
Set<StringgetDomiansThatAllowUserPasswordChanges()
Does this instance allow users to update their passwords?

getDefaultAdministratorUserNames
@Auditable
Set<StringgetDefaultAdministratorUserNames()
Gets a set of user names who should be considered 'administrators' by default.
Returns:
a set of user names

getDefaultGuestUserNames
@Auditable
Set<StringgetDefaultGuestUserNames()
Gets a set of user names who should be considered 'guests' by default.
Returns:
a set of user names

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2018 Alfresco Software. All rights reserved.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.