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

source/java/org/alfresco/repo/security/authentication/MutableAuthenticationDao.java

@@ -0,0 +1,205 @@
+/*
+ * 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.repo.security.authentication;
+
+import java.util.Date;
+
+import net.sf.acegisecurity.providers.dao.AuthenticationDao;
+import net.sf.acegisecurity.providers.dao.SaltSource;
+
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.repository.StoreRef;
+
+/**
+ * A service provider interface to provide both acegi integration via AuthenticationDao and SaltSource
+ * and mutability support for user definitions. 
+ * 
+ * @author Andy Hind
+ */
+public interface MutableAuthenticationDao extends AuthenticationDao, SaltSource
+{
+    /**
+     * Create a user with the given userName and password
+     * 
+     * @param userName
+     * @param rawPassword
+     * @throws AuthenticationException
+     */
+    public void createUser(String userName, char[] rawPassword) throws AuthenticationException;
+    
+    /**
+     * Update a user's password.
+     * 
+     * @param userName
+     * @param rawPassword
+     * @throws AuthenticationException
+     */
+    public void updateUser(String userName, char[] rawPassword) throws AuthenticationException;
+    
+    /**
+     * Delete a user.
+     * 
+     * @param userName
+     * @throws AuthenticationException
+     */
+    public void deleteUser(String userName) throws AuthenticationException;
+    
+    /**
+     * CHeck is a user exists.
+     * 
+     * @param userName
+     * @return
+     */
+    public boolean userExists(String userName);
+    
+    
+    /**
+     * Get the store ref where user objects are persisted.
+     * 
+     * @return
+     */
+    public StoreRef getUserStoreRef();
+    
+    /**
+     * Enable/disable a user.
+     * 
+     * @param userName
+     * @param enabled
+     */
+    public void setEnabled(String userName, boolean enabled);
+    
+    /**
+     * Getter for user enabled
+     * 
+     * @param userName
+     * @return
+     */
+    public boolean getEnabled(String userName);
+    
+    /**
+     * Set if the account should expire
+     * 
+     * @param userName
+     * @param expires
+     */
+    public void setAccountExpires(String userName, boolean expires);
+    
+    /**
+     * Does the account expire?
+     * 
+     * @param userName
+     * @return
+     */
+            
+    public boolean getAccountExpires(String userName);
+    
+    /**
+     * Has the account expired?
+     * 
+     * @param userName
+     * @return
+     */
+    public boolean getAccountHasExpired(String userName);
+  
+    /**
+     * Set if the password expires.
+     * 
+     * @param userName
+     * @param expires
+     */
+    public void setCredentialsExpire(String userName, boolean expires);
+  
+    /**
+     * Do the credentials for the user expire?
+     * 
+     * @param userName
+     * @return
+     */
+    public boolean getCredentialsExpire(String userName);
+    
+    /**
+     * Have the credentials for the user expired?
+     * 
+     * @param userName
+     * @return
+     */
+    public boolean getCredentialsHaveExpired(String userName);
+    
+    /**
+     * Set if the account is locked.
+     * 
+     * @param userName
+     * @param locked
+     */
+    public void setLocked(String userName, boolean locked);
+    
+    /**
+     * Is the account locked?
+     * 
+     * @param userName
+     * @return
+     */
+    public boolean getAccountlocked(String userName);
+    
+    /**
+     * Set the date on which the account expires
+     * 
+     * @param userName
+     * @param exipryDate
+     */
+    public void setAccountExpiryDate(String userName, Date exipryDate);
+    
+    /** 
+     * Get the date when this account expires.
+     * 
+     * @param userName
+     * @return
+     */
+    public Date getAccountExpiryDate(String userName);
+    
+    /**
+     * Set the date when credentials expire.
+     * 
+     * @param userName
+     * @param exipryDate
+     */
+    public void setCredentialsExpiryDate(String userName, Date exipryDate);
+    
+    /**
+     * Get the date when the credentials/password expire.
+     * 
+     * @param userName
+     * @return
+     */
+    public Date getCredentialsExpiryDate(String userName);
+    
+    /**
+     * Get the MD4 password hash
+     * 
+     * @param userName
+     * @return
+     */
+    public String getMD4HashedPassword(String userName);
+    
+    /**
+     * Are user names case sensitive?
+     * 
+     * @return
+     */
+    public boolean getUserNamesAreCaseSensitive();
+    
+}