Moving to root below branch label

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2005 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-07-24 17:32:48 +00:00 · 2005-12-08 07:13:07 +00:00
commit e1e6508fec
1095 changed files with 230566 additions and 0 deletions
--- a/source/java/org/alfresco/service/cmr/security/AuthenticationService.java
+++ b/source/java/org/alfresco/service/cmr/security/AuthenticationService.java
@@ -0,0 +1,146 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.service.cmr.security;
+
+import org.alfresco.repo.security.authentication.AuthenticationException;
+
+/**
+ * The authentication service defines the API for managing authentication information 
+ * against a user id. 
+ *  
+ * @author Andy Hind
+ *
+ */
+public interface AuthenticationService
+{
+    /**
+     * Create an authentication for the given user.
+     * 
+     * @param userName
+     * @param password
+     * @throws AuthenticationException
+     */
+    public void createAuthentication(String userName, char[] password) throws AuthenticationException;
+    
+    /**
+     * Update the login information for the user (typically called by the user)
+     * 
+     * @param userName
+     * @param oldPassword
+     * @param newPassword
+     * @throws AuthenticationException
+     */
+    public void updateAuthentication(String userName, char[] oldPassword, char[] newPassword) throws AuthenticationException;
+    
+    /**
+     * Set the login information for a user (typically called by an admin user) 
+     * 
+     * @param userName
+     * @param newPassword
+     * @throws AuthenticationException
+     */
+    public void setAuthentication(String userName, char[] newPassword) throws AuthenticationException;
+    
+
+    /**
+     * Delete an authentication entry
+     * 
+     * @param userName
+     * @throws AuthenticationException
+     */
+    public void deleteAuthentication(String userName) throws AuthenticationException;
+    
+    /**
+     * Enable or disable an authentication entry
+     * 
+     * @param userName
+     * @param enabled
+     */
+    public void setAuthenticationEnabled(String userName, boolean enabled) throws AuthenticationException;
+    
+    /**
+     * Is an authentication enabled or disabled?
+     * 
+     * @param userName
+     * @return
+     */
+    public boolean getAuthenticationEnabled(String userName) 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.
+     * 
+     * @param userName
+     * @param password
+     * @throws AuthenticationException
+     */
+    public void authenticate(String userName, char[] password) throws AuthenticationException;
+    
+    /**
+     * Get the name of the currently authenticated user.
+     * 
+     * @return
+     * @throws AuthenticationException
+     */
+    public String getCurrentUserName() throws AuthenticationException;
+    
+    /**
+     * Invalidate any tickets held by the user.
+     * 
+     * @param userName
+     * @throws AuthenticationException
+     */
+    public void invalidateUserSession(String userName) throws AuthenticationException;
+    
+   /**
+    * Invalidate a single ticket by ID
+    * 
+    * @param ticket
+    * @throws AuthenticationException
+    */
+    public void invalidateTicket(String ticket) throws AuthenticationException;
+    
+   /**
+    * Validate a ticket. Set the current user name accordingly. 
+    * 
+    * @param ticket
+    * @throws AuthenticationException
+    */
+    public void validate(String ticket) throws AuthenticationException;
+    
+    /**
+     * Get the current ticket as a string
+     * @return
+     */
+    public String getCurrentTicket();
+    
+    /**
+     * Remove the current security information
+     *
+     */
+    public void clearCurrentSecurityContext();
+    
+    /**
+     * Is the current user the system user?
+     * 
+     * @return
+     */
+    
+    public boolean isCurrentUserTheSystemUser();
+    
+}
+