MOB-412: Decouple thread local authentication methods from AuthenticationComponent into new AuthenticationContext super-interface. The AuthenticationContext is a delegate of AbstractAuthenticationComponent and can be accessed directly by low-level classes (e.g. schema bootstrap) before the authentication subsystem is available.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@13721 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-08-07 17:49:17 +00:00 · 2009-03-23 14:01:29 +00:00
parent 61442fd07b
commit facbdaf5b7
43 changed files with 16171 additions and 16073 deletions
--- a/source/java/org/alfresco/repo/security/authentication/AuthenticationContext.java
+++ b/source/java/org/alfresco/repo/security/authentication/AuthenticationContext.java
@@ -0,0 +1,122 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.security.authentication;
+
+import net.sf.acegisecurity.Authentication;
+import net.sf.acegisecurity.UserDetails;
+
+/**
+ * Low-level interface allowing control and retrieval of the authentication information held for the current thread.
+ * 
+ * @author dward
+ */
+public interface AuthenticationContext
+{
+    /**
+     * Remove the current security information
+     */
+    public void clearCurrentSecurityContext();
+
+    /**
+     * Explicitly set the current suthentication. If the authentication is <tt>null</tt> the the current authentication
+     * is {@link #clearCurrentSecurityContext() cleared}.
+     * 
+     * @param authentication
+     *            the current authentication (may be <tt>null</tt>).
+     * @return Returns the modified authentication instance or <tt>null</tt> if it was cleared.
+     */
+    public Authentication setCurrentAuthentication(Authentication authentication);
+
+    /**
+     * Explicitly set the given validated user details to be authenticated.
+     * 
+     * @param ud
+     *            the User Details
+     * @return Authentication
+     */
+    public Authentication setUserDetails(UserDetails ud);
+
+    /**
+     * @throws AuthenticationException
+     */
+    public Authentication getCurrentAuthentication() throws AuthenticationException;
+
+    /**
+     * Set the system user as the current user.
+     */
+    public Authentication setSystemUserAsCurrentUser();
+
+    /**
+     * Set the system user as the current user.
+     */
+    public Authentication setSystemUserAsCurrentUser(String tenantDomain);
+
+    /**
+     * Get the name of the system user. Note: for MT, will get system for default domain only
+     */
+    public String getSystemUserName();
+
+    /**
+     * Get the name of the system user
+     */
+    public String getSystemUserName(String tenantDomain);
+
+    /**
+     * True if this is the System user ?
+     */
+    public boolean isSystemUserName(String userName);
+
+    /**
+     * Get the name of the Guest User. Note: for MT, will get guest for default domain only
+     */
+    public String getGuestUserName();
+
+    /**
+     * Get the name of the guest user
+     */
+    public String getGuestUserName(String tenantDomain);
+
+    /**
+     * True if this is a guest user ?
+     */
+    public boolean isGuestUserName(String userName);
+
+    /**
+     * Get the current user name.
+     * 
+     * @throws AuthenticationException
+     */
+    public String getCurrentUserName() throws AuthenticationException;
+
+    /**
+     * Extracts the tenant domain name from a user name
+     * 
+     * @param userName
+     *            a user name
+     * @return a tenant domain name
+     */
+    public String getUserDomain(String userName);
+
+}