Package org.alfresco.repo.security.authentication

Interface AuthenticationContext

All Known Subinterfaces:
AuthenticationComponent
All Known Implementing Classes:
AbstractAuthenticationComponent, AbstractChainingAuthenticationComponent, AuthenticationComponentImpl, AuthenticationContextImpl, IdentityServiceAuthenticationComponent, JAASAuthenticationComponent, LDAPAuthenticationComponentImpl, SimpleAcceptOrRejectAllAuthenticationComponentImpl, SubsystemChainingAuthenticationComponent
public interface AuthenticationContext
Low-level interface allowing control and retrieval of the authentication information held for the current thread.
Author:
dward

  • Method Details

    • 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.

    • setUserDetails

      net.sf.acegisecurity.Authentication setUserDetails(net.sf.acegisecurity.UserDetails ud)
      Explicitly set the given validated user details to be authenticated.
      Parameters:
      ud - the User Details
      Returns:
      Authentication

    • getCurrentAuthentication

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

    • setSystemUserAsCurrentUser

      net.sf.acegisecurity.Authentication setSystemUserAsCurrentUser()
      Set the system user as the current user.

    • setSystemUserAsCurrentUser

      net.sf.acegisecurity.Authentication setSystemUserAsCurrentUser(String tenantDomain)
      Set the system user as the current user.

    • getSystemUserName

      String getSystemUserName()
      Get the name of the system user. Note: for MT, will get system for default domain only

    • getSystemUserName

      String getSystemUserName(String tenantDomain)
      Get the name of the system user

    • isSystemUserName

      boolean isSystemUserName(String userName)
      True if this is the System user ?

    • isCurrentUserTheSystemUser

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

    • getGuestUserName

      String getGuestUserName()
      Get the name of the Guest User. Note: for MT, will get guest for default domain only

    • getGuestUserName

      String getGuestUserName(String tenantDomain)
      Get the name of the guest user

    • isGuestUserName

      boolean isGuestUserName(String userName)
      True if this is a guest user ?

    • getCurrentUserName

      String getCurrentUserName() throws AuthenticationException
      Get the current user name.
      Throws:
      AuthenticationException

    • getUserDomain

      String getUserDomain(String userName)
      Extracts the tenant domain name from a user name
      Parameters:
      userName - a user name
      Returns:
      a tenant domain name