X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=security%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fusermgt%2FUserAdministration.java;h=a97199d4f57c7acdebe7631a51573bc485739358;hb=8de36ff0206c996baf3ee4adc3e2293b12ff5f39;hp=1ce6fbfa7a0fdf9ea723e7a382edeaef377fe64f;hpb=532f7219273021ef3652e0abe1326b7aeed1f30a;p=utils diff --git a/security/src/main/java/org/wamblee/usermgt/UserAdministration.java b/security/src/main/java/org/wamblee/usermgt/UserAdministration.java index 1ce6fbfa..a97199d4 100644 --- a/security/src/main/java/org/wamblee/usermgt/UserAdministration.java +++ b/security/src/main/java/org/wamblee/usermgt/UserAdministration.java @@ -1,151 +1,205 @@ /* * Copyright 2005 the original author or authors. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * 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.wamblee.usermgt; import java.util.Set; /** - * Interface for user administration. Manages the users and groups. - * + * Interface for user administration. Manages the users and groups. + * * @author Erik Brakkee */ public interface UserAdministration { - /** - * Creates a new user. - * @param aUser Username. - * @param aPassword Password. - * @param aGroup Group. - * @return User. - * @throws UserMgtException In case there is a conflict with an existing user. - */ - User createUser(String aUser, String aPassword, Group aGroup) throws UserMgtException; - + * Creates a new user. + * + * @param aUser + * Username. + * @param aPassword + * Password. + * @param aGroup + * Group. + * + * @return User. + * + * @throws UserMgtException + * In case there is a conflict with an existing user. + */ + User createUser(String aUser, String aPassword, Group aGroup) + throws UserMgtException; + /** - * Creates a new group. - * @param aName Group name. + * Creates a new group. + * + * @param aName + * Group name. + * * @return Group - * @throws UserMgtException In case there is a conflict with an existing group. + * + * @throws UserMgtException + * In case there is a conflict with an existing group. */ Group createGroup(String aName) throws UserMgtException; - - /** - * @return Number of users. + + /** + * + * @return Number of users. */ - int getUserCount(); - + int getUserCount(); + /** - * @return Number of groups. + * + * @return Number of groups. */ - int getGroupCount(); - + int getGroupCount(); + /** - * Must be called when the user is modified. - * @param aUser User. + * Must be called when the user is modified. + * + * @param aUser + * User. */ void userModified(User aUser); - + /** - * Must be called when the group is modified. - * @param aGroup Group. + * Must be called when the group is modified. + * + * @param aGroup + * Group. */ - void groupModified(Group aGroup); + void groupModified(Group aGroup); /** - * Gets the user for a given name. - * @param aName User name. - * @return User or null if not found. + * Gets the user for a given name. + * + * @param aName + * User name. + * + * @return User or null if not found. */ - User getUser(String aName); - + User getUser(String aName); + /** - * Gets the group for a given group name. - * @param aName Group name. - * @return Group or null if not found. + * Gets the group for a given group name. + * + * @param aName + * Group name. + * + * @return Group or null if not found. */ - Group getGroup(String aName); - + Group getGroup(String aName); + /** - * Get the users. - * @return All known users. + * Get the users. + * + * @return All known users. */ - Set getUsers(); - + Set getUsers(); + /** - * Gets the users for a given group. - * @param aGroup Group. + * Gets the users for a given group. + * + * @param aGroup + * Group. * @return Set of users (always non-null). */ Set getUsers(Group aGroup); - + /** - * Gets all known groups. - * @return Groups. + * Gets all known groups. + * + * @return Groups. */ Set getGroups(); - + /** - * Renames a user. - * @param aUser User object for which user name must be changed. - * @param aUserName New user name. - * @throws UserMgtException In case the user is not known or the new user - * name is already in use by another user. + * Renames a user. + * + * @param aUser + * User object for which user name must be changed. + * @param aUserName + * New user name. + * + * @throws UserMgtException + * In case the user is not known or the new user name is already + * in use by another user. */ void renameUser(User aUser, String aUserName) throws UserMgtException; - + /** - * Renames a group. - * @param aGroup Group to rename. - * @param aGroupName New name for the group. - * @throws UserMgtException In case the new group name is already used by - * another group of if the existing group is unknown. + * Renames a group. + * + * @param aGroup + * Group to rename. + * @param aGroupName + * New name for the group. + * + * @throws UserMgtException + * In case the new group name is already used by another group + * of if the existing group is unknown. */ void renameGroup(Group aGroup, String aGroupName) throws UserMgtException; - + /** - * Removes the user. - * @param aUser User to remove. - * @throws UserMgtException In case the user does not exist. + * Removes the user. + * + * @param aUser + * User to remove. + * + * @throws UserMgtException + * In case the user does not exist. */ void removeUser(User aUser) throws UserMgtException; - + /** - * Removes the group. - * @param aGroup Group to remove. - * @throws UserMgtException In case there are still users that are in the given group. + * Removes the group. + * + * @param aGroup + * Group to remove. + * + * @throws UserMgtException + * In case there are still users that are in the given group. */ void removeGroup(Group aGroup) throws UserMgtException; - + /** - * Adds a user to a group. - * @param aUser User. - * @param aGroup Group. - * @throws UserMgtException In case the user or group or not known or if the user - * is already part of the group. + * Adds a user to a group. + * + * @param aUser + * User. + * @param aGroup + * Group. + * + * @throws UserMgtException + * In case the user or group or not known or if the user is + * already part of the group. */ void addUserToGroup(User aUser, Group aGroup) throws UserMgtException; - + /** - * Removes a user from a group. - * @param aUser User - * @param aGroup Group - * @throws UserMgtException In case the user or group are unknown or if the user - * is not part of the group. - */ - void removeUserFromGroup(User aUser, Group aGroup) throws UserMgtException; + * Removes a user from a group. + * + * @param aUser + * User + * @param aGroup + * Group + * + * @throws UserMgtException + * In case the user or group are unknown or if the user is not + * part of the group. + */ + void removeUserFromGroup(User aUser, Group aGroup) throws UserMgtException; } -